Office.MessageDecryptEventCompletedOptions interface

Пакет:

outlook

Определяет поведение надстройки шифрования после завершения обработки события OnMessageDecrypt .

Комментарии

Набор API: почтовый ящик 1.16

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

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

Используется

• Office.MailboxEvent: выполнено

Примеры

// This sample handles the OnMessageDecrypt event to decrypt the body and attachments of a message.
function onMessageDecryptHandler(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" }
        }
    );
}

Свойства

accessControls	Если использовать метод completed для сигнализации о завершении обработки событий и задать для его allowEvent свойства значение true, это свойство определяет, можно ли скопировать и вставить, распечатать или сохранить расшифрованное содержимое сообщения.
allowEvent	Когда вы используете метод completed , чтобы сообщить о завершении работы обработчика событий, это значение указывает OnMessageDecrypt , следует ли продолжить выполнение события или оно должно быть отменено. Если свойство allowEvent имеет значение true, выводится расшифрованное содержимое сообщения.
attachments	Когда вы используете метод completed , чтобы сообщить о завершении обработки события, и задаете его allowEvent свойству значение true, это свойство устанавливает расшифрованные вложения сообщения.
contextData	Когда вы используете метод completed , чтобы сообщить о завершении обработки события, и задаете его allowEvent свойству значение true, это свойство указывает любые данные JSON, передаваемые в надстройку для обработки.
emailBody	Когда вы используете метод completed , чтобы сообщить о завершении обработки события, и задаете его allowEvent свойству значение true, это свойство задает расшифрованное содержимое текста сообщения.
errorMessage	Когда вы используете метод completed , чтобы сообщить о завершении обработки события, и задаете его allowEvent свойству значение false, это свойство устанавливает сообщение об ошибке, отображаемое для пользователя.

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

accessControls

Примечание

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

Если использовать метод completed для сигнализации о завершении обработки событий и задать для его allowEvent свойства значение true, это свойство определяет, можно ли скопировать и вставить, распечатать или сохранить расшифрованное содержимое сообщения.

accessControls?: AccessControls;

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

Office.AccessControls

Комментарии

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

allowEvent

Когда вы используете метод completed , чтобы сообщить о завершении работы обработчика событий, это значение указывает OnMessageDecrypt , следует ли продолжить выполнение события или оно должно быть отменено. Если свойство allowEvent имеет значение true, выводится расшифрованное содержимое сообщения.

allowEvent: boolean;

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

boolean

Комментарии

Набор API: почтовый ящик 1.16

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

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

attachments

Когда вы используете метод completed , чтобы сообщить о завершении обработки события, и задаете его allowEvent свойству значение true, это свойство устанавливает расшифрованные вложения сообщения.

attachments?: DecryptedMessageAttachment[];

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

Office.DecryptedMessageAttachment[]

Комментарии

Набор API: почтовый ящик 1.16

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

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

contextData

Когда вы используете метод completed , чтобы сообщить о завершении обработки события, и задаете его allowEvent свойству значение true, это свойство указывает любые данные JSON, передаваемые в надстройку для обработки.

contextData?: any;

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

any

Комментарии

Набор API: почтовый ящик 1.16

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

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

Важно!

• Чтобы получить значение contextData свойства, необходимо вызвать Office.context.mailbox.item.getInitializationContextAsync. Если вы создаете строку JSON с помощью JSON.stringify() свойства и назначаете ее contextData свойству, необходимо проанализировать строку с помощью одного JSON.parse() извлечения.

• Это свойство можно использовать для хранения настраиваемых contextData интернет-заголовков для расшифровки сообщений в сценариях ответа и пересылки.

emailBody

Когда вы используете метод completed , чтобы сообщить о завершении обработки события, и задаете его allowEvent свойству значение true, это свойство задает расшифрованное содержимое текста сообщения.

emailBody?: DecryptedMessageBody;

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

Office.DecryptedMessageBody

Комментарии

Набор API: почтовый ящик 1.16

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

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

Важно. Если свойство emailBody не указано, возвращается пустое тело.

errorMessage

Примечание

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

Когда вы используете метод completed , чтобы сообщить о завершении обработки события, и задаете его allowEvent свойству значение false, это свойство устанавливает сообщение об ошибке, отображаемое для пользователя.

errorMessage?: string;

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

string

Комментарии

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

Важно!

• Свойство errorMessage используется, только если свойство allowEvent имеет значение false. Если для свойства allowEvent задано значение true, оно errorMessage игнорируется.

• Если не указать сообщение в свойстве errorMessage , вместо него отображается следующее сообщение по умолчанию: "Ошибка от <имени> надстройки: не удалось расшифровать сообщение".

• К настраиваемому сообщению об ошибке автоматически добавляется сообщение "Ошибка от <имени> надстройки: ", если оно отображается пользователю.