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

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

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

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

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

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

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

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

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

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

プロパティの詳細

folderName

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

folderName?: string;

プロパティ値

string

注釈

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

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

適用される Outlook モード: メッセージの読み取り

重要:

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

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

moveItemTo

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

moveItemTo?: MailboxEnums.MoveSpamItemTo;

プロパティ値

Office.MailboxEnums.MoveSpamItemTo

注釈

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

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

適用される Outlook モード: メッセージの読み取り

重要:

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

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

onErrorDeleteItem

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

onErrorDeleteItem?: boolean;

プロパティ値

boolean

注釈

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

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

適用される Outlook モード: メッセージの読み取り

postProcessingAction

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

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

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

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

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

postProcessingAction?: string;

プロパティ値

string

注釈

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

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

適用される Outlook モード: メッセージの読み取り

重要:

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

  • このプロパティは、Outlook on the web、Mac、または新しい Outlook on 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

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

showPostProcessingDialog?: object;

プロパティ値

object

注釈

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

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

適用される Outlook モード: メッセージの読み取り

重要: Outlook on the webまたは新しい Outlook on Windows (プレビュー) では、アドインが報告されたメッセージの処理を完了すると、後処理ダイアログは表示されません。 これは、構成されている場合 showPostProcessingDialog でも適用されます。 ただし、呼び出しでevent.completedプロパティをmoveItemTo構成した方法に応じて、報告されたメッセージがメールボックス内の別のフォルダーに削除または移動されたときに通知が表示されます。 詳細については、「 統合スパムレポート アドインを実装する」の「機能の動作と制限事項を確認する」セクションを参照してください。