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

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

注:

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

1.15 の新機能

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

API リスト

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

クラス フィールド 説明
AppointmentCompose sendAsync(callback?: (asyncResult: Office.AsyncResult<void>) => void) 作成中の予定を送信します。
sendAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) 作成中の予定を送信します。
InitializationContextChangedEventArgs initializationContextData アクション可能なメッセージ、通知メッセージ、スマート アラート ダイアログ、または統合からアドインの作業ウィンドウに渡されるデータを表します
type イベントの種類を表します。
LoadedMessageCompose bcc メッセージの BCC (ブラインド カーボン コピー) 行の受信者を取得します。
body 項目の本文と形式を取得します。
categories 項目のカテゴリを管理するメソッドを提供するオブジェクトを取得します。
cc メッセージの Cc (カーボン コピー) 行の受信者を取得します。
conversationId 特定のメッセージが含まれている電子メールの会話の識別子を取得します。
delayDeliveryTime メッセージの遅延配信日時を取得します。
from メッセージの送信者の電子メール アドレスを取得します。
getAttachmentContentAsync(attachmentId: string, callback?: (asyncResult: Office.AsyncResult<AttachmentContent>) => void) メッセージまたは予定から添付ファイルを取得し、 AttachmentContent オブジェクトとして返します。
getAttachmentContentAsync(attachmentId: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<AttachmentContent>) => void) メッセージまたは予定から添付ファイルを取得し、 AttachmentContent オブジェクトとして返します。
getAttachmentsAsync(callback?: (asyncResult: Office.AsyncResult<AttachmentDetailsCompose[]>) => void) アイテムの添付ファイルを配列として取得します。
getAttachmentsAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<AttachmentDetailsCompose[]>) => void) アイテムの添付ファイルを配列として取得します。
getComposeTypeAsync(callback: (asyncResult: Office.AsyncResult) => void) メッセージ作成の種類とその強制の種類を指定します。
getComposeTypeAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void) メッセージ作成の種類とその強制の種類を指定します。
getConversationIndexAsync(callback: (asyncResult: Office.AsyncResult<string>) => void) Base64 でエンコードされたスレッド内の現在のメッセージの位置を取得します。
getConversationIndexAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void) Base64 でエンコードされたスレッド内の現在のメッセージの位置を取得します。
getInitializationContextAsync(callback: (asyncResult: Office.AsyncResult<string>) => void) アクション可能なメッセージによってアドインがアクティブ化されたときに渡される初期化データを取得します。
getInitializationContextAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void) アクション可能なメッセージによってアドインがアクティブ化されたときに渡される初期化データを取得します。
getItemClassAsync(callback: (asyncResult: Office.AsyncResult<string>) => void) 選択したメッセージの Exchange Web サービス項目クラスを取得します。
getItemClassAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void) 選択したメッセージの Exchange Web サービス項目クラスを取得します。
getItemIdAsync(callback: (asyncResult: Office.AsyncResult<string>) => void) 保存された項目の ID を非同期で取得します。
getItemIdAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void) Exchange Web サービス (EWS) の項目識別子を非同期的に取得します。
getSharedPropertiesAsync(callback: (asyncResult: Office.AsyncResult<SharedProperties>) => void) 共有フォルダーまたは共有メールボックス内の予定またはメッセージのプロパティを取得します。
getSharedPropertiesAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<SharedProperties>) => void) 共有フォルダーまたは共有メールボックス内の予定またはメッセージのプロパティを取得します。
inReplyTo 現在のメッセージから返信される元のメッセージのメッセージ ID を取得します。
internetHeaders メッセージのカスタム インターネット ヘッダーを取得します。
isClientSignatureEnabledAsync(callback: (asyncResult: Office.AsyncResult<boolean>) => void) クライアント署名が有効になっているかどうかを取得します。
isClientSignatureEnabledAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<boolean>) => void) クライアント署名が有効になっているかどうかを取得します。
itemType インスタンスが表しているアイテムの種類を取得します。
loadCustomPropertiesAsync(callback: (asyncResult: Office.AsyncResult<CustomProperties>) => void, userContext?: any) 選択されたアイテムのこのアドインのカスタム プロパティを非同期に読み込みます。
notificationMessages 項目の通知メッセージを取得します。
saveAsync(callback: (asyncResult: Office.AsyncResult<string>) => void) 現在のメッセージを下書きとして非同期に保存します。
saveAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void) 現在のメッセージを下書きとして非同期に保存します。
sensitivityLabel メッセージの秘密度ラベルを取得します。
seriesId インスタンスが属するシリーズの ID を取得します。
subject アイテムの [件名] フィールドに表示される説明を取得します。
to メッセージの To 行の受信者を取得します。
unloadAsync(callback?: (asyncResult: Office.AsyncResult<void>) => void) 複数のメール アイテムを選択している場合は、現在読み込まれているアイテムを閉じて、選択した別のメール アイテムを処理対象として読み込むことができます。
unloadAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) 複数のメール アイテムを選択している場合は、現在読み込まれているアイテムを閉じて、選択した別のメール アイテムを処理対象として読み込むことができます。
LoadedMessageRead attachments アイテムの添付ファイルを配列として取得します。
body アイテムの本文と形式を取得します。
categories 項目のカテゴリを管理するメソッドを提供するオブジェクトを取得します。
cc メッセージの Cc (カーボン コピー) 行の受信者を取得します。
conversationId 特定のメッセージが含まれている電子メールの会話の識別子を取得します。
dateTimeCreated アイテムが作成された日時を取得します。
dateTimeModified アイテムが最後に変更された日時を取得します。
displayReplyAllFormAsync(formData: string |ReplyFormData, callback?: (asyncResult: Office.AsyncResult<void>) => void) 選択したメッセージの送信者とすべての受信者、またはメッセージの開催者とすべての出席者を含む返信フォームを表示します
displayReplyAllFormAsync(formData: string |ReplyFormData, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) 選択したメッセージの送信者とすべての受信者、またはメッセージの開催者とすべての出席者を含む返信フォームを表示します
displayReplyFormAsync(formData: string |ReplyFormData, callback?: (asyncResult: Office.AsyncResult<void>) => void) 選択したメッセージの送信者のみ、または選択した予定の開催者のみを含む回答フォームが表示されます。
displayReplyFormAsync(formData: string |ReplyFormData, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) 選択したメッセージの送信者のみ、または選択した予定の開催者のみを含む回答フォームが表示されます。
end 予定を終了する日時を取得します。
from メッセージの送信者の電子メール アドレスを取得します。
getAllInternetHeadersAsync(callback?: (asyncResult: Office.AsyncResult<string>) => void) メッセージのすべてのインターネット ヘッダーを文字列として取得します。
getAllInternetHeadersAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<string>) => void) メッセージのすべてのインターネット ヘッダーを文字列として取得します。
getAsFileAsync(callback: (asyncResult: Office.AsyncResult<string>) => void) Base64 でエンコードされた EML 形式で現在のメッセージを取得します。
getAsFileAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void) Base64 でエンコードされた EML 形式で現在のメッセージを取得します。
getAttachmentContentAsync(attachmentId: string, callback?: (asyncResult: Office.AsyncResult<AttachmentContent>) => void) メッセージまたは予定から添付ファイルを取得し、 AttachmentContent オブジェクトとして返します。
getAttachmentContentAsync(attachmentId: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<AttachmentContent>) => void) メッセージまたは予定から添付ファイルを取得し、 AttachmentContent オブジェクトとして返します。
getInitializationContextAsync(callback: (asyncResult: Office.AsyncResult<string>) => void) アクション可能なメッセージによってアドインがアクティブ化されたときに渡される初期化データを取得します。
getInitializationContextAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void) アクション可能なメッセージによってアドインがアクティブ化されたときに渡される初期化データを取得します。
getRegExMatches() 選択した項目のうち、XML マニフェスト ファイルで定義されている正規表現に一致する文字列値を返します。
getRegExMatchesByName(name: string) 選択した項目のうち、XML マニフェスト ファイルで定義されている名前付き正規表現と一致する文字列値を返します。
getSelectedRegExMatches() XML マニフェスト ファイルで定義されている正規表現と一致する文字列値を強調表示した文字列値を返します。
getSharedPropertiesAsync(callback: (asyncResult: Office.AsyncResult<SharedProperties>) => void) 共有フォルダーまたは共有メールボックス内の予定またはメッセージのプロパティを取得します。
getSharedPropertiesAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<SharedProperties>) => void) 共有フォルダーまたは共有メールボックス内の予定またはメッセージのプロパティを取得します。
internetMessageId メッセージのインターネット メッセージ識別子を取得します。
itemClass 選択したメッセージの Exchange Web サービス項目クラスを取得します。
itemId Exchange Web サービスの項目識別子を取得します
itemType インスタンスが表しているアイテムの種類を取得します。
loadCustomPropertiesAsync(callback: (asyncResult: Office.AsyncResult<CustomProperties>) => void, userContext?: any) 選択されたアイテムのこのアドインのカスタム プロパティを非同期に読み込みます。
location 会議出席依頼の場所を取得します。
normalizedSubject すべてのプレフィックス (RE: と FWD:を含む) を削除したアイテムの件名を取得します。
notificationMessages 項目の通知メッセージを取得します。
繰り返し 予定の繰り返しパターンを取得します。
sender 電子メール メッセージの送信者の電子メール アドレスを取得します。
seriesId インスタンスが属するシリーズの ID を取得します。
start 予定を開始する日時を取得します。
subject アイテムの [件名] フィールドに表示される説明を取得します。
to メッセージの To 行の受信者を取得します。
unloadAsync(callback?: (asyncResult: Office.AsyncResult<void>) => void) 複数のメール アイテムを選択している場合は、現在読み込まれているアイテムを閉じて、選択した別のメール アイテムを処理対象として読み込むことができます。
unloadAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) 複数のメール アイテムを選択している場合は、現在読み込まれているアイテムを閉じて、選択した別のメール アイテムを処理対象として読み込むことができます。
メールボックス loadItemByIdAsync(itemId: string, callback: (asyncResult: Office.AsyncResult<LoadedMessageCompose |LoadedMessageRead>) => void) Exchange Web サービス (EWS) ID で 1 つのメール アイテムを読み込みます。
loadItemByIdAsync(itemId: string, options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<LoadedMessageCompose |LoadedMessageRead>) => void) Exchange Web サービス (EWS) ID で 1 つのメール アイテムを読み込みます。
MessageCompose sendAsync(callback?: (asyncResult: Office.AsyncResult<void>) => void) 作成中のメッセージを送信します。
sendAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) 作成中のメッセージを送信します。
AttachmentType Base64 添付ファイルは Base64 でエンコードされたファイルです。
ReplyFormAttachment base64file 添付するファイルの Base64 エンコード文字列。
SmartAlertsEventCompletedOptions errorMessageMarkdown completed メソッドを使用してイベント ハンドラーの完了を通知する場合
SpamReportingEventCompletedOptions commandId completed メソッドを使用して、報告されたメッセージの処理が完了したことを通知する場合、
contextData completed メソッドを使用して、報告されたメッセージの処理が完了したことを通知する場合、

イベント

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

イベント 説明 オブジェクト
InitializationContextChanged アクション可能なメッセージ、 InsightMessage 通知、スマート アラートのダイアログ、または統合されたスパム報告ダイアログからアドインの作業ウィンドウが開かれました。 アイテム

注:

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

マニフェストの更新

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

機能 Microsoft 365 の統合マニフェスト アドインのみのマニフェスト 説明
スパム レポート作成 "extensions.ribbons.spamPreProcessingDialog.spamReportingOptions.type" ReportingOptions 統合されたスパム報告アドインの前処理ダイアログでラジオ ボタンのサポートが追加されました。
スパム レポート作成 "extensions.ribbons.spamPreProcessingDialog.spamNeverShowAgainOption" PreProcessingDialog 統合されたスパム報告アドインの前処理ダイアログで、[今後このメッセージを表示しない] チェックボックスのサポートが追加されました。

関連項目

  • Last updated on