Freigeben über

Office.SpamReportingEventCompletedOptions interface

  • Referenz
Paket:
outlook

Gibt das Verhalten eines integrierten Spamberichts-Add-Ins an, nachdem es die Verarbeitung eines SpamReporting-Ereignisses abgeschlossen hat.

Hinweise

[ API-Satz: Postfach 1.14 ]

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Lesen von Nachrichten

Beispiele

// The following example handles a SpamReporting event to process a reported spam or phishing message.
function onSpamReport(event) {
    // Gets the Base64-encoded EML format of a reported message.
    Office.context.mailbox.item.getAsFileAsync({ asyncContext: event }, (asyncResult) => {
        if (asyncResult.status === Office.AsyncResultStatus.Failed) {
            console.log(`Error encountered during message processing: ${asyncResult.error.message}`);
            return;
        }

        // Run additional processing operations here.

        /**
         * Signals that the spam-reporting event has completed processing.
         * It then moves the reported message to a custom mailbox folder named "Reported Messages"
         * and shows a post-processing dialog to the user.
         * If an error occurs while the message is being processed, the `onErrorDeleteItem`
         * property determines whether the message will be deleted.
         */
        const event = asyncResult.asyncContext;
        event.completed({
            moveItemTo: Office.MailboxEnums.MoveSpamItemTo.CustomFolder,
            folderName: "Reported Messages",
            onErrorDeleteItem: true,
            showPostProcessingDialog: {
                title: "Contoso Spam Reporting",
                description: "Thank you for reporting this message.",
            },
        });
    });
}

Eigenschaften

commandId

Wenn Sie die completed-Methode verwenden, um zu signalisieren, dass die Verarbeitung einer gemeldeten Nachricht abgeschlossen wurde, gibt diese Eigenschaft die ID des Aufgabenbereichs an, der nach der Verarbeitung der Nachricht geöffnet wird.
contextData

Wenn Sie die completed-Methode verwenden, um zu signalisieren, dass die Verarbeitung einer gemeldeten Nachricht abgeschlossen wurde, gibt diese Eigenschaft alle JSON-Daten an, die nach der Verarbeitung der Nachricht an den Aufgabenbereich des Add-Ins übergeben werden.
folderName

Wenn Sie die completed-Methode verwenden, um zu signalisieren, dass die Verarbeitung einer gemeldeten Nachricht abgeschlossen wurde, gibt diese Eigenschaft den Outlook-Postfachordner an, in den die Nachricht verschoben wird.
moveItemTo

Wenn Sie die completed-Methode verwenden, um zu signalisieren, dass die Verarbeitung einer gemeldeten Nachricht abgeschlossen wurde, gibt diese Eigenschaft an, ob die Nachricht in einen anderen Ordner im Postfach verschoben wird.
onErrorDeleteItem

Bei Festlegung auf truelöscht eine gemeldete Nachricht, wenn während der Verarbeitung der Nachricht ein Fehler auftritt. Wenn diese Eigenschaft auf false festgelegt ist oder in der completed-Methode nicht angegeben ist, verbleibt die gemeldete Nachricht im aktuellen Postfachordner.
postProcessingAction

Wenn Sie die completed-Methode verwenden, um zu signalisieren, dass die Verarbeitung einer gemeldeten Nachricht abgeschlossen wurde, gibt diese Eigenschaft an, ob die Nachricht in einen anderen Ordner im Postfach verschoben wird. Die folgenden Nachbearbeitungsaktionen sind verfügbar.

  • delete – Verschiebt die gemeldete Nachricht in den Ordner Gelöschte Elemente des Postfachs.

  • moveToCustomFolder – Verschiebt die gemeldete Nachricht in einen angegebenen Ordner. Sie müssen den Namen des Ordners in der folderName -Eigenschaft angeben.

  • moveToSpamFolder– Verschiebt die gemeldete Nachricht in den Junk-Email Ordner des Postfachs.

  • noMove – Belässt die gemeldete Nachricht im aktuellen Ordner.
showPostProcessingDialog

Wenn Sie die completed-Methode verwenden, um zu signalisieren, dass die Verarbeitung einer gemeldeten Nachricht abgeschlossen wurde, gibt diese Eigenschaft an, ob dem Benutzer ein Nachbearbeitungsdialogfeld angezeigt wird. Das dieser Eigenschaft zugewiesene JSON-Objekt muss einen Titel und eine Beschreibung enthalten. Wenn diese Eigenschaft nicht angegeben ist, wird dem Benutzer nach der Verarbeitung der gemeldeten Nachricht kein Dialogfeld angezeigt.

