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

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

注:

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

1.8 の新機能

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

  • 作成モードで添付ファイルのコンテンツを取得するメソッド、またはアイテムのすべての添付ファイルを取得するメソッドを追加しました。 詳細については、「 Outlook の作成フォームでアイテムの添付ファイルを管理する」を参照してください。
  • Base64 でエンコードされた文字列を使用して、ファイルを添付ファイルとして追加するメソッドを追加しました。
  • アイテムとメールボックスのマスター カテゴリ リストの カテゴリ を管理するためのプロパティとメソッドを追加しました。
  • 共有プロパティを取得するメソッドや、共有フォルダー内のアドインを有効にするマニフェスト要素など、 代理人アクセス シナリオのサポートが追加されました。
  • 予定の場所のセットを管理するオブジェクトを追加しました。 詳細については、「 Outlook で予定を作成するときに場所を取得または設定する」を参照してください。
  • 作成モードでメッセージ アイテムの カスタム インターネット ヘッダー を取得して設定するオブジェクトを追加しました。
  • 読み取りモードでメッセージ アイテムのすべてのインターネット ヘッダーを取得するメソッドを追加しました。
  • アクション可能なメッセージによってアドインがアクティブ化されたときに渡される初期化データを取得するメソッドを追加しました。
  • 保存した予定またはメッセージ アイテムの ID を取得するメソッドを追加しました。
  • イベントの実行を取り消すために、省略可能な options パラメーターを event.completed 呼び出しに追加しました。
  • 添付ファイルが追加または削除されたとき、および予定の場所が変更されたときに発生するイベントを追加しました。

API リスト

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

