Office.SpamReportingEventCompletedOptions interface

Lorsque vous utilisez la méthode completed pour signaler qu’un message signalé a terminé le traitement, cette propriété spécifie l’ID du volet Office qui s’ouvre après le traitement du message.

commandId?: string;

Valeur de propriété

Remarques

[ Ensemble d’API : Boîte aux lettres 1.15 ]

Niveau d’autorisation minimal (Outlook) : élément de lecture

Mode Outlook applicable : Lecture du message

Important:

• Pour savoir comment implémenter la commandId propriété dans votre complément de création de rapports de courrier indésirable, consultez Ouvrir un volet Office après avoir signalé un message.

• La commandId valeur doit correspondre à l’ID du volet Office spécifié dans le manifeste de votre complément. Dans le manifeste unifié pour Microsoft 365, l’ID est spécifié dans la propriété « id » de l’objet « extensions.ribbons.tabs.groups.controls » qui représente le volet Office. Dans un manifeste de complément uniquement, l’ID est spécifié dans l’attribut id de l’élément Control qui représente le volet Office.

• Si vous configurez l’option commandId dans l’appel event.completed , une boîte de dialogue de post-traitement n’est pas affichée à l’utilisateur, même si l’option showPostProcessingDialog est spécifiée dans l’appel.

• Pour vous assurer que le volet Office de votre complément de création de rapports de courrier indésirable s’ouvre après le signalement d’un message, vous devez définir l’option moveItemTo de l’appel event.completed sur Office.MailboxEnums.MoveSpamItemTo.NoMove.

• Si vous implémentez un volet Office à ouvrir après le traitement d’un message signalé, lorsque l’appel event.completed se produit, tout volet Office ouvert ou épinglé est fermé.

Exemples

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

Lorsque vous utilisez la méthode completed pour signaler qu’un message signalé a terminé le traitement, cette propriété spécifie toutes les données JSON transmises au volet Office du complément après le traitement du message.

contextData?: any;

Valeur de propriété

Remarques

[ Ensemble d’API : Boîte aux lettres 1.15 ]

Niveau d’autorisation minimal (Outlook) : élément de lecture

Mode Outlook applicable : Lecture du message

Important:

• Pour savoir comment implémenter la contextData propriété dans votre complément de création de rapports de courrier indésirable, consultez Ouvrir un volet Office après avoir signalé un message.

• Si vous spécifiez l’option contextData dans votre event.completed appel, vous devez également affecter un ID de volet Office à l’option commandId . Sinon, les données JSON affectées à contextData sont ignorées.

• Si vous configurez les commandId options et contextData dans l’appel event.completed , une boîte de dialogue de post-traitement n’est pas affichée à l’utilisateur, même si l’option showPostProcessingDialog est spécifiée dans l’appel.

• Pour vous assurer que le volet Office de votre complément de création de rapports de courrier indésirable s’ouvre et reçoit des données de contexte après le signalement d’un message, vous devez définir l’option moveItemTo de l’appel event.completed sur Office.MailboxEnums.MoveSpamItemTo.NoMove.

• Si vous implémentez un volet Office à ouvrir après le traitement d’un message signalé, lorsque l’appel event.completed se produit, tout volet Office ouvert ou épinglé est fermé.

• Pour empêcher le volet Office d’un complément de création de rapports de courrier indésirable de se relancer s’il est déjà ouvert, implémentez un gestionnaire pour l’événement Office.EventType.InitializationContextChanged . Vous pouvez ensuite passer les arguments d’événement à la contextData propriété .

• Pour récupérer la valeur de la contextData propriété, vous devez appeler Office.context.mailbox.item.getInitializationContextAsync dans l’implémentation JavaScript de votre volet Office. Si vous créez une chaîne JSON à l’aide JSON.stringify() de et que vous l’attribuez à la contextData propriété , vous devez analyser la chaîne à l’aide JSON.parse() de une fois que vous l’avez récupérée.

Exemples

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

Lorsque vous utilisez la méthode completed pour signaler qu’un message signalé a terminé le traitement, cette propriété spécifie le dossier de boîte aux lettres Outlook vers lequel le message sera déplacé.

folderName?: string;

Valeur de propriété

Remarques

[ Ensemble d’API : Boîte aux lettres 1.14 ]

Niveau d’autorisation minimal (Outlook) : élément de lecture

Mode Outlook applicable : Lecture du message

Important:

• Si le dossier spécifié n’existe pas encore, il est créé avant le déplacement du message.

• Si la propriété a la postProcessingAction valeur moveToCustomFolder, la folderName propriété doit être spécifiée. Sinon, le message signalé est déplacé vers le dossier Email indésirable de la boîte aux lettres. Si postProcessingAction est défini sur une autre action que moveToCustomFolder, la folderName propriété est ignorée.

