Partager via

Office.MessageDecryptEventCompletedOptions interface

Paquet:
outlook

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Spécifie le comportement d’un complément de chiffrement une fois qu’il a terminé le traitement d’un événement OnMessageRead .

Remarques

[ Ensemble d’API : préversion de boîte aux lettres ]

Niveau d’autorisation minimal : élément en lecture/écriture

Mode Outlook applicable : Lecture du message

Exemples

// This sample handles the OnMessageRead event to decrypt the body and attachments of a message.
function onMessageReadHandler(event) {
    // Your code to decrypt the contents of a message would appear here.
    ...

    // Use the results from your decryption process to display the decrypted contents of the message body and attachments.
    const decryptedBodyContent = "<p>Please find attached the recent report and its supporting documentation.</p>";
    const decryptedBody = {
        coercionType: Office.CoercionType.Html,
        content: decryptedBodyContent
    };

    // Decrypted content and properties of a file attachment.
    const decryptedPdfFile = "JVBERi0xLjQKJeLjz9MKNCAwIG9i...";
    const pdfFileName = "Fabrikam_Report_202509";

    // Decrypted content and properties of a mail item.
    const decryptedEmailFile = "VGhpcyBpcyBhIHRleHQgZmlsZS4=...";
    const emailFileName = "Fabrikam_Report_202508.eml";

    // Decrypted properties of a cloud attachment.
    const cloudFilePath = "https://contosostorage.com/reports/weekly_forecast.xlsx";
    const cloudFileName = "weekly_forecast.xlsx";

    // Decrypted content and properties of an inline image.
    const decryptedImageFile = "iVBORw0KGgoAAAANSUhEUgAA...";
    const imageFileName = "banner.png";
    const imageContentId = "image001.png@01DC1DD9.1A4AA300";

    const decryptedAttachments = [
        {
            attachmentType: Office.MailboxEnums.AttachmentType.File,
            content: decryptedPdfFile,
            isInline: false,
            name: pdfFileName
        },
        {
            attachmentType: Office.MailboxEnums.AttachmentType.Item,
            content: decryptedEmailFile,
            isInline: false,
            name: emailFileName
        },
        {
            attachmentType: Office.MailboxEnums.AttachmentType.Cloud,
            isInline: false,
            name: cloudFileName,
            path: cloudFilePath
        },
        {
            attachmentType: Office.MailboxEnums.AttachmentType.File,
            content: decryptedImageFile,
            contentId: imageContentId,
            isInline: true,
            name: imageFileName
        }
    ];

    event.completed(
        {
            allowEvent: true,
            emailBody: decryptedBody,
            attachments: decryptedAttachments,
            contextData: { messageType: "ReplyFromDecryptedMessage" }
        }
    );
}

Propriétés

allowEvent

Lorsque vous utilisez la méthode completed pour signaler l’achèvement d’un gestionnaire d’événements, cette valeur indique si l’événement OnMessageRead doit continuer à s’exécuter ou être annulé. Si la propriété a la allowEvent valeur true, le contenu déchiffré du message s’affiche.
attachments

Lorsque vous utilisez la méthode completed pour signaler l’achèvement d’un gestionnaire d’événements et que vous définissez sa allowEvent propriété sur true, cette propriété définit les pièces jointes déchiffrées du message.
contextData

Lorsque vous utilisez la méthode completed pour signaler l’achèvement d’un gestionnaire d’événements et que vous définissez sa allowEvent propriété sur true, cette propriété spécifie toutes les données JSON transmises au complément pour traitement.
emailBody

Lorsque vous utilisez la méthode completed pour signaler l’achèvement d’un gestionnaire d’événements et que vous définissez sa allowEvent propriété sur true, cette propriété définit le contenu déchiffré du corps du message.

Détails de la propriété

allowEvent

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Lorsque vous utilisez la méthode completed pour signaler l’achèvement d’un gestionnaire d’événements, cette valeur indique si l’événement OnMessageRead doit continuer à s’exécuter ou être annulé. Si la propriété a la allowEvent valeur true, le contenu déchiffré du message s’affiche.

allowEvent: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : préversion de boîte aux lettres ]

Niveau d’autorisation minimal : élément en lecture/écriture

Mode Outlook applicable : Lecture du message

attachments

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Lorsque vous utilisez la méthode completed pour signaler l’achèvement d’un gestionnaire d’événements et que vous définissez sa allowEvent propriété sur true, cette propriété définit les pièces jointes déchiffrées du message.

attachments?: DecryptedMessageAttachment[];

Valeur de propriété

Office.DecryptedMessageAttachment[]

Remarques

[ Ensemble d’API : préversion de boîte aux lettres ]

Niveau d’autorisation minimal : élément en lecture/écriture

Mode Outlook applicable : Lecture du message

contextData

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Lorsque vous utilisez la méthode completed pour signaler l’achèvement d’un gestionnaire d’événements et que vous définissez sa allowEvent propriété sur true, cette propriété spécifie toutes les données JSON transmises au complément pour traitement.

contextData?: any;

Valeur de propriété

any

Remarques

[ Ensemble d’API : préversion de boîte aux lettres ]

Niveau d’autorisation minimal : élément en lecture/écriture

Mode Outlook applicable : Lecture du message

Important:

  • Pour récupérer la valeur de la contextData propriété, vous devez appeler Office.context.mailbox.item.getInitializationContextAsync. Si vous créez une chaîne JSON à l’aide JSON.stringify() de et que vous l’attribuez à la contextData propriété , vous devez analyser la chaîne à l’aide JSON.parse() de une fois que vous l’avez récupérée.

  • Vous pouvez utiliser la contextData propriété pour stocker des en-têtes Internet personnalisés afin de déchiffrer les messages dans les scénarios de réponse et de transfert.

emailBody

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Lorsque vous utilisez la méthode completed pour signaler l’achèvement d’un gestionnaire d’événements et que vous définissez sa allowEvent propriété sur true, cette propriété définit le contenu déchiffré du corps du message.

emailBody?: DecryptedMessageBody;

Valeur de propriété

Office.DecryptedMessageBody

Remarques

[ Ensemble d’API : préversion de boîte aux lettres ]

Niveau d’autorisation minimal : élément en lecture/écriture

Mode Outlook applicable : Lecture du message

Important : si la emailBody propriété n’est pas spécifiée, un corps vide est retourné.