Office.SpamReportingEventCompletedOptions interface

Пакет:: outlook

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

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

Свойства

commandId	Когда метод completed используется для оповещения о завершении обработки сообщенного сообщения, это свойство определяет идентификатор области задач, которая открывается после обработки сообщения.
contextData	Когда вы используете метод completed , чтобы сообщить о завершении обработки сообщенного сообщения, это свойство указывает все данные JSON, передаваемые в область задач надстройки после обработки сообщения.
folderName	Когда метод completed используется для оповещения о завершении обработки сообщенного сообщения, это свойство указывает папку почтового ящика Outlook, в которую будет перемещено сообщение.
moveItemTo	Когда вы используете метод completed , чтобы сообщить о завершении обработки сообщенного сообщения, это свойство определяет, перемещено ли сообщение в другую папку в почтовом ящике.
onErrorDeleteItem	Если задано значение `true`, сообщение о жалобе удаляется, если во время обработки сообщения возникает ошибка. Если для этого свойства установлено значение `false` или не указано в методе completed, сообщение остается в текущей папке почтового ящика.
postProcessingAction	Когда вы используете метод completed , чтобы сообщить о завершении обработки сообщенного сообщения, это свойство определяет, перемещено ли сообщение в другую папку в почтовом ящике. Доступны следующие действия после обработки. `delete` – Перемещение сообщения в папку «Удаленные » почтового ящика. `moveToCustomFolder` - Перемещает сообщение, на которое вы пожаловались, в указанную папку. Необходимо указать имя папки в свойстве `folderName` . `moveToSpamFolder`- Перемещает сообщение, на которое вы пожаловались, в папку Email нежелательной почты почтового ящика. `noMove` - Оставляет сообщение, на которое вы жалуетесь, в текущей папке.
showPostProcessingDialog	Когда вы используете метод completed , чтобы сообщить о завершении обработки сообщенного сообщения, это свойство указывает, отображается ли диалоговое окно постобработки. Объект JSON, назначенный этому свойству, должен содержать заголовок и описание. Если это свойство не указано, пользователю не будет показано диалоговое окно после обработки сообщенного ему сообщения.

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

commandId

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

commandId?: string;

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

string

Чтобы узнать, как реализовать это свойство commandId в надстройке для отчетов о спаме, см. статью Открытие области задач после отправки жалобы на сообщение.
Значение commandId должно совпадать с идентификатором области задач, указанным в манифесте надстройки. В едином манифесте Microsoft 365 идентификатор указан в свойстве "id" объекта "extensions.ribbons.tabs.groups.controls", представляющего область задач. В манифесте, состоящем только из надстроек, идентификатор задается в id атрибуте элемента Control , представляющего область задач.
Если вы настраиваете параметр в event.completed вызовеcommandId, пользователю не демонстрируется диалоговое окно постобработки, даже если showPostProcessingDialog параметр указан в вызове.
Чтобы область задач надстройки для сообщений о нежелательной почте открывалась после отправки жалобы на сообщение, необходимо установить moveItemTo для вызова event.completed значение Office.MailboxEnums.MoveSpamItemTo.NoMove.
Если вы настроите так, чтобы область задач открывалась после обработки сообщенного сообщения, при возникновении event.completed вызова все открытые или закрепленные области задач закрываются.
Этот commandId параметр доступен для предварительного просмотра в Outlook на Mac, начиная с версии 16.103 (сборка 25101816). Чтобы протестировать этот вариант, присоединитесь к программе предварительной оценки Microsoft 365 и выберите вариант бета-канала для доступа к бета-сборкам Office.

Примеры

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

contextData

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

contextData?: any;

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

any

