Partager via


Office.DecryptedMessageAttachment interface

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.

Représente une pièce jointe dans un message déchiffré.

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

Pour savoir comment développer un complément de chiffrement dans Outlook, voir Créer un complément Outlook de chiffrement.

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

attachmentType

Spécifie le type de pièce jointe.

content

Spécifie le contenu encodé en Base64 de la pièce jointe.

contentId

Spécifie l’identificateur de contenu d’une pièce jointe incluse.

La contentId propriété doit être spécifiée si isInline a la valeur true.

isInline

Si la valeur est true, spécifie que la pièce jointe déchiffrée apparaît sous la forme d’une image dans le corps du message plutôt que dans la liste des pièces jointes. Si la isInline propriété n’est pas spécifiée, sa valeur est définie sur false.

name

Spécifie le nom de la pièce jointe.

path

Spécifie le chemin d’accès de référence d’URL de la pièce jointe si son type est MailboxEnums.AttachmentType.Cloud. La path propriété doit être spécifiée pour les pièces jointes de type MailboxEnums.AttachmentType.Cloud.

Détails de la propriété

attachmentType

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 type de pièce jointe.

attachmentType: MailboxEnums.AttachmentType;

Valeur de propriété

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

content

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 contenu encodé en Base64 de la pièce jointe.

content: string;

Valeur de propriété

string

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 : la content propriété n’est pas prise en charge par les pièces jointes de type MailboxEnums.AttachmentType.Cloud.

contentId

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 l’identificateur de contenu d’une pièce jointe incluse.

La contentId propriété doit être spécifiée si isInline a la valeur true.

contentId?: string;

Valeur de propriété

string

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 : Lorsque des images sont ajoutées à un message en tant que pièces jointes inline, un ID de contenu leur est automatiquement attribué. Dans le corps d’un message, l’ID de contenu d’une pièce jointe inline est spécifié dans l’attribut src de l’élément <img> (par exemple, <img width=96 height=96 id="Picture_1" src="cid:image001.png@01DC1E6F.FC7C7410">). Pour identifier et fournir facilement ces pièces jointes inline lors du déchiffrement, nous vous recommandons d’enregistrer les ID de contenu des pièces jointes inline dans l’en-tête du message pendant le chiffrement. Appelez Office.context.mailbox.item.getAttachmentsAsync pour obtenir l’ID de contenu d’une pièce jointe incluse. Ensuite, appelez Office.context.mailbox.item.internetHeaders.setAsync pour enregistrer l’ID dans l’en-tête du message.

isInline

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.

Si la valeur est true, spécifie que la pièce jointe déchiffrée apparaît sous la forme d’une image dans le corps du message plutôt que dans la liste des pièces jointes. Si la isInline propriété n’est pas spécifiée, sa valeur est définie sur false.

isInline?: 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

name

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 nom de la pièce jointe.

name: string;

Valeur de propriété

string

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

path

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 chemin d’accès de référence d’URL de la pièce jointe si son type est MailboxEnums.AttachmentType.Cloud. La path propriété doit être spécifiée pour les pièces jointes de type MailboxEnums.AttachmentType.Cloud.

path?: string;

Valeur de propriété

string

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