Office.SpamReportingEventCompletedOptions interface

Paquet:

outlook

Spécifie le comportement d’un complément de création de rapports de courrier indésirable intégré une fois qu’il a terminé le traitement d’un événement SpamReporting .

Remarques

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

Niveau d’autorisation minimal : élément de lecture

Mode Outlook applicable : Lecture du message

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

Propriétés

commandId	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.
contextData	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.
folderName	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é.
moveItemTo	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.
onErrorDeleteItem	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.
postProcessingAction	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.
showPostProcessingDialog	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é.

Détails de la propriété

commandId

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

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é

string

Remarques

[ Ensemble d’API : préversion de boîte aux lettres ]

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

Mode Outlook applicable : Lecture du message

Important:

• L’option commandId est actuellement en préversion dans Outlook sur le web et sur Windows (nouveau et classique). Pour afficher un aperçu de cette fonctionnalité dans Outlook classique sur Windows, installez la version 2411 (build 18227.20034) ou une version ultérieure. Ensuite, rejoignez le programme Microsoft 365 Insider et sélectionnez l’option Canal bêta . Pour savoir comment implémenter cela dans votre complément de création de rapports de courrier indésirable, consultez Ouvrir un volet Office après avoir signalé un message (préversion) .

• La commandId valeur doit correspondre à l’ID du volet Office spécifié dans le manifeste de votre complément. 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. La commandId propriété n’est actuellement pas prise en charge dans un complément de création de rapports de courrier indésirable qui utilise un manifeste unifié pour Microsoft 365.

• 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.

• 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é.

contextData

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

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é

any

Remarques

[ Ensemble d’API : préversion de boîte aux lettres ]

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

Mode Outlook applicable : Lecture du message

Important:

• L’option contextData est actuellement en préversion dans Outlook sur le web et sur Windows (nouveau et classique). Pour afficher un aperçu de cette fonctionnalité dans Outlook classique sur Windows, installez la version 2411 (build 18227.20034) ou une version ultérieure. Ensuite, rejoignez le programme Microsoft 365 Insider et sélectionnez l’option Canal bêta . Pour savoir comment implémenter cela dans votre complément de création de rapports de courrier indésirable, consultez Ouvrir un volet Office après avoir signalé un message (préversion) .

• 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.

• 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 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.

folderName

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é

string

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.

moveItemTo

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é

Office.MailboxEnums.MoveSpamItemTo

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.

onErrorDeleteItem

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é

boolean

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

postProcessingAction

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é

string

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

showPostProcessingDialog

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é

object

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 .