Чтобы узнать, как реализовать это свойство contextData в надстройке для отчетов о спаме, см. статью Открытие области задач после отправки жалобы на сообщение.
Если вы укажете этот вариант в своем event.completed вызовеcontextData, необходимо также назначить ему идентификатор commandId области задач. В противном случае назначенные contextData данные JSON игнорируются.
Если вы настроите commandId параметры и contextData в вызове event.completed , диалоговое окно постобработки не будет отображаться для пользователя, даже если showPostProcessingDialog этот параметр указан в вызове.
Чтобы гарантировать, что область задач вашей надстройки для отчетов о нежелательной почте открывается и получает контекстные данные после отправки жалобы на сообщение, необходимо установить moveItemTo для вызова event.completed значение Office.MailboxEnums.MoveSpamItemTo.NoMove.
Если вы настроите так, чтобы область задач открывалась после обработки сообщенного сообщения, при возникновении event.completed вызова все открытые или закрепленные области задач закрываются.
Чтобы предотвратить перезапуск области задач надстройки для отчетов о спаме, если она уже открыта, реализуйте обработчик для Office.EventType.InitializationContextChanged этого события. Затем можно передать аргументы события в свойство contextData .
Чтобы получить значение contextData свойства, необходимо вызвать Office.context.mailbox.item.getInitializationContextAsync реализацию области задач в JavaScript. Если вы создаете строку JSON с помощью JSON.stringify() свойства и назначаете ее contextData свойству, необходимо проанализировать строку с помощью одного JSON.parse() извлечения.
Этот contextData параметр доступен для предварительного просмотра в Outlook на Mac, начиная с версии 16.103 (сборка 25101816). Чтобы протестировать этот вариант, присоединитесь к программе предварительной оценки Microsoft 365 и выберите вариант бета-канала для доступа к бета-сборкам Office.

Примеры

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

folderName

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

folderName?: string;

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

string

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

moveItemTo

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

moveItemTo?: MailboxEnums.MoveSpamItemTo;

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

Office.MailboxEnums.MoveSpamItemTo

Это свойство можно использовать только в надстройке для отчетов о спаме в Outlook в Интернете, Windows (новой и классической (начиная с версии 2308, сборка 16724.10000)) и Mac. Если вы используете более раннюю сборку классического Outlook для Windows, которая поддерживает встроенную функцию сообщения о спаме, используйте свойство postProcessingAction .
Если свойство имеет значение Office.MailboxEnums.MoveSpamItemTo.CustomFolder, необходимо указать имя папки, в которую будет перемещено folderName сообщение в свойстве вызова event.completed . В противном случае свойство moveItemTo по умолчанию Office.MailboxEnums.MoveSpamItemTo.JunkFolder переместит сообщение в папку Junk Email.
Если в вызове настроены параметры event.completed andcontextData, commandId чтобы открыть область задач после того, как пользователь выберет параметр "Отчет" в диалоговом окне предварительной обработки, необходимо присвоить moveItemTo этому параметру значение Office.MailboxEnums.MoveSpamItemTo.NoMove. В противном случае область задач не откроется.

onErrorDeleteItem

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

onErrorDeleteItem?: boolean;

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

boolean

postProcessingAction

delete – Перемещение сообщения в папку «Удаленные » почтового ящика.
moveToCustomFolder - Перемещает сообщение, на которое вы пожаловались, в указанную папку. Необходимо указать имя папки в свойстве folderName .
moveToSpamFolder- Перемещает сообщение, на которое вы пожаловались, в папку Email нежелательной почты почтового ящика.
noMove - Оставляет сообщение, на которое вы жалуетесь, в текущей папке.

postProcessingAction?: string;

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

string

В Outlook для Windows это свойство можно использовать только в более ранних сборках, поддерживающих встроенную функцию сообщений о нежелательной почте. Если у вас версия 2308 (сборка 16724.10000) или более поздняя, используйте свойство moveItemTo .
Это свойство не поддерживается в Outlook в Интернете, на Mac или в новом Outlook для Windows. Используйте свойство moveItemTo .
Если свойство имеет значение moveToCustomFolder, необходимо указать имя папки, в которую будет перемещено folderName сообщение в свойстве вызова event.completed . В противном случае свойство postProcessingAction по умолчанию moveToSpamFolder переместит сообщение в папку Junk 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

Важно! ЕслиcommandId параметры и contextData в вызове event.completed настроены на открытие области задач после того, как пользователь выберет параметр "Отчет" в диалоговом окне предварительной обработки, пользователю не будет показано диалоговое окно последующей обработки. Это поведение применяется, даже если оно showPostProcessingDialog указано в вызове event.completed .

Обратная связь

Были ли сведения на этой странице полезными?

Комментарии

Используется

Примеры

Свойства

commandId

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

Комментарии

Примеры

contextData

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

Комментарии

Примеры

folderName

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

Комментарии

moveItemTo

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

Комментарии

onErrorDeleteItem

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

Комментарии

postProcessingAction

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

Комментарии

Примеры

showPostProcessingDialog

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

Комментарии