Office.SpamReportingEventCompletedOptions interface

  • Référence
Paquet:
outlook

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.

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 : préversion de boîte aux lettres ]

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

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é

folderName

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 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 : préversion de boîte aux lettres ]

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

moveItemTo

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 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 : préversion de boîte aux lettres ]

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

Mode Outlook applicable : Lecture du message

Important:

  • Vous pouvez utiliser cette propriété uniquement dans un complément de signalement de courrier indésirable dans Outlook sur le web, sur Windows (à partir de la version 2308 (build 16724.10000)), sur Mac et dans le nouvel Outlook sur Windows (préversion). Si vous utilisez une version antérieure dans Outlook 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.

onErrorDeleteItem

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 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 : préversion de boîte aux lettres ]

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

Mode Outlook applicable : Lecture du message

postProcessingAction

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 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 : préversion de boîte aux lettres ]

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 (préversion). 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

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é 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 : préversion de boîte aux lettres ]

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

Mode Outlook applicable : Lecture du message

Important : dans Outlook sur le web ou dans la nouvelle version d’Outlook sur Windows (préversion), une boîte de dialogue de post-traitement ne s’affiche pas une fois que le complément a terminé le traitement d’un message signalé. Cela s’applique même si showPostProcessingDialog est configuré. Toutefois, selon la façon dont vous avez configuré la moveItemTo propriété dans l’appel event.completed , une notification s’affiche pour signaler quand le message signalé est supprimé ou déplacé vers un autre dossier dans la boîte aux lettres. Pour plus d’informations, consultez la section « Vérifier le comportement et les limitations des fonctionnalités » de Implémenter un complément de création de rapports de courrier indésirable intégré (préversion) .