Office.SpamReportingEventCompletedOptions interface

Paket:: outlook

Legt das Verhalten eines integrierten Add-Ins für die Spamberichterstattung fest, nachdem die Verarbeitung eines SpamReporting-Ereignisses abgeschlossen ist.

Hinweise

API-Satz: Postfach 1.14

Mindestberechtigungsstufe: Element lesen

Anwendbarer Outlook-Modus: Nachricht lesen

Verwendet von

Office.MailboxEvent: abgeschlossen

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 abgeschlossene Methode verwenden, um zu signalisieren, dass eine gemeldete Nachricht die Verarbeitung abgeschlossen hat, gibt diese Eigenschaft die ID des Aufgabenbereichs an, der nach der Verarbeitung der Nachricht geöffnet wird.
contextData	Wenn Sie die abgeschlossene Methode verwenden, um zu signalisieren, dass eine gemeldete Nachricht die Verarbeitung abgeschlossen hat, gibt diese Eigenschaft alle JSON-Daten an, die nach der Verarbeitung der Nachricht an den Aufgabenbereich des Add-Ins übergeben werden.
folderName	Wenn Sie mit der Completed-Methode signalisieren, dass eine gemeldete Nachricht verarbeitet wurde, gibt diese Eigenschaft den Outlook-Postfachordner an, in den die Nachricht verschoben wird.
moveItemTo	Wenn Sie die abgeschlossene Methode verwenden, um zu signalisieren, dass eine gemeldete Nachricht verarbeitet wurde, gibt diese Eigenschaft an, ob die Nachricht in einen anderen Ordner im Postfach verschoben wird.
onErrorDeleteItem	Wenn diese Einstellung auf festgelegt ist `true`, löscht eine gemeldete Nachricht, wenn während der Verarbeitung der Nachricht ein Fehler auftritt. Wenn diese Eigenschaft auf `false` die abgeschlossene Methode festgelegt oder nicht angegeben ist, verbleibt die gemeldete Nachricht in ihrem aktuellen Postfachordner.
postProcessingAction	Wenn Sie die abgeschlossene Methode verwenden, um zu signalisieren, dass eine gemeldete Nachricht verarbeitet 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 Ordner "Junk-E-Mail" des Postfachs. `noMove` – Belässt die gemeldete Nachricht im aktuellen Ordner.
showPostProcessingDialog	Wenn Sie die abgeschlossene Methode verwenden, um zu signalisieren, dass eine gemeldete Nachricht die Verarbeitung abgeschlossen hat, gibt diese Eigenschaft an, ob dem Benutzer ein Nachbearbeitungsdialog angezeigt wird. Das dieser Eigenschaft zugewiesene JSON-Objekt muss einen Titel und eine Beschreibung enthalten. Wenn diese Eigenschaft nicht angegeben ist, wird dem Benutzer kein Dialogfeld angezeigt, sobald die gemeldete Nachricht verarbeitet wurde.

Details zur Eigenschaft

commandId

Wenn Sie die abgeschlossene Methode verwenden, um zu signalisieren, dass eine gemeldete Nachricht die Verarbeitung abgeschlossen hat, gibt diese Eigenschaft die ID des Aufgabenbereichs an, der nach der Verarbeitung der Nachricht geöffnet wird.

commandId?: string;

Eigenschaftswert

string

Hinweise

API-Satz: Postfach 1.15

Mindestberechtigungsstufe (Outlook):Element lesen

Anwendbarer Outlook-Modus: Nachricht lesen

Wichtig:

Informationen zum Implementieren der commandId Eigenschaft in Ihrem Add-In zur Spamberichterstattung finden Sie unter Öffnen eines Aufgabenbereichs nach dem Melden einer Nachricht.
Der commandId Wert muss mit der ID des Aufgabenbereichs übereinstimmen, die im Manifest Ihres Add-Ins angegeben ist. Im einheitlichen Manifest für Microsoft 365 wird die ID in der "id"-Eigenschaft des Objekts "extensions.ribbons.tabs.groups.controls" angegeben, das den Aufgabenbereich darstellt. In einem Nur-Add-In-Manifest wird die ID im id Attribut des Control-Elements angegeben, das den Aufgabenbereich darstellt.
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.
Um sicherzustellen, dass der Aufgabenbereich Ihres Add-Ins für die Spamberichterstattung geöffnet wird, nachdem eine Nachricht gemeldet wurde, müssen Sie die moveItemTo Option des Aufrufs event.completed auf Office.MailboxEnums.MoveSpamItemTo.NoMovefestlegen.
Wenn Sie einen Aufgabenbereich so implementieren, dass er nach der Verarbeitung einer gemeldeten Nachricht geöffnet wird, wird beim Aufrufen jedes event.completed geöffneten oder angehefteten Aufgabenbereichs geschlossen.
Die commandId Option steht in Outlook auf Mac ab Version 16.103 (Build 25101816) zur Vorschau zur Verfügung. Um diese Option zu testen, treten Sie dem Microsoft 365 Insider-Programm bei, und wählen Sie die Option "Betakanal " aus, um auf Office-Betabuilds zuzugreifen.

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

Wenn Sie die abgeschlossene Methode verwenden, um zu signalisieren, dass eine gemeldete Nachricht die Verarbeitung abgeschlossen hat, 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: Postfach 1.15

Mindestberechtigungsstufe (Outlook):Element lesen

Anwendbarer Outlook-Modus: Nachricht lesen

Wichtig:

