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

プロパティ

commandId

completed メソッドを使用して、報告されたメッセージの処理が完了したことを通知する場合、このプロパティはメッセージの処理後に開く作業ウィンドウの ID を指定します。
contextData

completed メソッドを使用して、報告されたメッセージの処理が完了したことを通知する場合、このプロパティは、メッセージの処理後にアドインの作業ウィンドウに渡される JSON データを指定します。
folderName

completed メソッドを使用して、報告されたメッセージの処理が完了したことを通知する場合、このプロパティにより、メッセージの移動先となる Outlook メールボックス フォルダーが指定されます。
moveItemTo

completed メソッドを使用して、報告されたメッセージの処理が完了したことを通知する場合、このプロパティは、メッセージをメールボックス内の別のフォルダーに移動するかどうかを指定します。
onErrorDeleteItem

true に設定すると、メッセージの処理中にエラーが発生した場合に、報告されたメッセージを削除します。 このプロパティが false に設定されているか、 completed メソッド で指定されていない場合、報告されたメッセージは現在のメールボックス フォルダーに残ります。
postProcessingAction

completed メソッドを使用して、報告されたメッセージの処理が完了したことを通知する場合、このプロパティは、メッセージをメールボックス内の別のフォルダーに移動するかどうかを指定します。 次の後処理アクションを使用できます。

  • delete - 報告されたメッセージをメールボックスの [削除済みアイテム ] フォルダーに移動します。

  • moveToCustomFolder - 報告されたメッセージを指定したフォルダーに移動します。 folderName プロパティでフォルダーの名前を指定する必要があります。

  • moveToSpamFolder- 報告されたメッセージをメールボックスの [Junk Email] フォルダーに移動します。

  • noMove - 報告されたメッセージを現在のフォルダーに残します。
showPostProcessingDialog

completed メソッドを使用して、報告されたメッセージの処理が完了したことを通知する場合、このプロパティは、後処理ダイアログがユーザーに表示されるかどうかを示します。 このプロパティに割り当てられている JSON オブジェクトには、タイトルと説明が含まれている必要があります。 このプロパティが指定されていない場合、通報されたメッセージが処理された後、ダイアログはユーザーに表示されません。

プロパティの詳細

commandId

completed メソッドを使用して、報告されたメッセージの処理が完了したことを通知する場合、このプロパティはメッセージの処理後に開く作業ウィンドウの ID を指定します。

commandId?: string;

プロパティ値

string

注釈

API セット: メールボックス 1.15

最小アクセス許可レベル (Outlook): アイテムの読み取り

適用可能な Outlook モード: メッセージの読み取り

重要:

  • スパム報告アドインに commandId プロパティを実装する方法については、「メッセージを報告した後に作業ウィンドウを開く」を参照してください。

  • commandId値は、アドインのマニフェストで指定された作業ウィンドウ ID と一致する必要があります。 Microsoft 365 の統合マニフェストでは、ID は作業ウィンドウを表す "extensions.ribbons.tabs.groups.controls" オブジェクトの "id" プロパティで指定されます。 アドインのみのマニフェストでは、ID は作業ウィンドウを表す Control 要素の id 属性で指定されます。

  • event.completed 呼び出しでcommandIdオプションを構成すると、呼び出しで showPostProcessingDialog オプションが指定されていても、後処理ダイアログはユーザーに表示されません。

  • メッセージが報告された後にスパム報告アドインの作業ウィンドウが開くようにするには、event.completed呼び出しの [moveItemTo] オプションを Office.MailboxEnums.MoveSpamItemTo.NoMove に設定する必要があります。

  • 報告されたメッセージが処理された後に開く作業ウィンドウを実装した場合、 event.completed 呼び出しが発生すると、開いている作業ウィンドウまたはピン留めされている作業ウィンドウはすべて閉じられます。

  • commandIdオプションは、Outlook on Mac バージョン 16.103 (ビルド 25101816) 以降でプレビューできます。 このオプションをテストするには、 Microsoft 365 Insider プログラム に参加し、[ ベータ チャネル] オプションを選択して 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

注釈

API セット: メールボックス 1.15

最小アクセス許可レベル (Outlook): アイテムの読み取り

適用可能な Outlook モード: メッセージの読み取り

重要:

  • スパム報告アドインに contextData プロパティを実装する方法については、「メッセージを報告した後に作業ウィンドウを開く」を参照してください。

  • event.completed 呼び出しでcontextDataオプションを指定する場合は、作業ウィンドウ ID をcommandIdオプションにも割り当てる必要があります。 それ以外の場合、 contextData に割り当てられた JSON データは無視されます。

  • event.completed 呼び出しで commandId オプションと contextData オプションを構成すると、呼び出しで showPostProcessingDialog オプションが指定されていても、後処理ダイアログはユーザーに表示されません。

  • メッセージが報告された後に、スパム報告アドインの作業ウィンドウを開いてコンテキスト データを受信するには、event.completed呼び出しの moveItemTo オプションを Office.MailboxEnums.MoveSpamItemTo.NoMove に設定する必要があります。

  • 報告されたメッセージが処理された後に開く作業ウィンドウを実装した場合、 event.completed 呼び出しが発生すると、開いている作業ウィンドウまたはピン留めされている作業ウィンドウはすべて閉じられます。

  • スパム報告アドインの作業ウィンドウが既に開いている場合に再起動されないようにするには、 Office.EventType.InitializationContextChanged イベントのハンドラーを実装します。 その後、 イベント引数 を contextData プロパティに渡すことができます。

  • contextData プロパティの値を取得するには、作業ウィンドウの JavaScript 実装で Office.context.mailbox.item.getInitializationContextAsync を呼び出す必要があります。 JSON.stringify() を使用して JSON 文字列を作成し、それを contextData プロパティに割り当てる場合は、文字列を取得した後は、JSON.parse() を使用して文字列を解析する必要があります。

  • contextDataオプションは、Outlook on Mac バージョン 16.103 (ビルド 25101816) 以降でプレビューできます。 このオプションをテストするには、 Microsoft 365 Insider プログラム に参加し、[ ベータ チャネル] オプションを選択して 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