Details zur Eigenschaft

commandId

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 zu signalisieren, dass die Verarbeitung einer gemeldeten Nachricht abgeschlossen wurde, gibt diese Eigenschaft die ID des Aufgabenbereichs an, der nach der Verarbeitung der Nachricht geöffnet wird.

commandId?: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: Postfachvorschau ]

Mindestberechtigungsstufe (Outlook):Element lesen

Anwendbarer Outlook-Modus: Lesen von Nachrichten

Wichtig:

  • Die commandId Option befindet sich derzeit in Outlook im Web und unter Windows (neu und klassisch) in der Vorschauphase. Um eine Vorschau dieses Features im klassischen Outlook unter Windows anzuzeigen, installieren Sie Version 2411 (Build 18227.20034) oder höher. Nehmen Sie dann am Microsoft 365 Insider-Programm teil, und wählen Sie die Option Betakanal aus. Informationen dazu, wie Sie dies in Ihrem Add-In für die Spamberichterstattung implementieren, finden Sie unter Öffnen eines Aufgabenbereichs nach dem Melden einer Nachricht (Vorschau).

  • Der commandId Wert muss mit der Aufgabenbereichs-ID übereinstimmen, die im Manifest Ihres Add-Ins angegeben ist. In einem reinen Add-In-Manifest wird die ID im id Attribut des Control-Elements angegeben, das den Aufgabenbereich darstellt. Die commandId -Eigenschaft wird derzeit nicht in einem Add-In zur Spamberichterstattung unterstützt, das ein einheitliches Manifest für Microsoft 365 verwendet.

  • Wenn Sie die commandId Option im event.completed Anruf konfigurieren, wird dem Benutzer kein Nachbearbeitungsdialogfeld angezeigt, auch wenn die showPostProcessingDialog Option im Anruf angegeben ist.

  • Wenn Sie einen Aufgabenbereich implementieren, der geöffnet wird, nachdem eine gemeldete Nachricht verarbeitet wurde, wird beim Auftreten des event.completed Aufrufs jeder geöffnete oder angeheftete Aufgabenbereich geschlossen.

Beispiele

function onSpamReport(event) {
    // Run operations to process the reported message.

    /**
     * Signals that the spam-reporting event has completed processing.
     * A task pane is opened instead of showing a post-processing dialog.
     * Context data is then passed to the task pane for processing.
     * To ensure that the task pane opens and receives the context data,
     * the reported message mustn't be moved from the folder in which it resides.
     */
    event.completed({
        commandId: "msgReadOpenPaneButton",
        contextData: JSON.stringify({ a: "aValue", b: "bValue" }),
        moveItemTo: Office.MailboxEnums.MoveSpamItemTo.NoMove
    });
}

contextData

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 zu signalisieren, dass die Verarbeitung einer gemeldeten Nachricht abgeschlossen wurde, gibt diese Eigenschaft alle JSON-Daten an, die nach der Verarbeitung der Nachricht an den Aufgabenbereich des Add-Ins übergeben werden.

contextData?: any;

Eigenschaftswert

any

Hinweise

[ API-Satz: Postfachvorschau ]

Mindestberechtigungsstufe (Outlook):Element lesen

Anwendbarer Outlook-Modus: Lesen von Nachrichten

Wichtig:

  • Die contextData Option befindet sich derzeit in Outlook im Web und unter Windows (neu und klassisch) in der Vorschauphase. Um eine Vorschau dieses Features im klassischen Outlook unter Windows anzuzeigen, installieren Sie Version 2411 (Build 18227.20034) oder höher. Nehmen Sie dann am Microsoft 365 Insider-Programm teil, und wählen Sie die Option Betakanal aus. Informationen dazu, wie Sie dies in Ihrem Add-In für die Spamberichterstattung implementieren, finden Sie unter Öffnen eines Aufgabenbereichs nach dem Melden einer Nachricht (Vorschau).

  • Wenn Sie die contextData Option in Ihrem event.completed Aufruf angeben, müssen Sie der commandId Option auch eine Aufgabenbereich-ID zuweisen. Andernfalls werden die JSON-Daten ignoriert, die zugewiesen contextData sind.

  • Wenn Sie die commandId Optionen und contextData im event.completed Anruf konfigurieren, wird dem Benutzer kein Nachbearbeitungsdialogfeld angezeigt, auch wenn die showPostProcessingDialog Option im Anruf angegeben ist.

  • Wenn Sie einen Aufgabenbereich implementieren, der geöffnet wird, nachdem eine gemeldete Nachricht verarbeitet wurde, wird beim Auftreten des event.completed Aufrufs jeder geöffnete oder angeheftete Aufgabenbereich geschlossen.

  • Um den Wert der contextData -Eigenschaft abzurufen, müssen Sie in der JavaScript-Implementierung Ihres Aufgabenbereichs 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.

