Share via

Office.SpamReportingEventCompletedOptions interface

  • Ссылка
Пакет:
outlook

Указывает поведение интегрированной надстройки со сведениями о спаме после завершения обработки события SpamReporting .

Комментарии

[ Набор API: Почтовый ящик 1.14 ]

Минимальный уровень разрешений: чтение элемента

Применимый режим Outlook: чтение сообщений

Примеры

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

Свойства

folderName

При использовании метода completed , чтобы сообщить о завершении обработки сообщения, это свойство указывает папку почтового ящика Outlook, в которую будет перемещено сообщение.
moveItemTo

При использовании метода completed для сообщения о завершении обработки сообщаемого сообщения это свойство указывает, перемещается ли сообщение в другую папку почтового ящика.
onErrorDeleteItem

Если задано значение true, удаляет сообщаемое сообщение при возникновении ошибки во время обработки сообщения. Если для этого свойства задано значение false или не указано в методе completed, сообщение остается в текущей папке почтового ящика.
postProcessingAction

При использовании метода completed для сообщения о завершении обработки сообщаемого сообщения это свойство указывает, перемещается ли сообщение в другую папку почтового ящика. Доступны следующие действия после обработки.

  • delete — перемещает сообщение в папку Удаленные почтового ящика.

  • moveToCustomFolder — перемещает сообщение в указанную папку. Необходимо указать имя папки в свойстве folderName .

  • moveToSpamFolder— перемещает сообщение в папку Нежелательная Email почтового ящика.

  • noMove — оставляет сообщение в текущей папке.
showPostProcessingDialog

Если вы используете метод completed , чтобы сообщить о завершении обработки сообщения, это свойство указывает, отображается ли для пользователя диалоговое окно постобработки. Объект JSON, назначенный этому свойству, должен содержать заголовок и описание. Если это свойство не указано, после обработки сообщаемого сообщения диалоговое окно не отображается для пользователя.

Сведения о свойстве

folderName

При использовании метода completed , чтобы сообщить о завершении обработки сообщения, это свойство указывает папку почтового ящика Outlook, в которую будет перемещено сообщение.

folderName?: string;

Значение свойства

string

Комментарии

[ Набор API: Почтовый ящик 1.14 ]

Минимальный уровень разрешений (Outlook):чтение элемента

Применимый режим Outlook: чтение сообщений

Важно!

  • Если указанная папка еще не существует, она будет создана перед перемещением сообщения.

  • postProcessingAction Если для свойства задано значение moveToCustomFolder, folderName необходимо указать свойство . В противном случае сообщение перемещается в папку Нежелательная Email почтового ящика. Если postProcessingAction задано другое действие, отличное moveToCustomFolderfolderName от , свойство игнорируется.

moveItemTo

При использовании метода completed для сообщения о завершении обработки сообщаемого сообщения это свойство указывает, перемещается ли сообщение в другую папку почтового ящика.

moveItemTo?: MailboxEnums.MoveSpamItemTo;

Значение свойства

Office.MailboxEnums.MoveSpamItemTo

Комментарии

[ Набор API: Почтовый ящик 1.14 ]

Минимальный уровень разрешений (Outlook):чтение элемента

Применимый режим Outlook: чтение сообщений

Важно!

  • Это свойство можно использовать только в надстройке, сообщающей о спаме, в Outlook в Интернете, в Windows (начиная с версии 2308 (сборка 16724.10000)), на Компьютере Mac и в новом Outlook для Windows (предварительная версия). Если вы используете более раннюю сборку в Outlook для Windows, которая поддерживает встроенную функцию создания отчетов о нежелательной почте postProcessingAction , используйте свойство .

  • Если для свойства задано значение Office.MailboxEnums.MoveSpamItemTo.CustomFolder, необходимо указать имя папки, в которую будет перемещено сообщение, в folderName свойстве event.completed вызова. В противном moveItemTo случае свойство по умолчанию Office.MailboxEnums.MoveSpamItemTo.JunkFolder будет использовать значение и переместит сообщение в папку Нежелательная Email.

onErrorDeleteItem

Если задано значение true, удаляет сообщаемое сообщение при возникновении ошибки во время обработки сообщения. Если для этого свойства задано значение false или не указано в методе completed, сообщение остается в текущей папке почтового ящика.

onErrorDeleteItem?: boolean;

Значение свойства

boolean

Комментарии

[ Набор API: Почтовый ящик 1.14 ]

Минимальный уровень разрешений (Outlook):чтение элемента

Применимый режим Outlook: чтение сообщений

postProcessingAction

При использовании метода completed для сообщения о завершении обработки сообщаемого сообщения это свойство указывает, перемещается ли сообщение в другую папку почтового ящика. Доступны следующие действия после обработки.

  • delete — перемещает сообщение в папку Удаленные почтового ящика.

  • moveToCustomFolder — перемещает сообщение в указанную папку. Необходимо указать имя папки в свойстве folderName .

  • moveToSpamFolder— перемещает сообщение в папку Нежелательная Email почтового ящика.

  • noMove — оставляет сообщение в текущей папке.

postProcessingAction?: string;

Значение свойства

string

Комментарии

[ Набор API: Почтовый ящик 1.14 ]

Минимальный уровень разрешений (Outlook):чтение элемента

Применимый режим Outlook: чтение сообщений

Важно!

  • В Outlook для Windows это свойство можно использовать только в более ранних сборках, которые поддерживают встроенную функцию создания отчетов о спаме. Если вы используете версию 2308 (сборка 16724.10000) или более позднюю, используйте moveItemTo вместо этого свойство .

  • Это свойство не поддерживается в Outlook в Интернете, на Mac или в новом Outlook для Windows (предварительная версия). Вместо этого используйте moveItemTo свойство .

  • Если для свойства задано значение moveToCustomFolder, необходимо указать имя папки, в которую будет перемещено сообщение, в folderName свойстве event.completed вызова. В противном postProcessingAction случае свойство по умолчанию moveToSpamFolder будет использовать значение и переместит сообщение в папку Нежелательная Email.

Примеры

// 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

Если вы используете метод completed , чтобы сообщить о завершении обработки сообщения, это свойство указывает, отображается ли для пользователя диалоговое окно постобработки. Объект JSON, назначенный этому свойству, должен содержать заголовок и описание. Если это свойство не указано, после обработки сообщаемого сообщения диалоговое окно не отображается для пользователя.

showPostProcessingDialog?: object;

Значение свойства

object

Комментарии

[ Набор API: Почтовый ящик 1.14 ]

Минимальный уровень разрешений (Outlook):чтение элемента

Применимый режим Outlook: чтение сообщений

Важно! В Outlook в Интернете или в новом Outlook в Windows (предварительная версия) диалоговое окно постобработки не отображается после завершения обработки сообщаемого сообщения надстройкой. Это применимо, даже если showPostProcessingDialog настроено. Однако в зависимости от того, как вы настроили moveItemTo свойство в event.completed вызове, отображается уведомление о том, что сообщение удаляется или перемещается в другую папку почтового ящика. Дополнительные сведения см. в разделе "Проверка поведения функций и ограничений" статьи Реализация интегрированной надстройки для отчетов о спаме.