注釈

API セット: メールボックス 1.14

最小アクセス許可レベル (Outlook): アイテムの読み取り

適用可能な Outlook モード: メッセージの読み取り

重要:

  • 指定したフォルダーがまだ存在しない場合は、メッセージが移動される前に作成されます。

  • postProcessingAction プロパティが moveToCustomFolder に設定されている場合は、folderName プロパティを指定する必要があります。 それ以外の場合、報告されたメッセージはメールボックスの Junk Email フォルダーに移動されます。 postProcessingAction が moveToCustomFolder 以外の別のアクションに設定されている場合、folderName プロパティは無視されます。

moveItemTo

completed メソッドを使用して、報告されたメッセージの処理が完了したことを通知する場合、このプロパティは、メッセージをメールボックス内の別のフォルダーに移動するかどうかを指定します。

moveItemTo?: MailboxEnums.MoveSpamItemTo;

プロパティ値

Office.MailboxEnums.MoveSpamItemTo

注釈

API セット: メールボックス 1.14

最小アクセス許可レベル (Outlook): アイテムの読み取り

適用可能な Outlook モード: メッセージの読み取り

重要:

  • このプロパティは、Outlook on the web、Windows (新しいものと従来の (バージョン 2308、ビルド 16724.10000 以降))、および Mac のスパム報告アドインでのみ使用できます。 統合されたスパム報告機能をサポートしている Windows 上の従来の Outlook の以前のビルドを使用している場合は、代わりに postProcessingAction プロパティを使用してください。

  • プロパティが Office.MailboxEnums.MoveSpamItemTo.CustomFolder に設定されている場合は、event.completed呼び出しの folderName プロパティでメッセージの移動先フォルダーの名前を指定する必要があります。 それ以外の場合、moveItemTo プロパティは既定で Office.MailboxEnums.MoveSpamItemTo.JunkFolder になり、報告されたメッセージは迷惑メール Email フォルダーに移動します。

  • ユーザーが前処理ダイアログで [レポート] オプションを選択した後で作業ウィンドウを開くように event.completed 呼び出しの commandId オプションと contextData オプションを構成する場合は、moveItemTo オプションを [Office.MailboxEnums.MoveSpamItemTo.NoMove] に設定する必要があります。 それ以外の場合、作業ウィンドウは開きません。

onErrorDeleteItem

true に設定すると、メッセージの処理中にエラーが発生した場合に、報告されたメッセージを削除します。 このプロパティが false に設定されているか、 completed メソッド で指定されていない場合、報告されたメッセージは現在のメールボックス フォルダーに残ります。

onErrorDeleteItem?: boolean;

プロパティ値

boolean

注釈

API セット: メールボックス 1.14

最小アクセス許可レベル (Outlook): アイテムの読み取り

適用可能な Outlook モード: メッセージの読み取り

postProcessingAction

completed メソッドを使用して、報告されたメッセージの処理が完了したことを通知する場合、このプロパティは、メッセージをメールボックス内の別のフォルダーに移動するかどうかを指定します。 次の後処理アクションを使用できます。

  • delete - 報告されたメッセージをメールボックスの [削除済みアイテム ] フォルダーに移動します。

  • moveToCustomFolder - 報告されたメッセージを指定したフォルダーに移動します。 folderName プロパティでフォルダーの名前を指定する必要があります。

  • moveToSpamFolder- 報告されたメッセージをメールボックスの [Junk Email] フォルダーに移動します。

  • noMove - 報告されたメッセージを現在のフォルダーに残します。

postProcessingAction?: string;

プロパティ値

string

注釈

API セット: メールボックス 1.14

最小アクセス許可レベル (Outlook): アイテムの読み取り

適用可能な Outlook モード: メッセージの読み取り

重要:

  • Windows 上の Outlook では、統合されたスパム報告機能をサポートする以前のビルドでのみ、このプロパティを使用できます。 バージョン 2308 (ビルド 16724.10000) 以降を使用している場合は、代わりに moveItemTo プロパティを使用してください。

  • このプロパティは、Outlook on the web、Mac、または新しい Outlook on Windows ではサポートされていません。 代わりに、 moveItemTo プロパティを使用してください。

  • プロパティが moveToCustomFolder に設定されている場合は、event.completed呼び出しの folderName プロパティでメッセージの移動先フォルダーの名前を指定する必要があります。 それ以外の場合、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 モード: メッセージの読み取り

重要: ユーザーが前処理ダイアログから [レポート] オプションを選択した後に作業ウィンドウを開くように event.completed 呼び出しでcommandIdとcontextDataオプションを構成すると、後処理ダイアログはユーザーに表示されません。 この動作は、event.completed呼び出しでshowPostProcessingDialogが指定されている場合でも適用されます。