Beispiele

function onSpamReport(event) {
    // Run operations to process the reported message.

    /**
     * Signals that the spam-reporting event has completed processing.
     * A task pane is opened instead of showing a post-processing dialog.
     * Context data is then passed to the task pane for processing.
     * To ensure that the task pane opens and receives the context data,
     * the reported message mustn't be moved from the folder in which it resides.
     */
    event.completed({
        commandId: "msgReadOpenPaneButton",
        contextData: JSON.stringify({ a: "aValue", b: "bValue" }),
        moveItemTo: Office.MailboxEnums.MoveSpamItemTo.NoMove
    });
}

folderName

Wenn Sie die completed-Methode verwenden, um zu signalisieren, dass die Verarbeitung einer gemeldeten Nachricht abgeschlossen wurde, gibt diese Eigenschaft den Outlook-Postfachordner an, in den die Nachricht verschoben wird.

folderName?: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: Postfach 1.14 ]

Mindestberechtigungsstufe (Outlook):Element lesen

Anwendbarer Outlook-Modus: Lesen von Nachrichten

Wichtig:

  • Wenn der angegebene Ordner noch nicht vorhanden ist, wird er erstellt, bevor die Nachricht verschoben wird.

  • Wenn die postProcessingAction -Eigenschaft auf moveToCustomFolderfestgelegt ist, muss die folderName -Eigenschaft angegeben werden. Andernfalls wird die gemeldete Nachricht in den Junk-Email Ordner des Postfachs verschoben. Wenn postProcessingAction auf eine andere Aktion als moveToCustomFolderfestgelegt ist, wird die folderName -Eigenschaft ignoriert.

moveItemTo

Wenn Sie die completed-Methode verwenden, um zu signalisieren, dass die Verarbeitung einer gemeldeten Nachricht abgeschlossen wurde, gibt diese Eigenschaft an, ob die Nachricht in einen anderen Ordner im Postfach verschoben wird.

moveItemTo?: MailboxEnums.MoveSpamItemTo;

Eigenschaftswert

Office.MailboxEnums.MoveSpamItemTo

Hinweise

[ API-Satz: Postfach 1.14 ]

Mindestberechtigungsstufe (Outlook):Element lesen

Anwendbarer Outlook-Modus: Lesen von Nachrichten

Wichtig:

  • Sie können diese Eigenschaft nur in einem Add-In für die Spamberichterstattung in Outlook im Web, unter Windows (neu und klassisch (ab Version 2308, Build 16724.10000)) und unter Mac verwenden. Wenn Sie einen früheren Build des klassischen Outlook unter Windows verwenden, der die integrierte Spamberichterstattungsfunktion unterstützt, verwenden Sie stattdessen die postProcessingAction -Eigenschaft.

  • Wenn die -Eigenschaft auf Office.MailboxEnums.MoveSpamItemTo.CustomFolderfestgelegt ist, müssen Sie in der -Eigenschaft des Aufrufs den Namen des Ordners event.completed angeben, in den die folderName Nachricht verschoben wird. Andernfalls wird die moveItemTo -Eigenschaft standardmäßig auf Office.MailboxEnums.MoveSpamItemTo.JunkFolder festgelegt und die gemeldete Nachricht in den Junk-Email Ordner verschoben.

  • Wenn Sie die commandId Optionen und contextData im event.completed Aufruf so konfigurieren, dass ein Aufgabenbereich geöffnet wird, nachdem ein Benutzer die Option Bericht im Vorverarbeitungsdialogfeld ausgewählt hat, müssen Sie die moveItemTo Option auf Office.MailboxEnums.MoveSpamItemTo.NoMovefestlegen. Andernfalls wird der Aufgabenbereich nicht geöffnet.

onErrorDeleteItem

Bei Festlegung auf truelöscht eine gemeldete Nachricht, wenn während der Verarbeitung der Nachricht ein Fehler auftritt. Wenn diese Eigenschaft auf false festgelegt ist oder in der completed-Methode nicht angegeben ist, verbleibt die gemeldete Nachricht im aktuellen Postfachordner.

