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

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

注:

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

1.1 の新機能

メールボックス要件セット 1.1 には、Outlook でサポートされている 共通 API 要件セット がすべて含まれています。 次の機能が追加されました。

API リスト

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

クラス フィールド 説明
AppointmentCompose addFileAttachmentAsync(uri: string, attachmentName: string, callback?: (asyncResult: Office.AsyncResult<string>) => void) ファイルを添付ファイルとしてメッセージまたは予定に追加します。
addFileAttachmentAsync(uri: string, attachmentName: string, options: Office.AsyncContextOptions & { isInline: boolean }, callback?: (asyncResult: Office.AsyncResult<string>) => void) ファイルを添付ファイルとしてメッセージまたは予定に追加します。
addItemAttachmentAsync(itemId: any, attachmentName: string, callback?: (asyncResult: Office.AsyncResult<string>) => void) メッセージなどの Exchange アイテムを添付ファイルとして、メッセージまたは予定に追加します。
addItemAttachmentAsync(itemId: any, attachmentName: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<string>) => void) メッセージなどの Exchange アイテムを添付ファイルとして、メッセージまたは予定に追加します。
body アイテムの本文を操作するメソッドを提供するオブジェクトを取得します。
loadCustomPropertiesAsync(callback: (asyncResult: Office.AsyncResult<CustomProperties>) => void, userContext?: any) 選択されたアイテムのこのアドインのカスタム プロパティを非同期に読み込みます。
location 予定の場所を取得または設定します。
removeAttachmentAsync(attachmentId: string, callback?: (asyncResult: Office.AsyncResult<void>) => void) メッセージまたは予定から添付ファイルを削除します。
removeAttachmentAsync(attachmentId: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) メッセージまたは予定から添付ファイルを削除します。
AppointmentForm body 予定の本文を設定します。
end 予定を終了する日時を設定します。
location 予定の場所を設定します。
optionalAttendees 予定の任意の出席者を設定します。
requiredAttendees 予定の必要な出席者を設定します。
resources 予定のリソースを設定します。
start 予定を開始する日時を設定します。
subject 予定の [タイトル] フィールドに表示される説明を設定します。
AppointmentRead body アイテムの本文を操作するメソッドを提供するオブジェクトを取得します。
dateTimeModified アイテムが最後に変更された日時を取得します。
displayReplyAllForm(formData: string |ReplyFormData) 選択したメッセージの送信者とすべての受信者、またはメッセージの開催者とすべての出席者を含む返信フォームを表示します
displayReplyForm(formData: string |ReplyFormData) 選択したメッセージの送信者のみ、または選択した予定の開催者のみを含む回答フォームが表示されます。
getEntities() 選択したアイテムの本文にあるエンティティを取得します。
getEntitiesByType(entityType: MailboxEnums.EntityType | string) 選択したアイテムの本文内で検出された指定のエンティティ型のすべてのエンティティを含む配列を取得します。
getFilteredEntitiesByName(name: string) アドイン専用のマニフェスト ファイルで定義されている名前付きフィルターに合格した、選択した項目内の既知のエンティティを返します。
getRegExMatches() アドイン専用のマニフェスト ファイルで定義されている正規表現と一致する、選択した項目の文字列値を返します。
getRegExMatchesByName(name: string) アドイン専用のマニフェスト ファイルで定義されている名前付き正規表現と一致する、選択した項目の文字列値を返します。
loadCustomPropertiesAsync(callback: (asyncResult: Office.AsyncResult<CustomProperties>) => void, userContext?: any) 選択されたアイテムのこのアドインのカスタム プロパティを非同期に読み込みます。
location 予定の場所を取得します。
AttachmentDetails attachmentType 添付ファイルの種類を示す値を取得します。
contentType 添付ファイルの MIME コンテンツ タイプを取得します。
id 添付ファイルの Exchange 添付ファイル ID を取得します。
isInline 添付ファイルが添付ファイル リストではなくアイテムの本文に画像として表示されるかどうかを示す値を取得します。
name 添付ファイルの名前を取得します。
size 添付ファイルのサイズをバイト単位で取得します。
Body getTypeAsync(callback?: (asyncResult: Office.AsyncResult<Office.CoercionType>) => void) コンテンツの形式が HTML とテキストのどちらであるかを示す値を取得します。
getTypeAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<Office.CoercionType>) => void) コンテンツの形式が HTML とテキストのどちらであるかを示す値を取得します。
prependAsync(data: string, callback?: (asyncResult: Office.AsyncResult<void>) => void) アイテム本文の先頭に指定の内容を追加します。
prependAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) アイテム本文の先頭に指定の内容を追加します。
setSelectedDataAsync(data: string, callback?: (asyncResult: Office.AsyncResult<void>) => void) 本文の選択部分を、指定のテキストに置き換えます。
setSelectedDataAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) 本文の選択部分を、指定のテキストに置き換えます。
CustomProperties get(name: string) 指定したカスタム プロパティの値を返します。
remove(name: string) カスタム プロパティ コレクションから指定のプロパティを削除します。
saveAsync(asyncContext?: any) メッセージまたは予定にカスタム プロパティを保存します。
saveAsync(callback: (asyncResult: Office.AsyncResult<void>) => void, asyncContext?: any) メッセージまたは予定にカスタム プロパティを保存します。
set(name: string, value: string) 指定のプロパティを指定の値に設定します。
Diagnostics OWAView Outlook on the web の現在のビューを表す文字列を取得します。
hostName Outlook クライアントの種類を表す文字列を取得します。
hostVersion Outlook クライアントまたは Exchange Server のバージョンを表す文字列を取得します (たとえば、"15.0.468.0")。
Location getAsync(callback: (asyncResult: Office.AsyncResult<string>) => void) 予定の場所を取得します。
getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void) 予定の場所を取得します。
setAsync(location: string, callback?: (asyncResult: Office.AsyncResult<void>) => void) 予定の場所を設定します。
setAsync(location: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) 予定の場所を設定します。
メールボックス displayAppointmentForm(itemId: string) 既存の予定を表示します。
displayMessageForm(itemId: string) 既存のメッセージを表示します。
displayNewAppointmentForm(parameters: AppointmentForm) 新しい予定を作成するためのフォームを表示します。
ewsUrl Gets the URL of the Exchange Web サービス (EWS) endpoint for this email account.
makeEwsRequestAsync(data: any, callback: (asyncResult: Office.AsyncResult<string>) => void, userContext?: any) ユーザーのメールボックスをホストする Exchange サーバー上の Exchange Web サービス (EWS) サービスに対して非同期要求を行います。
MessageCompose addFileAttachmentAsync(uri: string, attachmentName: string, callback?: (asyncResult: Office.AsyncResult<string>) => void) ファイルを添付ファイルとしてメッセージまたは予定に追加します。
addFileAttachmentAsync(uri: string, attachmentName: string, options: Office.AsyncContextOptions & { isInline: boolean }, callback?: (asyncResult: Office.AsyncResult<string>) => void) ファイルを添付ファイルとしてメッセージまたは予定に追加します。
addItemAttachmentAsync(itemId: any, attachmentName: string, callback?: (asyncResult: Office.AsyncResult<string>) => void) メッセージなどの Exchange アイテムを添付ファイルとして、メッセージまたは予定に追加します。
addItemAttachmentAsync(itemId: any, attachmentName: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<string>) => void) メッセージなどの Exchange アイテムを添付ファイルとして、メッセージまたは予定に追加します。
bcc メッセージの BCC (ブラインド カーボン コピー) 行の受信者を取得または更新するメソッドを提供するオブジェクトを取得します。
body アイテムの本文を操作するメソッドを提供するオブジェクトを取得します。
loadCustomPropertiesAsync(callback: (asyncResult: Office.AsyncResult<CustomProperties>) => void, userContext?: any) 選択されたアイテムのこのアドインのカスタム プロパティを非同期に読み込みます。
removeAttachmentAsync(attachmentId: string, callback?: (asyncResult: Office.AsyncResult<void>) => void) メッセージまたは予定から添付ファイルを削除します。
removeAttachmentAsync(attachmentId: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) メッセージまたは予定から添付ファイルを削除します。
MessageRead body アイテムの本文を操作するメソッドを提供するオブジェクトを取得します。
dateTimeModified アイテムが最後に変更された日時を取得します。
displayReplyAllForm(formData: string |ReplyFormData) 選択したメッセージの送信者とすべての受信者、またはメッセージの開催者とすべての出席者を含む返信フォームを表示します
displayReplyForm(formData: string |ReplyFormData) 選択したメッセージの送信者のみ、または選択した予定の開催者のみを含む回答フォームが表示されます。
getEntities() 選択したアイテムの本文にあるエンティティを取得します。
getEntitiesByType(entityType: MailboxEnums.EntityType | string) 選択したアイテムの本文内で検出された指定のエンティティ型のすべてのエンティティを含む配列を取得します。
getFilteredEntitiesByName(name: string) アドイン専用のマニフェスト ファイルで定義されている名前付きフィルターに合格した、選択した項目内の既知のエンティティを返します。
getRegExMatches() アドイン専用のマニフェスト ファイルで定義されている正規表現と一致する、選択した項目の文字列値を返します。
getRegExMatchesByName(name: string) アドイン専用のマニフェスト ファイルで定義されている名前付き正規表現と一致する、選択した項目の文字列値を返します。
loadCustomPropertiesAsync(callback: (asyncResult: Office.AsyncResult<CustomProperties>) => void, userContext?: any) 選択されたアイテムのこのアドインのカスタム プロパティを非同期に読み込みます。
AttachmentType クラウド 添付ファイルは、OneDrive などのクラウドの場所に保存されます。
File この添付ファイルはファイルです。
アイテム この添付ファイルは Exchange のアイテムです。
RecipientType DistributionList 受信者が電子メール アドレスのリストを含む配布リストであることを指定します。
ExternalUser 受信者が Exchange サーバー上にない SMTP 電子メール アドレスであることを指定します。
その他 受信者が他の受信者のタイプではないことを指定します。
User 受信者が Exchange サーバーの SMTP 電子メール アドレスであることを指定します。
受信者 addAsync(recipients: array<string |EmailUser |EmailAddressDetails>, callback?: (asyncResult: Office.AsyncResult<void>) => void) 予定やメッセージの既存の受信者に、受信者のリストを追加します。
addAsync(recipients: array<string |EmailUser |EmailAddressDetails>, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) 予定やメッセージの既存の受信者に、受信者のリストを追加します。
getAsync(callback: (asyncResult: Office.AsyncResult<EmailAddressDetails[]>) => void) 予定やメッセージの受信者リストを取得します。
getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<EmailAddressDetails[]>) => void) 予定やメッセージの受信者リストを取得します。
setAsync(recipients: array<string |EmailUser |EmailAddressDetails>, callback: (asyncResult: Office.AsyncResult<void>) => void) 予定やメッセージの受信者リストを設定します。
setAsync(recipients: array<string |EmailUser |EmailAddressDetails>, options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<void>) => void) 予定やメッセージの受信者リストを設定します。
ReplyFormAttachment inLine true の場合、添付ファイルがメッセージ本文にインラインで表示され、添付ファイルの一覧には表示しないことを示します。
itemId 添付ファイルの EWS アイテム ID。
name 添付ファイル名を含む文字列。最大の長さは 255 文字です。
type 添付ファイルの種類を示します。
url ファイルの場所の URI。
ReplyFormData callback 応答表示呼び出しが完了すると、コールバック パラメーターで渡された関数が 1 つのパラメーター (
htmlBody 回答フォームの本文を表すテキストと HTML が含まれる文字列。
options asyncContext プロパティを含むオブジェクト リテラル。
RoamingSettings get(name: string) 指定された設定を取得します。
remove(name: string) 指定された設定を削除します。
saveAsync(callback?: (asyncResult: Office.AsyncResult<void>) => void) 設定を保存します。
set(name: string, value: any) 指定された設定を行うかまたは作成します。
件名 getAsync(callback: (asyncResult: Office.AsyncResult<string>) => void) 予定またはメッセージの件名を取得します。
getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void) 予定またはメッセージの件名を取得します。
setAsync(subject: string, callback?: (asyncResult: Office.AsyncResult<void>) => void) 予定またはメッセージの件名を設定します。
setAsync(subject: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) 予定またはメッセージの件名を設定します。
Time getAsync(callback: (asyncResult: Office.AsyncResult<Date>) => void) 予定の開始または終了の時刻を取得します。
getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<Date>) => void) 予定の開始または終了の時刻を取得します。
setAsync(dateTime: Date, callback?: (asyncResult: Office.AsyncResult<void>) => void) 予定の開始または終了の時刻を設定します。
setAsync(dateTime: Date, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) 予定の開始または終了の時刻を設定します。

関連項目

  • Last updated on