Compartilhar via


Office.MessageDecryptEventCompletedOptions interface

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Especifica o comportamento de um suplemento de encriptação depois de concluir o processamento de um evento OnMessageRead .

Comentários

[ Conjunto de API: Pré-visualização da caixa de correio ]

Nível mínimo de permissão: item de leitura/escrita

Modo Outlook aplicável: Leitura da Mensagem

Exemplos

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

Propriedades

allowEvent

Quando utiliza o método concluído para sinalizar a conclusão de um processador de eventos, este valor indica se o OnMessageRead evento deve continuar a ser executado ou cancelado. Se a allowEvent propriedade estiver definida como true, será apresentado o conteúdo desencriptado da mensagem.

attachments

Quando utiliza o método concluído para sinalizar a conclusão de um processador de eventos e definir a respetiva allowEvent propriedade como true, esta propriedade define os anexos desencriptados da mensagem.

contextData

Quando utiliza o método concluído para sinalizar a conclusão de um processador de eventos e definir a respetiva allowEvent propriedade como true, esta propriedade especifica quaisquer dados JSON transmitidos ao suplemento para processamento.

emailBody

Quando utiliza o método concluído para sinalizar a conclusão de um processador de eventos e definir a respetiva allowEvent propriedade como true, esta propriedade define o conteúdo desencriptado do corpo da mensagem.

Detalhes da propriedade

allowEvent

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Quando utiliza o método concluído para sinalizar a conclusão de um processador de eventos, este valor indica se o OnMessageRead evento deve continuar a ser executado ou cancelado. Se a allowEvent propriedade estiver definida como true, será apresentado o conteúdo desencriptado da mensagem.

allowEvent: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: Pré-visualização da caixa de correio ]

Nível mínimo de permissão: item de leitura/escrita

Modo Outlook aplicável: Leitura da Mensagem

attachments

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Quando utiliza o método concluído para sinalizar a conclusão de um processador de eventos e definir a respetiva allowEvent propriedade como true, esta propriedade define os anexos desencriptados da mensagem.

attachments?: DecryptedMessageAttachment[];

Valor da propriedade

Comentários

[ Conjunto de API: Pré-visualização da caixa de correio ]

Nível mínimo de permissão: item de leitura/escrita

Modo Outlook aplicável: Leitura da Mensagem

contextData

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Quando utiliza o método concluído para sinalizar a conclusão de um processador de eventos e definir a respetiva allowEvent propriedade como true, esta propriedade especifica quaisquer dados JSON transmitidos ao suplemento para processamento.

contextData?: any;

Valor da propriedade

any

Comentários

[ Conjunto de API: Pré-visualização da caixa de correio ]

Nível mínimo de permissão: item de leitura/escrita

Modo Outlook aplicável: Leitura da Mensagem

Importante:

  • Para obter o valor da contextData propriedade, tem de chamar Office.context.mailbox.item.getInitializationContextAsync. Se criar uma cadeia JSON com JSON.stringify() e atribuí-la à contextData propriedade, tem de analisar a cadeia com JSON.parse() uma vez obtê-la.

  • Pode utilizar a contextData propriedade para armazenar cabeçalhos de Internet personalizados para desencriptar mensagens em cenários de resposta e reencaminhamento.

emailBody

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Quando utiliza o método concluído para sinalizar a conclusão de um processador de eventos e definir a respetiva allowEvent propriedade como true, esta propriedade define o conteúdo desencriptado do corpo da mensagem.

emailBody?: DecryptedMessageBody;

Valor da propriedade

Comentários

[ Conjunto de API: Pré-visualização da caixa de correio ]

Nível mínimo de permissão: item de leitura/escrita

Modo Outlook aplicável: Leitura da Mensagem

Importante: se a emailBody propriedade não for especificada, é devolvido um corpo vazio.