onErrorDeleteItem?: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: Postfach 1.14 ]

Mindestberechtigungsstufe (Outlook):Element lesen

Anwendbarer Outlook-Modus: Lesen von Nachrichten

postProcessingAction

Wenn Sie die completed-Methode verwenden, um zu signalisieren, dass die Verarbeitung einer gemeldeten Nachricht abgeschlossen wurde, gibt diese Eigenschaft an, ob die Nachricht in einen anderen Ordner im Postfach verschoben wird. Die folgenden Nachbearbeitungsaktionen sind verfügbar.

  • delete – Verschiebt die gemeldete Nachricht in den Ordner Gelöschte Elemente des Postfachs.

  • moveToCustomFolder – Verschiebt die gemeldete Nachricht in einen angegebenen Ordner. Sie müssen den Namen des Ordners in der folderName -Eigenschaft angeben.

  • moveToSpamFolder– Verschiebt die gemeldete Nachricht in den Junk-Email Ordner des Postfachs.

  • noMove – Belässt die gemeldete Nachricht im aktuellen Ordner.

postProcessingAction?: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: Postfach 1.14 ]

Mindestberechtigungsstufe (Outlook):Element lesen

Anwendbarer Outlook-Modus: Lesen von Nachrichten

Wichtig:

  • In Outlook unter Windows können Sie diese Eigenschaft nur in früheren Builds verwenden, die die integrierte Spamberichterstattungsfunktion unterstützen. Wenn Sie Version 2308 (Build 16724.10000) oder höher verwenden, verwenden Sie stattdessen die moveItemTo -Eigenschaft.

  • Diese Eigenschaft wird in Outlook im Web, macos oder in outlook unter Windows nicht unterstützt. Verwenden Sie stattdessen die moveItemTo -Eigenschaft.

  • Wenn die -Eigenschaft auf moveToCustomFolderfestgelegt ist, müssen Sie in der -Eigenschaft des Aufrufs den Namen des Ordners event.completed angeben, in den die folderName Nachricht verschoben wird. Andernfalls wird die postProcessingAction -Eigenschaft standardmäßig auf moveToSpamFolder festgelegt und die gemeldete Nachricht in den Junk-Email Ordner verschoben.

Beispiele

// The following example handles a SpamReporting event to process a reported spam or phishing message.
function onSpamReport(event) {
    // Gets the Base64-encoded EML format of a reported message.
    Office.context.mailbox.item.getAsFileAsync({ asyncContext: event }, (asyncResult) => {
        if (asyncResult.status === Office.AsyncResultStatus.Failed) {
            console.log(`Error encountered during message processing: ${asyncResult.error.message}`);
            return;
        }

        // Run additional processing operations here.

        /**
         * Signals that the spam-reporting event has completed processing.
         * It then moves the reported message to the Junk Email folder of the mailbox and shows a
         * post-processing dialog to the user.
         */
        const event = asyncResult.asyncContext;
        event.completed({
            postProcessingAction: "moveToSpamFolder",
            showPostProcessingDialog: {
                title: "Contoso Spam Reporting",
                description: "Thank you for reporting this message.",
            },
        });
    });
}

showPostProcessingDialog

Wenn Sie die completed-Methode verwenden, um zu signalisieren, dass die Verarbeitung einer gemeldeten Nachricht abgeschlossen wurde, gibt diese Eigenschaft an, ob dem Benutzer ein Nachbearbeitungsdialogfeld angezeigt wird. Das dieser Eigenschaft zugewiesene JSON-Objekt muss einen Titel und eine Beschreibung enthalten. Wenn diese Eigenschaft nicht angegeben ist, wird dem Benutzer nach der Verarbeitung der gemeldeten Nachricht kein Dialogfeld angezeigt.

showPostProcessingDialog?: object;

Eigenschaftswert

object

Hinweise

[ API-Satz: Postfach 1.14 ]

Mindestberechtigungsstufe (Outlook):Element lesen

Anwendbarer Outlook-Modus: Lesen von Nachrichten

Wichtig: Wenn Sie die commandId Optionen und contextData im event.completed Aufruf so konfigurieren, dass ein Aufgabenbereich geöffnet wird, nachdem ein Benutzer die Option Bericht im Vorverarbeitungsdialogfeld ausgewählt hat, wird dem Benutzer kein Nachbearbeitungsdialogfeld angezeigt. Dieses Verhalten gilt auch, wenn im showPostProcessingDialogevent.completed Aufruf angegeben ist.