Outlook アドイン API 要件セット 1.14

Office JavaScript API の Outlook アドイン API サブセットには、Outlook アドインで使用できるオブジェクト、メソッド、プロパティ、およびイベントが含まれています。

注:

このドキュメントは、最新の要件セット以外の要件セットのためのものです。

1.14 の新機能

メールボックス要件セット 1.14 には、 要件セット 1.13 のすべての機能が含まれています。 次の機能が追加されました。

  • 統合されたスパム報告機能を追加しました。
  • メッセージの Base64 エンコードを取得するメソッドを追加しました。
  • アドインの JavaScript ランタイムの URL を取得するメソッドを追加しました。
  • ボタンのテキストをカスタマイズし、スマート アラート ダイアログの [送信しない] オプションの作業ウィンドウを構成するためのサポートが追加されました。
  • 実行時に スマート アラート アドインの送信モード オプションをオーバーライドするサポートが追加されました。
  • 作成モードでメッセージの追加のプロパティを取得するためのメンバーを追加しました。
  • 保存されていない変更を破棄するオプションを使用して、作成中の現在のメッセージを閉じるメソッドを追加しました。
  • アイテムの複数選択機能にメール アイテム プロパティを追加しました。
  • Outlook クライアントの現在の Office テーマを識別するためのサポートが追加されました。
  • 予定の 秘密度レベル を取得して設定するためのサポートが追加されました。

API リスト

次の表に、メールボックス要件セット 1.14 で導入された API を示します。 メールボックス要件セット 1.14 以前でサポートされているすべての API の API リファレンス ドキュメントを表示するには、「 Outlook API」を参照してください。

