Office.MessageDecryptEventCompletedOptions interface

Paket:
outlook

Gibt das Verhalten eines Verschlüsselungs-Add-Ins an, nachdem es die Verarbeitung eines OnMessageDecrypt-Ereignisses abgeschlossen hat.

Hinweise

API-Satz: Postfach 1.16

Minimale Berechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Lesen von Nachrichten

Verwendet von

Beispiele

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

Eigenschaften

allowEvent

Wenn Sie die completed-Methode verwenden, um den Abschluss eines Ereignishandlers zu signalisieren, gibt dieser Wert an, ob das OnMessageDecrypt Ereignis weiterhin ausgeführt oder abgebrochen werden soll. Wenn die allowEvent -Eigenschaft auf truefestgelegt ist, wird der entschlüsselte Inhalt der Nachricht angezeigt.
attachments

Wenn Sie die completed-Methode verwenden, um die Vervollständigung eines Ereignishandlers zu signalisieren und seine allowEvent -Eigenschaft auf truefestzulegen, legt diese Eigenschaft die entschlüsselten Anlagen der Nachricht fest.
contextData

Wenn Sie die completed-Methode verwenden, um die Vervollständigung eines Ereignishandlers zu signalisieren und seine allowEvent -Eigenschaft auf truefestzulegen, gibt diese Eigenschaft alle JSON-Daten an, die zur Verarbeitung an das Add-In übergeben werden.
emailBody

Wenn Sie die completed-Methode verwenden, um die Vervollständigung eines Ereignishandlers zu signalisieren und seine allowEvent -Eigenschaft auf truefestzulegen, legt diese Eigenschaft den entschlüsselten Inhalt des Nachrichtentexts fest.

Details zur Eigenschaft

allowEvent

Wenn Sie die completed-Methode verwenden, um den Abschluss eines Ereignishandlers zu signalisieren, gibt dieser Wert an, ob das OnMessageDecrypt Ereignis weiterhin ausgeführt oder abgebrochen werden soll. Wenn die allowEvent -Eigenschaft auf truefestgelegt ist, wird der entschlüsselte Inhalt der Nachricht angezeigt.

allowEvent: boolean;

Eigenschaftswert

boolean

Hinweise

API-Satz: Postfach 1.16

Minimale Berechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Lesen von Nachrichten

attachments

Wenn Sie die completed-Methode verwenden, um die Vervollständigung eines Ereignishandlers zu signalisieren und seine allowEvent -Eigenschaft auf truefestzulegen, legt diese Eigenschaft die entschlüsselten Anlagen der Nachricht fest.

attachments?: DecryptedMessageAttachment[];

Eigenschaftswert

Office.DecryptedMessageAttachment[]

Hinweise

API-Satz: Postfach 1.16

Minimale Berechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Lesen von Nachrichten

contextData

Wenn Sie die completed-Methode verwenden, um die Vervollständigung eines Ereignishandlers zu signalisieren und seine allowEvent -Eigenschaft auf truefestzulegen, gibt diese Eigenschaft alle JSON-Daten an, die zur Verarbeitung an das Add-In übergeben werden.

contextData?: any;

Eigenschaftswert

any

Hinweise

API-Satz: Postfach 1.16

Minimale Berechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Lesen von Nachrichten

Wichtig:

  • Um den Wert der contextData -Eigenschaft abzurufen, müssen Sie aufrufen Office.context.mailbox.item.getInitializationContextAsync. Wenn Sie eine JSON-Zeichenfolge mit JSON.stringify() erstellen und der contextData -Eigenschaft zuweisen, müssen Sie die Zeichenfolge mit JSON.parse() analysieren, sobald Sie sie abgerufen haben.

  • Sie können die contextData -Eigenschaft verwenden, um benutzerdefinierte Internetheader zum Entschlüsseln von Nachrichten in Antwort- und Weiterleitungsszenarien zu speichern.

emailBody

Wenn Sie die completed-Methode verwenden, um die Vervollständigung eines Ereignishandlers zu signalisieren und seine allowEvent -Eigenschaft auf truefestzulegen, legt diese Eigenschaft den entschlüsselten Inhalt des Nachrichtentexts fest.

emailBody?: DecryptedMessageBody;

Eigenschaftswert

Office.DecryptedMessageBody

Hinweise

API-Satz: Postfach 1.16

Minimale Berechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Lesen von Nachrichten

Wichtig: Wenn die emailBody Eigenschaft nicht angegeben ist, wird ein leerer Text zurückgegeben.