Informationen zum Implementieren der contextData Eigenschaft in Ihrem Add-In zur Spamberichterstattung finden Sie unter Öffnen eines Aufgabenbereichs nach dem Melden einer Nachricht.
Wenn Sie die contextData Option in Ihrem event.completed Anruf angeben, müssen Sie der commandId Option auch eine Aufgabenbereichs-ID zuweisen. Andernfalls werden die zugewiesenen contextData JSON-Daten ignoriert.
Wenn Sie die commandIdcontextData Optionen und im event.completed Anruf konfigurieren, wird dem Benutzer kein Nachbearbeitungsdialogfeld angezeigt, auch wenn die showPostProcessingDialog Option im Anruf angegeben ist.
Um sicherzustellen, dass der Aufgabenbereich Ihres Add-Ins für die Spamberichterstattung geöffnet wird und Kontextdaten empfängt, nachdem eine Nachricht gemeldet wurde, müssen Sie die moveItemTo Option des Aufrufs event.completed auf Office.MailboxEnums.MoveSpamItemTo.NoMovesetzen.
Wenn Sie einen Aufgabenbereich so implementieren, dass er nach der Verarbeitung einer gemeldeten Nachricht geöffnet wird, wird beim Aufrufen jedes event.completed geöffneten oder angehefteten Aufgabenbereichs geschlossen.
Implementieren Sie einen Handler für das Office.EventType.InitializationContextChanged Ereignis, um zu verhindern, dass der Aufgabenbereich eines Add-Ins zur Spamberichterstattung neu gestartet wird, wenn er bereits geöffnet ist. Anschließend können Sie die Ereignisargumente an die contextData Eigenschaft übergeben.
Um den Wert der contextData Eigenschaft abzurufen, müssen Sie die JavaScript-Implementierung Ihres Aufgabenbereichs aufrufen Office.context.mailbox.item.getInitializationContextAsync . 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.
Die contextData Option steht in Outlook auf Mac ab Version 16.103 (Build 25101816) zur Vorschau zur Verfügung. Um diese Option zu testen, treten Sie dem Microsoft 365 Insider-Programm bei, und wählen Sie die Option "Betakanal " aus, um auf Office-Betabuilds zuzugreifen.

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 mit der Completed-Methode signalisieren, dass eine gemeldete Nachricht verarbeitet 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: Nachricht lesen

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 Ordner "Junk-Email" des Postfachs verschoben. Wenn postProcessingAction diese auf eine andere Aktion als festgelegt ist moveToCustomFolder, wird die folderName Eigenschaft ignoriert.

moveItemTo

Wenn Sie die abgeschlossene Methode verwenden, um zu signalisieren, dass eine gemeldete Nachricht verarbeitet 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: Nachricht lesen

Wichtig:

Sie können diese Eigenschaft nur in einem Spambericht-Add-In in Outlook im Web, unter Windows (neu und klassisch (ab Version 2308, Build 16724.10000)) und auf dem Mac verwenden. Wenn Sie einen früheren Build des klassischen Outlook unter Windows verwenden, der das integrierte Spamberichtsfeature unterstützt, verwenden Sie stattdessen die postProcessingAction Eigenschaft.
Wenn die Eigenschaft auf Office.MailboxEnums.MoveSpamItemTo.CustomFolderfestgelegt ist, müssen Sie den Namen des Ordners, in den die Nachricht verschoben wird, in der folderName Eigenschaft des Aufrufs event.completed angeben. Andernfalls moveItemTo wird die gemeldete Nachricht standardmäßig in den Ordner "Junk-E-Mail" verschobenOffice.MailboxEnums.MoveSpamItemTo.JunkFolder.
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.NoMovesetzen. Andernfalls wird der Aufgabenbereich nicht geöffnet.

onErrorDeleteItem

Wenn diese Einstellung auf festgelegt ist true, löscht eine gemeldete Nachricht, wenn während der Verarbeitung der Nachricht ein Fehler auftritt. Wenn diese Eigenschaft auf false die abgeschlossene Methode festgelegt oder nicht angegeben ist, verbleibt die gemeldete Nachricht in ihrem aktuellen Postfachordner.

onErrorDeleteItem?: boolean;

Eigenschaftswert

boolean

Hinweise

API-Satz: Postfach 1.14

Mindestberechtigungsstufe (Outlook):Element lesen

Anwendbarer Outlook-Modus: Nachricht lesen

postProcessingAction

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 Ordner "Junk-E-Mail" 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: Nachricht lesen

Wichtig:

In Outlook unter Windows können Sie diese Eigenschaft nur in früheren Builds verwenden, die das integrierte Spam-Berichtsfeature 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 dem Mac oder im neuen Outlook unter Windows nicht unterstützt. Verwenden Sie stattdessen die moveItemTo Eigenschaft.
Wenn die Eigenschaft auf moveToCustomFolderfestgelegt ist, müssen Sie den Namen des Ordners, in den die Nachricht verschoben wird, in der folderName Eigenschaft des Aufrufs event.completed angeben. Andernfalls postProcessingAction wird die gemeldete Nachricht standardmäßig in den Ordner "Junk-E-Mail" verschobenmoveToSpamFolder.

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 abgeschlossene Methode verwenden, um zu signalisieren, dass eine gemeldete Nachricht die Verarbeitung abgeschlossen hat, gibt diese Eigenschaft an, ob dem Benutzer ein Nachbearbeitungsdialog angezeigt wird. Das dieser Eigenschaft zugewiesene JSON-Objekt muss einen Titel und eine Beschreibung enthalten. Wenn diese Eigenschaft nicht angegeben ist, wird dem Benutzer kein Dialogfeld angezeigt, sobald die gemeldete Nachricht verarbeitet wurde.

showPostProcessingDialog?: object;

Eigenschaftswert

object

Hinweise

API-Satz: Postfach 1.14

Mindestberechtigungsstufe (Outlook):Element lesen

Anwendbarer Outlook-Modus: Nachricht lesen

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

Feedback

War diese Seite hilfreich?