Office.SpamReportingEventCompletedOptions interface

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

commandId?: string;

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

Комментарии

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

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

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

Важно!

• Сведения о том, как реализовать commandId свойство в надстройке отчетов о спаме, см. в статье Открытие области задач после отправки сообщения.

• Значение commandId должно соответствовать идентификатору области задач, указанному в манифесте надстройки. В унифицированном манифесте Microsoft 365 идентификатор указывается в свойстве id объекта extensions.ribbons.tabs.groups.controls , представляющего область задач. В манифесте только надстройки идентификатор указывается в атрибуте id элемента Control , представляющего область задач.

• При настройке commandId параметра в вызове event.completed пользователю не отображается диалоговое окно постобработки, даже если showPostProcessingDialog параметр указан в вызове.

• Чтобы убедиться, что область задач надстройки отчетов о нежелательной почте открывается после сообщения, необходимо задать moveItemTo для event.completed вызова Office.MailboxEnums.MoveSpamItemTo.NoMoveзначение .

• При реализации области задач, открываемой после обработки сообщения, при вызове event.completed любая открытая или закрепленная область задач закрывается.

Примеры

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

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

contextData?: any;

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

Комментарии

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

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

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

Важно!

• Сведения о том, как реализовать contextData свойство в надстройке отчетов о спаме, см. в статье Открытие области задач после отправки сообщения.

• Если вы указываете contextData параметр в вызове event.completed , необходимо также назначить параметру 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() после ее извлечения.

Примеры

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

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

folderName?: string;

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

Комментарии

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

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

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

Важно!

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

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

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

moveItemTo?: MailboxEnums.MoveSpamItemTo;

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

Комментарии

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

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

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

Важно!

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

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

• Если вы настроили commandId параметры и contextData в вызове event.completed , чтобы открыть область задач после того, как пользователь выберет параметр Отчет в диалоговом окне предварительной обработки, необходимо задать для moveItemTo параметра значение Office.MailboxEnums.MoveSpamItemTo.NoMove. В противном случае область задач не откроется.

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

onErrorDeleteItem?: boolean;

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

Комментарии

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

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

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

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

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

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

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

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

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

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

showPostProcessingDialog?: object;

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

Комментарии

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

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

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

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