Office.MessageDecryptEventCompletedOptions interface

Пакет:

outlook

Примечание

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

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

Комментарии

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

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

Применимый режим 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" }
        }
    );
}

Свойства

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

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

allowEvent

Примечание

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

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

allowEvent: boolean;

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

boolean

Комментарии

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

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

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

attachments

Примечание

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

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

attachments?: DecryptedMessageAttachment[];

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

Office.DecryptedMessageAttachment[]

Комментарии

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

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

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

contextData

Примечание

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

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

contextData?: any;

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

any

Комментарии

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

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

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

Важно!

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

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

emailBody

Примечание

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

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

emailBody?: DecryptedMessageBody;

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

Office.DecryptedMessageBody

Комментарии

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

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

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

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