Office.SpamReportingEventCompletedOptions interface

Lorsque vous utilisez la méthode completed pour signaler la fin du traitement d’un message signalé, 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

Jeu d’API : Boîte aux lettres 1.15

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

Mode Outlook applicable : Message lu

Important:

• Pour savoir comment implémenter la commandId propriété dans votre complément de signalement 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 Contrôle 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 ne s’affiche pas pour 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 signalement de courrier indésirable s’ouvre après la signalement d’un message, vous devez définir l’option moveItemTo d’appel event.completed sur Office.MailboxEnums.MoveSpamItemTo.NoMove.

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

• L’option commandId est disponible en préversion dans Outlook sur Mac à partir de la version 16.103 (build 25101816). Pour tester cette option, rejoignez le programme Microsoft 365 Insider et sélectionnez l’option Canal bêta pour accéder aux builds bêta d’Office.

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 la fin du traitement d’un message signalé, cette propriété spécifie toutes les données JSON transmises au volet Office du complément une fois le message traité.

contextData?: any;

Valeur de propriété

Remarques

Jeu d’API : Boîte aux lettres 1.15

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

Mode Outlook applicable : Message lu

Important:

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

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

• Si vous configurez les commandId options et contextData dans l’appel event.completed , une boîte de dialogue de post-traitement ne s’affiche pas pour 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 signalement 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 d’appel event.completed sur Office.MailboxEnums.MoveSpamItemTo.NoMove.

• Si vous implémentez un volet Office pour s’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 signalement 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 transmettre les arguments de l’événement à la contextData propriété.

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

• L’option contextData est disponible en préversion dans Outlook sur Mac à partir de la version 16.103 (build 25101816). Pour tester cette option, rejoignez le programme Microsoft 365 Insider et sélectionnez l’option Canal bêta pour accéder aux builds bêta d’Office.

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 la fin du traitement d’un message signalé, 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

Jeu d’API : Boîte aux lettres 1.14

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

Mode Outlook applicable : Message lu

Important:

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

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

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

moveItemTo?: MailboxEnums.MoveSpamItemTo;

Valeur de propriété

Remarques

Jeu d’API : Boîte aux lettres 1.14

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

Mode Outlook applicable : Message lu

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 signalement de courrier indésirable, utilisez plutôt la postProcessingAction propriété.

• Si la propriété est définie sur 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 . Dans le cas contraire, la moveItemTo propriété déplace par défaut Office.MailboxEnums.MoveSpamItemTo.JunkFolder le message signalé vers le dossier Courrier indésirable Email.

• Si vous configurez les commandId options et contextData dans l’appel event.completed pour ouvrir un volet des tâches 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 des tâches ne s’ouvre pas.

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

onErrorDeleteItem?: boolean;

Valeur de propriété

Remarques

Jeu d’API : Boîte aux lettres 1.14

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

Mode Outlook applicable : Message lu

Lorsque vous utilisez la méthode completed pour signaler la fin du traitement d’un message signalé, cette propriété spécifie si le message est déplacé vers un autre dossier de 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 Courrier indésirable Email de la boîte aux lettres.

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

postProcessingAction?: string;

Valeur de propriété

Remarques

Jeu d’API : Boîte aux lettres 1.14

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

Mode Outlook applicable : Message lu

Important:

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

• 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 plutôt la moveItemTo propriété.

• Si la propriété est définie sur 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 . Dans le cas contraire, la postProcessingAction propriété déplace par défaut moveToSpamFolder le message signalé vers le dossier Courrier indésirable Email.

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 terminée pour signaler qu’un message signalé a terminé le traitement, cette propriété indique si une boîte de dialogue de post-traitement s’affiche à 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, aucune boîte de dialogue n’est affichée à l’utilisateur une fois que son message signalé est traité.

showPostProcessingDialog?: object;

Valeur de propriété

Remarques

Jeu d’API : Boîte aux lettres 1.14

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

Mode Outlook applicable : Message lu

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