Lorsque vous utilisez la méthode completed pour signaler qu’un message signalé a terminé le traitement, cette propriété spécifie si le message est déplacé vers un autre dossier dans la boîte aux lettres.

moveItemTo?: MailboxEnums.MoveSpamItemTo;

Valeur de propriété

Remarques

[ Ensemble d’API : Boîte aux lettres 1.14 ]

Niveau d’autorisation minimal (Outlook) : élément de lecture

Mode Outlook applicable : Lecture du message

Important:

• Vous pouvez uniquement utiliser cette propriété dans un complément de signalement de courrier indésirable dans Outlook sur le web, sur Windows (nouveau et classique (à partir de la version 2308, build 16724.10000)) et sur Mac. Si vous utilisez une version antérieure d’Outlook classique sur Windows qui prend en charge la fonctionnalité intégrée de création de rapports de courrier indésirable, utilisez la propriété à la postProcessingAction place.

• Si la propriété a la valeur Office.MailboxEnums.MoveSpamItemTo.CustomFolder, vous devez spécifier le nom du dossier vers lequel le message sera déplacé dans la folderName propriété de l’appel event.completed . Sinon, la moveItemTo propriété est définie par défaut Office.MailboxEnums.MoveSpamItemTo.JunkFolder sur et déplace le message signalé vers le dossier Email indésirables.

• Si vous configurez les commandId options et contextData dans l’appel event.completed pour ouvrir un volet Office après qu’un utilisateur a sélectionné l’option Rapport dans la boîte de dialogue de prétraitement, vous devez définir l’option moveItemTo sur Office.MailboxEnums.MoveSpamItemTo.NoMove. Sinon, le volet Office ne s’ouvre pas.

Lorsque la valeur trueest définie sur , supprime un message signalé si une erreur se produit pendant le traitement du message. Si cette propriété a la false valeur ou n’est pas spécifiée dans la méthode completed, le message signalé reste dans son dossier de boîte aux lettres actuel.

onErrorDeleteItem?: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : Boîte aux lettres 1.14 ]

Niveau d’autorisation minimal (Outlook) : élément de lecture

Mode Outlook applicable : Lecture du message

Lorsque vous utilisez la méthode completed pour signaler qu’un message signalé a terminé le traitement, cette propriété spécifie si le message est déplacé vers un autre dossier dans la boîte aux lettres. Les actions de post-traitement suivantes sont disponibles.

• delete - Déplace le message signalé vers le dossier Éléments supprimés de la boîte aux lettres.

• moveToCustomFolder - Déplace le message signalé vers un dossier spécifié. Vous devez spécifier le nom du dossier dans la folderName propriété .

• moveToSpamFolder- Déplace le message signalé vers le dossier Email indésirable de la boîte aux lettres.

• noMove - Laisse le message signalé dans son dossier actif.

postProcessingAction?: string;

Valeur de propriété

Remarques

[ Ensemble d’API : Boîte aux lettres 1.14 ]

Niveau d’autorisation minimal (Outlook) : élément de lecture

Mode Outlook applicable : Lecture du message

Important:

• Dans Outlook sur Windows, vous pouvez uniquement utiliser cette propriété dans les builds antérieures qui prennent en charge la fonctionnalité intégrée de création de rapports de courrier indésirable. Si vous utilisez la version 2308 (build 16724.10000) ou une version ultérieure, utilisez la propriété à la moveItemTo place.

• Cette propriété n’est pas prise en charge dans Outlook sur le web, sur Mac ou dans la nouvelle version d’Outlook sur Windows. Utilisez la propriété à la moveItemTo place.

• Si la propriété a la valeur moveToCustomFolder, vous devez spécifier le nom du dossier vers lequel le message sera déplacé dans la folderName propriété de l’appel event.completed . Sinon, la postProcessingAction propriété est définie par défaut moveToSpamFolder sur et déplace le message signalé vers le dossier Email indésirables.

Exemples

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

Lorsque vous utilisez la méthode completed pour signaler qu’un message signalé a terminé le traitement, cette propriété indique si une boîte de dialogue de post-traitement est affichée à l’utilisateur. L’objet JSON affecté à cette propriété doit contenir un titre et une description. Si cette propriété n’est pas spécifiée, une boîte de dialogue n’est pas affichée à l’utilisateur une fois son message signalé traité.

showPostProcessingDialog?: object;

Valeur de propriété

Remarques

[ Ensemble d’API : Boîte aux lettres 1.14 ]

Niveau d’autorisation minimal (Outlook) : élément de lecture

Mode Outlook applicable : Lecture du message

Important : si vous configurez les commandId options et contextData dans l’appel event.completed pour ouvrir un volet Office après qu’un utilisateur a sélectionné l’option Rapport dans la boîte de dialogue de prétraitement, aucune boîte de dialogue de post-traitement n’est affichée à l’utilisateur. Ce comportement s’applique même si est showPostProcessingDialog spécifié dans l’appel event.completed .