Office.MessageDecryptEventCompletedOptions interface

Paket:
outlook

Legt das Verhalten eines Verschlüsselungs-Add-Ins fest, nachdem die Verarbeitung eines OnMessageDecrypt-Ereignisses abgeschlossen ist.

Hinweise

API-Satz: Postfach 1.16

Mindestberechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Nachricht lesen

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

accessControls

Wenn Sie die completed-Methode verwenden, um den Abschluss eines Ereignishandlers zu signalisieren, und seine allowEvent Eigenschaft auf truefestlegen, gibt diese Eigenschaft an, ob entschlüsselte Inhalte einer Nachricht kopiert und eingefügt, gedruckt oder gespeichert werden können.
allowEvent

Wenn Sie die completed-Methode verwenden, um den Abschluss eines Ereignishandlers zu signalisieren, gibt dieser Wert an, ob das OnMessageDecrypt Ereignis weiter 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 den Abschluss eines Ereignishandlers zu signalisieren und seine allowEvent Eigenschaft auf truefestzulegen, legt diese Eigenschaft die entschlüsselten Anhänge der Nachricht fest.
contextData

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

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

Wenn Sie die completed-Methode verwenden, um den Abschluss eines Ereignishandlers zu signalisieren und seine allowEvent Eigenschaft auf falsefestzulegen, legt diese Eigenschaft die Fehlermeldung fest, die dem Benutzer angezeigt wird.

Details zur Eigenschaft

accessControls

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Wenn Sie die completed-Methode verwenden, um den Abschluss eines Ereignishandlers zu signalisieren, und seine allowEvent Eigenschaft auf truefestlegen, gibt diese Eigenschaft an, ob entschlüsselte Inhalte einer Nachricht kopiert und eingefügt, gedruckt oder gespeichert werden können.

accessControls?: AccessControls;

Eigenschaftswert

Office.AccessControls

Hinweise

API-Satz: Postfachvorschau

allowEvent

Wenn Sie die completed-Methode verwenden, um den Abschluss eines Ereignishandlers zu signalisieren, gibt dieser Wert an, ob das OnMessageDecrypt Ereignis weiter 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

Mindestberechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Nachricht lesen

attachments

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

attachments?: DecryptedMessageAttachment[];

Eigenschaftswert

Office.DecryptedMessageAttachment[]

Hinweise

API-Satz: Postfach 1.16

Mindestberechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Nachricht lesen

contextData

Wenn Sie die completed-Methode verwenden, um den Abschluss eines Ereignishandlers zu signalisieren, und seine allowEvent Eigenschaft auf truefestlegen, 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

Mindestberechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Nachricht lesen

Wichtig:

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

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

emailBody

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

emailBody?: DecryptedMessageBody;

Eigenschaftswert

Office.DecryptedMessageBody

Hinweise

API-Satz: Postfach 1.16

Mindestberechtigungsstufe: Element lesen/schreiben

Anwendbarer Outlook-Modus: Nachricht lesen

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

errorMessage

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Wenn Sie die completed-Methode verwenden, um den Abschluss eines Ereignishandlers zu signalisieren und seine allowEvent Eigenschaft auf falsefestzulegen, legt diese Eigenschaft die Fehlermeldung fest, die dem Benutzer angezeigt wird.

errorMessage?: string;

Eigenschaftswert

string

Hinweise

API-Satz: Postfachvorschau

Wichtig:

  • Die errorMessage Eigenschaft wird nur verwendet, wenn die allowEvent Eigenschaft auf falsefestgelegt ist. Wenn Sie die allowEvent Eigenschaft auf truefestlegen, wird die errorMessage Eigenschaft ignoriert.

  • Wenn Sie in der errorMessage Eigenschaft keine Meldung angeben, wird stattdessen die folgende Standardmeldung angezeigt: "Fehler vom <Add-In-Namen>: Fehler beim Entschlüsseln der Nachricht".

  • Wenn Sie Ihrer benutzerdefinierten Fehlermeldung angezeigt werden, wird automatisch "Fehler von <Add-In-Name>: " vorangestellt.