Office.SpamReportingEventCompletedOptions interface
SpamReporting イベントの処理が完了した後の統合スパムレポート アドインの動作を指定します。
注釈
最小アクセス許可レベル: 読み取り項目
適用できる 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.",
},
});
});
}
プロパティ
| command |
完了したメソッドを使用して、報告されたメッセージの処理が完了したことを通知する場合、このプロパティは、メッセージの処理後に開く作業ウィンドウの ID を指定します。 |
| context |
完了したメソッドを使用して、報告されたメッセージの処理が完了したことを通知する場合、このプロパティは、メッセージの処理後にアドインの作業ウィンドウに渡されるすべての JSON データを指定します。 |
| folder |
完了したメソッドを使用して、報告されたメッセージの処理が完了したことを通知する場合、このプロパティは、メッセージの移動先となる Outlook メールボックス フォルダーを指定します。 |
| move |
完了したメソッドを使用して、報告されたメッセージの処理が完了したことを通知する場合、このプロパティは、メッセージをメールボックス内の別のフォルダーに移動するかどうかを指定します。 |
| on |
|
| post |
完了したメソッドを使用して、報告されたメッセージの処理が完了したことを通知する場合、このプロパティは、メッセージをメールボックス内の別のフォルダーに移動するかどうかを指定します。 次の後処理アクションを使用できます。
|
| show |
完了したメソッドを使用して、報告されたメッセージの処理が完了したことを通知すると、このプロパティは、後処理ダイアログがユーザーに表示されるかどうかを示します。 このプロパティに割り当てられた JSON オブジェクトには、タイトルと説明が含まれている必要があります。 このプロパティが指定されていない場合、報告されたメッセージが処理されると、ダイアログはユーザーに表示されません。 |
プロパティの詳細
commandId
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
完了したメソッドを使用して、報告されたメッセージの処理が完了したことを通知する場合、このプロパティは、メッセージの処理後に開く作業ウィンドウの ID を指定します。
commandId?: string;プロパティ値
string
注釈
最小アクセス許可レベル (Outlook): アイテムの読み取り
適用できる Outlook モード: メッセージの読み取り
重要:
commandIdオプションは現在、Outlook on the webと Windows (新規およびクラシック) でプレビュー段階にあります。 従来の Outlook on Windows でこの機能をプレビューするには、バージョン 2411 (ビルド 18227.20034) 以降をインストールします。 次に、 Microsoft 365 Insider プログラム に参加し、[ ベータ チャネル ] オプションを選択します。 スパム レポート アドインでこれを実装する方法については、「 メッセージを報告した後に作業ウィンドウを開く (プレビュー)」を参照してください。commandId値は、アドインのマニフェストで指定された作業ウィンドウ ID と一致する必要があります。 アドインのみのマニフェストでは、作業ウィンドウを表す Control 要素のid属性に ID が指定されます。commandIdプロパティは、Microsoft 365 の統合マニフェストを使用するスパム報告アドインでは現在サポートされていません。event.completed呼び出しでcommandIdオプションを構成した場合、呼び出しでshowPostProcessingDialogオプションが指定されていても、後処理ダイアログはユーザーに表示されません。報告されたメッセージが処理された後に開く作業ウィンドウを実装した場合、
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
});
}
contextData
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
完了したメソッドを使用して、報告されたメッセージの処理が完了したことを通知する場合、このプロパティは、メッセージの処理後にアドインの作業ウィンドウに渡されるすべての JSON データを指定します。
contextData?: any;プロパティ値
any
注釈
最小アクセス許可レベル (Outlook): アイテムの読み取り
適用できる Outlook モード: メッセージの読み取り
重要:
contextDataオプションは現在、Outlook on the webと Windows (新規およびクラシック) でプレビュー段階にあります。 従来の Outlook on Windows でこの機能をプレビューするには、バージョン 2411 (ビルド 18227.20034) 以降をインストールします。 次に、 Microsoft 365 Insider プログラム に参加し、[ ベータ チャネル ] オプションを選択します。 スパム レポート アドインでこれを実装する方法については、「 メッセージを報告した後に作業ウィンドウを開く (プレビュー)」を参照してください。event.completed呼び出しで [contextData] オプションを指定する場合は、作業ウィンドウ ID もcommandIdオプションに割り当てる必要があります。 それ以外の場合、contextDataに割り当てられた JSON データは無視されます。event.completed呼び出しでcommandIdオプションとcontextDataオプションを構成した場合、呼び出しでshowPostProcessingDialogオプションが指定されていても、後処理ダイアログはユーザーに表示されません。報告されたメッセージが処理された後に開く作業ウィンドウを実装した場合、
event.completed呼び出しが発生すると、開いている作業ウィンドウまたはピン留めされた作業ウィンドウはすべて閉じられます。contextDataプロパティの値を取得するには、作業ウィンドウの JavaScript 実装でOffice.context.mailbox.item.getInitializationContextAsyncを呼び出す必要があります。JSON.stringify()を使用して JSON 文字列を作成し、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
});
}
folderName
完了したメソッドを使用して、報告されたメッセージの処理が完了したことを通知する場合、このプロパティは、メッセージの移動先となる Outlook メールボックス フォルダーを指定します。
folderName?: string;プロパティ値
string
注釈
最小アクセス許可レベル (Outlook): アイテムの読み取り
適用できる Outlook モード: メッセージの読み取り
重要:
指定したフォルダーがまだ存在しない場合は、メッセージが移動される前に作成されます。
postProcessingActionプロパティがmoveToCustomFolderに設定されている場合は、folderNameプロパティを指定する必要があります。 それ以外の場合、報告されたメッセージはメールボックスの [迷惑メール] Email フォルダーに移動されます。postProcessingActionがmoveToCustomFolder以外の別のアクションに設定されている場合、folderNameプロパティは無視されます。
moveItemTo
完了したメソッドを使用して、報告されたメッセージの処理が完了したことを通知する場合、このプロパティは、メッセージをメールボックス内の別のフォルダーに移動するかどうかを指定します。
moveItemTo?: MailboxEnums.MoveSpamItemTo;プロパティ値
注釈
最小アクセス許可レベル (Outlook): アイテムの読み取り
適用できる Outlook モード: メッセージの読み取り
重要:
このプロパティは、Outlook on the webのスパム報告アドイン、Windows (バージョン 2308、ビルド 16724.10000 以降) および Mac でのみ使用できます。 統合されたスパムレポート機能をサポートする従来の Outlook on Windows の以前のビルドを使用している場合は、代わりに
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 に設定されているか、完了したメソッドで指定されていない場合、報告されたメッセージは現在のメールボックス フォルダーに残ります。
onErrorDeleteItem?: boolean;プロパティ値
boolean
注釈
最小アクセス許可レベル (Outlook): アイテムの読み取り
適用できる Outlook モード: メッセージの読み取り
postProcessingAction
完了したメソッドを使用して、報告されたメッセージの処理が完了したことを通知する場合、このプロパティは、メッセージをメールボックス内の別のフォルダーに移動するかどうかを指定します。 次の後処理アクションを使用できます。
delete- 報告されたメッセージをメールボックスの [削除済みアイテム] フォルダーに移動します。moveToCustomFolder- 報告されたメッセージを指定したフォルダーに移動します。folderNameプロパティでフォルダーの名前を指定する必要があります。moveToSpamFolder- 報告されたメッセージをメールボックスの迷惑メール Email フォルダーに移動します。noMove- 報告されたメッセージを現在のフォルダーに残します。
postProcessingAction?: string;プロパティ値
string
注釈
最小アクセス許可レベル (Outlook): アイテムの読み取り
適用できる Outlook モード: メッセージの読み取り
重要:
Outlook on Windows では、このプロパティは、統合されたスパムレポート機能をサポートする以前のビルドでのみ使用できます。 バージョン 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
完了したメソッドを使用して、報告されたメッセージの処理が完了したことを通知すると、このプロパティは、後処理ダイアログがユーザーに表示されるかどうかを示します。 このプロパティに割り当てられた JSON オブジェクトには、タイトルと説明が含まれている必要があります。 このプロパティが指定されていない場合、報告されたメッセージが処理されると、ダイアログはユーザーに表示されません。
showPostProcessingDialog?: object;プロパティ値
object
注釈
最小アクセス許可レベル (Outlook): アイテムの読み取り
適用できる Outlook モード: メッセージの読み取り
重要: ユーザーが前処理ダイアログから [レポート] オプションを選択した後に、event.completed呼び出しでcommandIdオプションとcontextDataオプションを構成して作業ウィンドウを開くと、後処理ダイアログはユーザーに表示されません。 この動作は、event.completed呼び出しでshowPostProcessingDialogが指定されている場合でも適用されます。
Office Add-ins