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

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

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 (ab Version 2308 (Build 16724.10000)), auf Mac und in outlook unter Windows (Vorschau) verwenden. Wenn Sie einen früheren Build in 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.

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, auf Mac oder in outlook unter Windows (Vorschau) 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: In Outlook im Web oder in outlook unter Windows (Vorschau) wird kein Nachbearbeitungsdialogfeld angezeigt, sobald das Add-In die Verarbeitung einer gemeldeten Nachricht abgeschlossen ist. Dies gilt auch, wenn showPostProcessingDialog konfiguriert ist. Je nachdem, wie Sie die moveItemTo Eigenschaft im event.completed Anruf konfiguriert haben, wird jedoch eine Benachrichtigung angezeigt, die signalisiert, wenn die gemeldete Nachricht gelöscht oder in einen anderen Ordner im Postfach verschoben wird. Weitere Informationen finden Sie im Abschnitt "Überprüfen des Featureverhaltens und der Einschränkungen" unter Implementieren eines integrierten Spamberichts-Add-Ins.