クラス フィールド 説明
AppointmentCompose addFileAttachmentFromBase64Async(base64File: string, attachmentName: string, callback?: (asyncResult: Office.AsyncResult<string>) => void) ファイルを添付ファイルとしてメッセージまたは予定に追加します。
addFileAttachmentFromBase64Async(base64File: string, attachmentName: string, options: Office.AsyncContextOptions & { isInline: boolean }, callback?: (asyncResult: Office.AsyncResult<string>) => void) ファイルを添付ファイルとしてメッセージまたは予定に追加します。
categories 項目のカテゴリを管理するためのメソッドを提供するオブジェクトを取得します。
enhancedLocation 予定の場所を取得または設定します。
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) アイテムの添付ファイルを配列として取得します。
getInitializationContextAsync(callback: (asyncResult: Office.AsyncResult<string>) => void) アクション可能なメッセージによってアドインがアクティブ化されたときに渡される初期化データを取得します。
getInitializationContextAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void) アクション可能なメッセージによってアドインがアクティブ化されたときに渡される初期化データを取得します。
getItemIdAsync(callback: (asyncResult: Office.AsyncResult<string>) => void) Exchange Web サービス (EWS) の項目識別子を非同期的に取得します。
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) 共有フォルダーまたは共有メールボックス内の予定またはメッセージのプロパティを取得します。
AppointmentRead categories 項目のカテゴリを管理するためのメソッドを提供するオブジェクトを取得します。
enhancedLocation 予定の場所を取得します。
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) アクション可能なメッセージによってアドインがアクティブ化されたときに渡される初期化データを取得します。
getSharedPropertiesAsync(callback: (asyncResult: Office.AsyncResult<SharedProperties>) => void) 共有フォルダーまたは共有メールボックス内の予定またはメッセージのプロパティを取得します。
getSharedPropertiesAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<SharedProperties>) => void) 共有フォルダーまたは共有メールボックス内の予定またはメッセージのプロパティを取得します。
AttachmentContent content 添付ファイルの内容。文字列です。
format 添付ファイルのコンテンツに使用する文字列形式。
AttachmentDetailsCompose attachmentType 添付ファイルの種類を示す値を取得します。
id 添付ファイルの識別子を取得します。
isInline 添付ファイルが添付ファイル リストではなくアイテムの本文に画像として表示されるかどうかを示す値を取得します。
isServiceAccessible Outlook on the web と新しい Outlook on Windows で、メッセージ内のインライン添付ファイルがサーバーにアップロードされ、Exchange Web サービス (EWS) ID が割り当てられているかどうかを示します。
name 添付ファイルの名前を取得します。
size 添付ファイルのサイズをバイト単位で取得します。
url 添付ファイルの種類が MailboxEnums.AttachmentType.Cloud の場合、添付ファイルの URL を取得します。
AttachmentsChangedEventArgs attachmentDetails 追加または削除された添付ファイルを表すオブジェクトを取得します
attachmentStatus 添付ファイルがメール アイテムに追加されたか、削除されたかを指定します。
type 発生したイベントの種類を取得します。
Categories addAsync(categories: string[], callback?: (asyncResult: Office.AsyncResult<void>) => void) アイテムにカテゴリを追加します。
addAsync(categories: string[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) アイテムにカテゴリを追加します。
getAsync(callback: (asyncResult: Office.AsyncResult<CategoryDetails[]>) => void) 項目のカテゴリを取得します。
getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<CategoryDetails[]>) => void) 項目のカテゴリを取得します。
removeAsync(categories: string[], callback?: (asyncResult: Office.AsyncResult<void>) => void) アイテムからカテゴリを削除します。
removeAsync(categories: string[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) アイテムからカテゴリを削除します。
CategoryDetails color カテゴリの色。
displayName カテゴリの名前。
EnhancedLocation addAsync(locationIdentifiers: LocationIdentifier[], callback?: (asyncResult: Office.AsyncResult<void>) => void) 予定に関連付けられている場所のセットに追加します。
addAsync(locationIdentifiers: LocationIdentifier[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) 予定に関連付けられている場所のセットに追加します。
getAsync(callback?: (asyncResult: Office.AsyncResult<LocationDetails[]>) => void) 予定に関連付けられている場所のセットを取得します。
getAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<LocationDetails[]>) => void) 予定に関連付けられている場所のセットを取得します。
removeAsync(locationIdentifiers: LocationIdentifier[], callback?: (asyncResult: Office.AsyncResult<void>) => void) 予定に関連付けられている場所のセットを削除します。
removeAsync(locationIdentifiers: LocationIdentifier[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) 予定に関連付けられている場所のセットを削除します。
EnhancedLocationsChangedEventArgs enhancedLocations 拡張された場所のセットを取得します。
type イベントの種類を取得します。
InternetHeaders getAsync(names: string[], callback: (asyncResult: Office.AsyncResult<Record<string, string>>) => void) インターネット ヘッダー名の配列を指定すると、このメソッドは、それらのインターネット ヘッダーとその値を含むレコードを返します。
getAsync(names: string[], options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<Record<string, string>>) => void) インターネット ヘッダー名の配列を指定すると、このメソッドは、それらのインターネット ヘッダーとその値を含むレコードを返します。
removeAsync(names: string[], callback?: (asyncResult: Office.AsyncResult<void>) => void) インターネット ヘッダー名の配列を指定すると、このメソッドは、指定されたヘッダーをインターネット ヘッダー コレクションから削除します。
removeAsync(names: string[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) インターネット ヘッダー名の配列を指定すると、このメソッドは、指定されたヘッダーをインターネット ヘッダー コレクションから削除します。
setAsync(headers: Record<string, string>, callback?: (asyncResult: Office.AsyncResult<void>) => void) 指定したインターネット ヘッダーを指定した値に設定します。
setAsync(headers: Record<string, string>, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) 指定したインターネット ヘッダーを指定した値に設定します。
LocationDetails displayName 場所の表示名。
emailAddress 場所に関連付けられているメール アドレス。
locationIdentifier 場所の LocationIdentifier 。
LocationIdentifier id 場所の一意の ID。
type 場所の種類。
メールボックス masterCategories メールボックスに関連付けられているカテゴリ マスター リストを管理するメソッドを提供するオブジェクトを取得します。
MasterCategories addAsync(categories: CategoryDetails[], callback?: (asyncResult: Office.AsyncResult<void>) => void) メールボックスのマスター リストにカテゴリを追加します。
addAsync(categories: CategoryDetails[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) メールボックスのマスター リストにカテゴリを追加します。
getAsync(callback: (asyncResult: Office.AsyncResult<CategoryDetails[]>) => void) メールボックス上のカテゴリのマスター リストを取得します。
getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<CategoryDetails[]>) => void) メールボックス上のカテゴリのマスター リストを取得します。
removeAsync(categories: string[], callback?: (asyncResult: Office.AsyncResult<void>) => void) メールボックスのマスター リストからカテゴリを削除します。
removeAsync(categories: string[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) メールボックスのマスター リストからカテゴリを削除します。
MessageCompose addFileAttachmentFromBase64Async(base64File: string, attachmentName: string, callback?: (asyncResult: Office.AsyncResult<string>) => void) ファイルを添付ファイルとしてメッセージまたは予定に追加します。
addFileAttachmentFromBase64Async(base64File: string, attachmentName: string, options: Office.AsyncContextOptions & { isInline: boolean }, callback?: (asyncResult: Office.AsyncResult<string>) => void) ファイルを添付ファイルとしてメッセージまたは予定に追加します。
categories 項目のカテゴリを管理するためのメソッドを提供するオブジェクトを取得します。
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) アイテムの添付ファイルを配列として取得します。
getInitializationContextAsync(callback: (asyncResult: Office.AsyncResult<string>) => void) アクション可能なメッセージによってアドインがアクティブ化されたときに渡される初期化データを取得します。
getInitializationContextAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void) アクション可能なメッセージによってアドインがアクティブ化されたときに渡される初期化データを取得します。
getItemIdAsync(callback: (asyncResult: Office.AsyncResult<string>) => void) Exchange Web サービス (EWS) の項目識別子を非同期的に取得します。
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) 共有フォルダーまたは共有メールボックス内の予定またはメッセージのプロパティを取得します。
internetHeaders メッセージのカスタム インターネット ヘッダーを取得または設定します。
MessageRead categories 項目のカテゴリを管理するためのメソッドを提供するオブジェクトを取得します。
getAllInternetHeadersAsync(callback?: (asyncResult: Office.AsyncResult<string>) => void) メッセージのすべてのインターネット ヘッダーを文字列として取得します。
getAllInternetHeadersAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<string>) => void) メッセージのすべてのインターネット ヘッダーを文字列として取得します。
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) アクション可能なメッセージによってアドインがアクティブ化されたときに渡される初期化データを取得します。
getSharedPropertiesAsync(callback: (asyncResult: Office.AsyncResult<SharedProperties>) => void) 共有フォルダーまたは共有メールボックス内の予定またはメッセージのプロパティを取得します。
getSharedPropertiesAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<SharedProperties>) => void) 共有フォルダーまたは共有メールボックス内の予定またはメッセージのプロパティを取得します。
AttachmentContentFormat Base64 添付ファイルの内容は、Base64 でエンコードされた文字列として返されます。
Eml 添付ファイルの内容は、.eml形式のファイルを表す文字列として返されます。
ICalendar 添付ファイルの内容は、.icalendar 形式のファイルを表す文字列として返されます。
Url 添付ファイルの内容は、URL を表す文字列として返されます。
AttachmentStatus 追加済み 添付ファイルがアイテムに追加されました。
削除 添付ファイルがアイテムから削除されました。
CategoryColor なし 既定の色またはカラー マップなし。
Preset0 赤
Preset1 Orange
Preset10 鋼色
Preset11 DarkSteel
Preset12 灰色
Preset13 DarkGray
Preset14 黒
Preset15 DarkRed
Preset16 DarkOrange
Preset17 DarkBrown
Preset18 DarkYellow
Preset19 DarkGreen
Preset2 茶
Preset20 DarkTeal
Preset21 DarkOlive
Preset22 DarkBlue
Preset23 DarkPurple
Preset24 DarkCranberry
Preset3 黄
Preset4 緑
Preset5 青緑
Preset6 オリーブ
Preset7 青
Preset8 紫
Preset9 深紅
DelegatePermissions DeleteAll 代理人には、すべてのアイテムを削除するアクセス許可があります。
DeleteOwn 代理人には、作成したアイテムのみを削除するアクセス許可があります。
EditAll 代理人には、任意のアイテムを編集するアクセス許可があります。
EditOwn 代理人には、自分が作成したアイテムのみを編集するアクセス許可があります。
読み取り 代理人にはアイテムの読み取りアクセス許可があります。
書き込み 代理人には、アイテムの作成と書き込みを行うアクセス許可があります。
LocationType Custom カスタムの場所。
Room SMTP アドレスを持つ会議室または同様のリソース。
SharedProperties delegatePermissions 代理人が共有フォルダーに持っているアクセス許可、またはユーザーが共有メールボックスに持っているアクセス許可。
owner 共有アイテムの所有者のメール アドレス。
targetMailbox 代理人がアクセスできる所有者のメールボックスの場所。
targetRestUrl REST API のベース URL (現在は https://outlook.office.com/api)。

イベント

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

イベント 説明 オブジェクト
AttachmentsChanged アイテムに添付ファイルが追加またはアイテムから削除されました。 アイテム
EnhancedLocationsChanged 予定場所が変更されました。 アイテム

マニフェストの更新

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

機能 Microsoft 365 の統合マニフェスト アドインのみのマニフェスト 説明
共有フォルダーのサポート "authorization.permissions.resourceSpecific.name" 次に設定: "Mailbox.SharedFolder" SupportsSharedFolders 共有フォルダーのシナリオでアドインを使用できるかどうかを定義します。

関連項目

  • Last updated on