クラス フィールド 説明
AppointmentCompose 感度 予定の秘密度レベルを取得または設定します。
AppointmentRead 感度 予定の秘密度値を指定します。
MailboxEvent completed(options?: SmartAlertsEventCompletedOptions |SpamReportingEventCompletedOptions) イベント ベース アドイン、スパム報告アドイン、または暗号化解除アドインがイベントの処理を完了したことを示します。
MessageCompose closeAsync(callback?: (asyncResult: Office.AsyncResult<void>) => void) 現在作成中の新しいメッセージを閉じます。
closeAsync(options: Office.AsyncContextOptions & { discardItem: boolean }, callback?: (asyncResult: Office.AsyncResult<void>) => void) 保存されていない変更を破棄するオプションを設定して、作成中の現在のメッセージを閉じます。
getConversationIndexAsync(callback: (asyncResult: Office.AsyncResult<string>) => void) Base64 でエンコードされたスレッド内の現在のメッセージの位置を取得します。
getConversationIndexAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void) Base64 でエンコードされたスレッド内の現在のメッセージの位置を取得します。
getItemClassAsync(callback: (asyncResult: Office.AsyncResult<string>) => void) 選択したメッセージの Exchange Web サービス項目クラスを取得します。
getItemClassAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void) 選択したメッセージの Exchange Web サービス項目クラスを取得します。
inReplyTo 現在のメッセージから返信される元のメッセージのインターネット メッセージ ID を取得します。
MessageRead getAsFileAsync(callback: (asyncResult: Office.AsyncResult<string>) => void) Base64 でエンコードされた EML 形式で現在のメッセージを取得します。
getAsFileAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void) Base64 でエンコードされた EML 形式で現在のメッセージを取得します。
AppointmentSensitivityType 社外秘 アイテムを機密として扱います。
標準 アイテムは特別な処理を必要としません。
個人用 アイテムは個人用ものとして扱います。
プライベート アイテムはプライベートとして扱います。
MoveSpamItemTo CustomFolder 報告されたメッセージをメールボックス内のカスタム フォルダーに移動することを指定します。
DeletedItemsFolder 報告されたメッセージをメールボックスの [削除済みアイテム ] フォルダーに移動するように指定します。
JunkFolder 報告されたメッセージをメールボックスの [Junk Email] フォルダーに移動することを指定します。
NoMove 報告されたメッセージがメールボックスの現在のフォルダーに残ることを指定します。
SendModeOverride PromptUser メール アイテムがイベントに基づくアドインの条件を満たしていない場合に、スマート アラート ダイアログで [とにかく送信 ] オプションを提供します。
OfficeThemeChangedEventArgs officeTheme 更新された Office テーマを取得します。
type イベントの種類を取得します。
SelectedItemDetails conversationId 現在選択されているメッセージを含むメッセージ スレッドの識別子。
hasAttachment 現在選択されているメッセージに添付ファイルが含まれている場合は true を返します。
internetMessageId 現在選択されているメッセージのインターネット メッセージ識別子。
Sensitivity getAsync(callback: (asyncResult: Office.AsyncResult<MailboxEnums.AppointmentSensitivityType>) => void) 予定の秘密度レベルを取得します。
getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<MailboxEnums.AppointmentSensitivityType>) => void) 予定の秘密度レベルを取得します。
setAsync(sensitivity: MailboxEnums.AppointmentSensitivityType | string, callback?: (asyncResult: Office.AsyncResult<void>) => void) 予定の秘密度レベルを設定します。
setAsync(sensitivity: MailboxEnums.AppointmentSensitivityType | string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) 予定の秘密度レベルを設定します。
SmartAlertsEventCompletedOptions cancelLabel completed メソッドを使用してイベント ハンドラーの完了を通知し、その allowEvent プロパティを false に設定すると、
commandId completed メソッドを使用してイベント ハンドラーの完了を通知し、その allowEvent プロパティを false に設定すると、
contextData Completed メソッドを使用して
sendModeOverride completed メソッドを使用してイベント ハンドラーの完了を通知する場合
SpamReportingEventArgs freeText スパム報告アドインの前処理ダイアログでユーザーによって提供されたテキスト。
options スパム報告アドインの前処理ダイアログでユーザーが選択した各報告オプションの true を返します。
type 発生したイベントの種類。
SpamReportingEventCompletedOptions folderName completed メソッドを使用して、報告されたメッセージの処理が完了したことを通知する場合、
moveItemTo completed メソッドを使用して、報告されたメッセージの処理が完了したことを通知する場合、
onErrorDeleteItem true に設定すると、メッセージの処理中にエラーが発生した場合に、報告されたメッセージを削除します。
postProcessingAction completed メソッドを使用して、報告されたメッセージの処理が完了したことを通知する場合、
showPostProcessingDialog completed メソッドを使用して、報告されたメッセージの処理が完了したことを通知する場合、

イベント

次の表に、要件セット 1.14 で導入された イベント を示します。 addHandlerAsync メソッドと removeHandlerAsync メソッドを使用して処理できるサポートされているすべてのイベントの一覧については、「Office.EventType」を参照してください。

イベント 説明 オブジェクト
OfficeThemeChanged Outlook の Office テーマが変更されました。 Mailbox
SpamReporting 迷惑なメッセージが報告されます。 アイテム

注:

イベント ベースのアクティブ化アドインでサポートされているイベントについては、「 イベントを使用してアドインをアクティブ化する」を参照してください。

マニフェストの更新

次の表に、メールボックス要件セット 1.14 で導入されたマニフェストの更新プログラムを示します。 Office アドイン マニフェストの種類の詳細については、「 Office アドイン マニフェスト」を参照してください。

機能 Microsoft 365 の統合マニフェスト アドインのみのマニフェスト 説明
スパム レポート作成 "extensions.ribbons.contexts" を格納する配列 "spamReportingOverride" ReportPhishingCommandSurface Outlook リボンの目立つセクションでスパム報告アドインをアクティブにします。
スパム レポート作成 "extensions.ribbons.spamPreProcessingDialog" ReportPhishingCustomization スパム報告アドインのリボン ボタンと前処理ダイアログを構成します。

関連項目

  • Last updated on