Office.DecryptedMessageAttachment interface

Пакет:

outlook

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Представляет вложение в расшифрованном сообщении.

Комментарии

[ Набор API: предварительная версия почтового ящика ]

Минимальный уровень разрешений: чтение и запись элемента

Применимый режим Outlook: чтение сообщений

Сведения о разработке надстройки шифрования в Outlook см. в статье Создание надстройки Outlook для шифрования.

Примеры

// 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 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.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" }
        }
    );
}

Свойства

attachmentType	Указывает тип вложения.
content	Указывает содержимое вложения в кодировке Base64.
contentId	Указывает идентификатор содержимого встроенного вложения. Свойство contentId должно быть указано, если isInline задано значение true.
isInline	Если задано значение true, то расшифрованное вложение отображается как изображение в тексте сообщения, а не в списке вложений. isInline Если свойство не указано, его значение равно false.
name	Указывает имя вложения.
path	Указывает путь ссылки НА URL-адрес вложения, если его тип — MailboxEnums.AttachmentType.Cloud. Свойство path должно быть указано для вложений типа MailboxEnums.AttachmentType.Cloud.

Сведения о свойстве

attachmentType

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Указывает тип вложения.

attachmentType: MailboxEnums.AttachmentType;

Значение свойства

Office.MailboxEnums.AttachmentType

Комментарии

[ Набор API: предварительная версия почтового ящика ]

Минимальный уровень разрешений: чтение и запись элемента

Применимый режим Outlook: чтение сообщений

Важно! Вложения типа MailboxEnums.AttachmentType.Item в настоящее время не поддерживаются.

content

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Указывает содержимое вложения в кодировке Base64.

content: string;

Значение свойства

string

Комментарии

[ Набор API: предварительная версия почтового ящика ]

Минимальный уровень разрешений: чтение и запись элемента

Применимый режим Outlook: чтение сообщений

Важно! Свойство content не поддерживается вложениями типа MailboxEnums.AttachmentType.Cloud.

contentId

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Указывает идентификатор содержимого встроенного вложения.

Свойство contentId должно быть указано, если isInline задано значение true.

contentId?: string;

Значение свойства

string

Комментарии

[ Набор API: предварительная версия почтового ящика ]

Минимальный уровень разрешений: чтение и запись элемента

Применимый режим Outlook: чтение сообщений

Важно! При добавлении изображений в сообщение в виде встроенных вложений им автоматически назначается идентификатор содержимого. В тексте сообщения идентификатор содержимого встроенного вложения указывается в src атрибуте <img> элемента (например, <img width=96 height=96 id="Picture_1" src="cid:image001.png@01DC1E6F.FC7C7410">). Чтобы легко идентифицировать и предоставлять эти встроенные вложения во время расшифровки, рекомендуется сохранять идентификаторы содержимого встроенных вложений в заголовке сообщения во время шифрования. Вызовите Office.context.mailbox.item.getAttachmentsAsync , чтобы получить идентификатор содержимого встроенного вложения. Затем вызовите Office.context.mailbox.item.internetHeaders.setAsync , чтобы сохранить идентификатор в заголовке сообщения.

isInline

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Если задано значение true, то расшифрованное вложение отображается как изображение в тексте сообщения, а не в списке вложений. isInline Если свойство не указано, его значение равно false.

isInline?: boolean;

Значение свойства

boolean

Комментарии

[ Набор API: предварительная версия почтового ящика ]

Минимальный уровень разрешений: чтение и запись элемента

Применимый режим Outlook: чтение сообщений

name

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Указывает имя вложения.

name: string;

Значение свойства

string

Комментарии

[ Набор API: предварительная версия почтового ящика ]

Минимальный уровень разрешений: чтение и запись элемента

Применимый режим Outlook: чтение сообщений

path

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Указывает путь ссылки НА URL-адрес вложения, если его тип — MailboxEnums.AttachmentType.Cloud. Свойство path должно быть указано для вложений типа MailboxEnums.AttachmentType.Cloud.

path?: string;

Значение свойства

string

Комментарии

[ Набор API: предварительная версия почтового ящика ]

Минимальный уровень разрешений: чтение и запись элемента

Применимый режим Outlook: чтение сообщений