Office. Loaded Message Compose interface

[ API セット: メールボックス 1.13 ]

最小アクセス許可レベル: 読み取り項目

適用できる Outlook モード: メッセージ Compose

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。この API は運用環境で使用しないでください。

メッセージの Cc (カーボンコピー) 行の受信者を取得します。

cc: Recipients;

プロパティ値

Office.Recipients

注釈

最小アクセス許可レベル: 読み取り項目

適用できる Outlook モード: メッセージ Compose

重要:

Recipients オブジェクトの getAsync メソッドのみがサポートされています。
Outlook クライアントとプラットフォームによっては、取得できる受信者の数に制限が適用される場合があります。詳細については、「 Recipients オブジェクト」を参照してください。

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。この API は運用環境で使用しないでください。

特定のメッセージが含まれている電子メールの会話の識別子を取得します。

メールアプリを閲覧フォームでアクティブ化するか、新規作成フォームの返信でアクティブ化すると、このプロパティで整数を取得することができます。その後、ユーザーが返信の件名を変更した場合、その返信の送信時にメッセージの会話 ID が変更され、以前に取得した値は適用されなくなります。

新規作成フォームで新しいアイテムに対してこのプロパティに null を取得します。

conversationId: string;

プロパティ値

string

注釈

最小アクセス許可レベル: 読み取り項目

適用できる Outlook モード: メッセージ Compose

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。この API は運用環境で使用しないでください。

メッセージの遅延配信日時を取得します。

delayDeliveryTime: DelayDeliveryTime;

プロパティ値

Office.DelayDeliveryTime

注釈

最小アクセス許可レベル: 読み取り項目

適用できる Outlook モード: メッセージ Compose

重要: DelayDeliveryTime オブジェクトの getAsync メソッドのみがサポートされています。

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。この API は運用環境で使用しないでください。

メッセージの送信者の電子メールアドレスを取得します。

from: From;

プロパティ値

Office.From

注釈

[ API セット: メールボックス 1.7 ]

最小アクセス許可レベル: 読み取り項目

適用できる Outlook モード: メッセージ Compose

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。この API は運用環境で使用しないでください。

現在のメッセージによって返信される元のメッセージのメッセージ ID を取得します。

inReplyTo: string;

プロパティ値

string

注釈

最小アクセス許可レベル: 読み取り項目

適用できる Outlook モード: メッセージ Compose

重要:

Outlook on Windows では、返信の件名の変更など、ユーザーが行った変更に関係なく、すべての応答で inReplyTo 値が維持されます。
inReplyTo プロパティは、会議の開催者でもあるユーザーが転送する新しいメッセージと会議出席依頼のnullを返します。

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。この API は運用環境で使用しないでください。

メッセージのカスタムインターネットヘッダーを取得します。

詳細については、「 Outlook アドインのメッセージでインターネットヘッダーを取得して設定する」を参照してください。

internetHeaders: InternetHeaders;

プロパティ値

Office.InternetHeaders

注釈

[ API セット: メールボックス 1.13 ]

最小アクセス許可レベル: 読み取り項目

適用できる Outlook モード: メッセージ Compose

重要: InternetHeaders オブジェクトの getAsync メソッドのみがサポートされています。

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。この API は運用環境で使用しないでください。

インスタンスが表しているアイテムの種類を取得します。

itemType プロパティは、アイテムオブジェクトインスタンスがメッセージか予定かを示す、ItemType列挙値のいずれかを返します。

itemType: MailboxEnums.ItemType | string;

プロパティ値

Office.MailboxEnums.ItemType | string

注釈

最小アクセス許可レベル: 読み取り項目

適用できる Outlook モード: メッセージ Compose

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。この API は運用環境で使用しないでください。

アイテムの通知メッセージを取得します。

notificationMessages: NotificationMessages;

プロパティ値

Office.NotificationMessages

注釈

[ API セット: メールボックス 1.3 ]

最小アクセス許可レベル: 読み取り項目

適用できる Outlook モード: メッセージ Compose

重要:

NotificationMessages オブジェクトの getAllAsync メソッドのみがサポートされています。

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。この API は運用環境で使用しないでください。

メッセージの秘密度ラベルを取得します。

sensitivityLabel: SensitivityLabel;

プロパティ値

Office.SensitivityLabel

注釈

最小アクセス許可レベル: 項目の読み取り/書き込み

適用できる Outlook モード: メッセージ Compose

重要:

アドインで秘密度ラベル機能を使用するには、Microsoft 365 E5 サブスクリプションが必要です。
SensitivityLabel オブジェクトの getAsync メソッドのみがサポートされています。

アドインで秘密度ラベルを管理する方法の詳細については、「作成モードでメッセージまたは予定の秘密度ラベルを管理する」を参照してください。

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。この API は運用環境で使用しないでください。

インスタンスが属する系列の ID を取得します。

Outlook on the webおよび Windows (新規およびクラシック) では、seriesIdは、このアイテムが属する親 (系列) アイテムの Exchange Web Services (EWS) ID を返します。

seriesId: string;

プロパティ値

string

注釈

[ API セット: メールボックス 1.7 ]

最小アクセス許可レベル: 読み取り項目

適用できる Outlook モード: メッセージ Compose

重要: seriesId プロパティによって返される識別子は、Exchange Web Services アイテム識別子と同じです。 seriesId プロパティは、Outlook REST API で使用される Outlook ID と同じではありません。この値を使用して REST API 呼び出しを行う前に、 Office.context.mailbox.convertToRestIdを使用して変換する必要があります。詳細については、「 Outlook アドインから Outlook REST API を使用する」を参照してください。

seriesId プロパティは、単一の予定、系列アイテム、会議出席依頼などの親アイテムを持たないアイテムのnullを返し、会議出席依頼ではないその他のアイテムのundefinedを返します。

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。この API は運用環境で使用しないでください。

アイテムの件名フィールドに表示される説明を取得します。

subject プロパティは、メールサーバーから送信されたアイテムの件名全体を取得します。

subject: Subject;

プロパティ値

Office.Subject

注釈

最小アクセス許可レベル: 読み取り項目

適用できる Outlook モード: メッセージ Compose

重要: Subject オブジェクトの getAsync メソッドのみがサポートされています。

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。この API は運用環境で使用しないでください。

メッセージの [宛先 ] 行の受信者を取得します。メッセージの To 行にある受信者へのアクセスを提供します。オブジェクトの種類とアクセスレベルは、現在の項目のモードによって異なります。

to: Recipients;

プロパティ値

Office.Recipients

注釈

最小アクセス許可レベル: 読み取り項目

適用できる Outlook モード: メッセージ Compose

重要:

Recipients オブジェクトの getAsync メソッドのみがサポートされています。
Outlook クライアントとプラットフォームによっては、取得できる受信者の数に制限が適用される場合があります。詳細については、「 Recipients オブジェクト」を参照してください。

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。この API は運用環境で使用しないでください。

メッセージまたは予定から添付ファイルを取得し、 AttachmentContent オブジェクトとして返します。

getAttachmentContentAsync メソッドは、指定した識別子を持つ添付ファイルをアイテムから取得します。ベストプラクティスとして、 getAttachmentsAsync 呼び出しから添付ファイルの識別子を取得し、同じセッションでその識別子を使用して添付ファイルを取得する必要があります。 Outlook on the webおよび新しい Outlook on Windows では、添付ファイル識別子は同じセッション内でのみ有効です。ユーザーがアプリを閉じると、またはユーザーがインラインフォームの作成を開始すると、その後フォームがポップアップ表示され、別のウィンドウで続行されます。

getAttachmentContentAsync(attachmentId: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<AttachmentContent>) => void): void;

パラメーター

attachmentId: string

取得する添付ファイルの識別子。

options: Office.AsyncContextOptions

次のプロパティの 1 つ以上を含むオブジェクトリテラル:- asyncContext: 開発者は、コールバック関数でアクセスする任意のオブジェクトを指定できます。

callback: (asyncResult: Office.AsyncResult<Office.AttachmentContent>) => void

省略可能。メソッドが完了すると、callback パラメーターで渡された関数が、Office.AsyncResult オブジェクトである 1 つのパラメーターasyncResultで呼び出されます。呼び出しが失敗した場合、 asyncResult.error プロパティにはエラーコードが含まれます。エラーの理由が示されます。

戻り値

void

注釈

最小アクセス許可レベル: 読み取り項目

適用できる Outlook モード: メッセージ Compose

エラー:

AttachmentTypeNotSupported : 添付ファイルの種類はサポートされていません。サポートされていない種類には、リッチテキスト形式の埋め込み画像や、メールや予定表アイテム以外のアイテムの添付ファイルの種類 (連絡先やタスクアイテムなど) が含まれます。
InvalidAttachmentId : 添付ファイル識別子が存在しません。

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。この API は運用環境で使用しないでください。

メッセージまたは予定から添付ファイルを取得し、 AttachmentContent オブジェクトとして返します。

getAttachmentContentAsync メソッドは、指定した識別子を持つ添付ファイルをアイテムから取得します。ベストプラクティスとして、 getAttachmentsAsync 呼び出しから添付ファイルの識別子を取得し、同じセッションでその識別子を使用して添付ファイルを取得する必要があります。 Outlook on the webおよび新しい Outlook on Windows では、添付ファイル識別子は同じセッション内でのみ有効です。ユーザーがアプリを閉じると、またはユーザーがインラインフォームの作成を開始すると、その後フォームがポップアップ表示され、別のウィンドウで続行されます。

getAttachmentContentAsync(attachmentId: string, callback?: (asyncResult: Office.AsyncResult<AttachmentContent>) => void): void;

パラメーター

attachmentId: string

取得する添付ファイルの識別子。

callback: (asyncResult: Office.AsyncResult<Office.AttachmentContent>) => void

省略可能。メソッドが完了すると、callback パラメーターで渡された関数が、Office.AsyncResult オブジェクトである 1 つのパラメーターasyncResultで呼び出されます。呼び出しが失敗した場合、 asyncResult.error プロパティにはエラーコードが含まれます。エラーの理由が示されます。

戻り値

void

注釈

最小アクセス許可レベル: 読み取り項目

適用できる Outlook モード: メッセージ Compose

エラー:

AttachmentTypeNotSupported : 添付ファイルの種類はサポートされていません。サポートされていない種類には、リッチテキスト形式の埋め込み画像や、メールや予定表アイテム以外のアイテムの添付ファイルの種類 (連絡先やタスクアイテムなど) が含まれます。
InvalidAttachmentId : 添付ファイル識別子が存在しません。

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。この API は運用環境で使用しないでください。

項目の添付ファイルを配列として取得します。

getAttachmentsAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<AttachmentDetailsCompose[]>) => void): void;

パラメーター

options: Office.AsyncContextOptions

次のプロパティの 1 つ以上を含むオブジェクトリテラル:- asyncContext: 開発者は、コールバック関数でアクセスする任意のオブジェクトを指定できます。

callback: (asyncResult: Office.AsyncResult<Office.AttachmentDetailsCompose[]>) => void

省略可能。メソッドが完了すると、 callback パラメーターで渡された関数が、 Office.AsyncResult型の 1 つのパラメーターで呼び出されます。呼び出しが失敗した場合、 asyncResult.error プロパティにはエラーコードが含まれます。エラーの理由が示されます。

戻り値

void

注釈

最小アクセス許可レベル: 読み取り項目

適用できる Outlook モード: メッセージ Compose

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。この API は運用環境で使用しないでください。

項目の添付ファイルを配列として取得します。

getAttachmentsAsync(callback?: (asyncResult: Office.AsyncResult<AttachmentDetailsCompose[]>) => void): void;

パラメーター

callback: (asyncResult: Office.AsyncResult<Office.AttachmentDetailsCompose[]>) => void

省略可能。メソッドが完了すると、 callback パラメーターで渡された関数が、 Office.AsyncResult型の 1 つのパラメーターで呼び出されます。呼び出しが失敗した場合、 asyncResult.error プロパティにはエラーコードが含まれます。エラーの理由が示されます。

戻り値

void

注釈

最小アクセス許可レベル: 読み取り項目

適用できる Outlook モード: メッセージ Compose

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。この API は運用環境で使用しないでください。

メッセージ作成の種類とその強制型を指定します。メッセージは、新しいメッセージ、または返信または転送できます。強制型には、HTML またはプレーンテキストを使用できます。

getComposeTypeAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<any>) => void): void;

パラメーター

options: Office.AsyncContextOptions

次のプロパティの 1 つ以上を含むオブジェクトリテラル:- asyncContext: 開発者は、コールバック関数でアクセスする任意のオブジェクトを指定できます。

callback: (asyncResult: Office.AsyncResult<any>) => void

メソッドが完了すると、 callback パラメーターで渡された関数が、 Office.AsyncResult型の 1 つのパラメーターで呼び出されます。成功すると、 asyncResult.value プロパティには、アイテムの compose 型と強制型を持つオブジェクトが含まれます。

戻り値

void

メッセージ項目の ComposeType と CoercionType 列挙値を持つオブジェクト。

注釈

最小アクセス許可レベル: 読み取り項目

適用できる Outlook モード: メッセージ Compose

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。この API は運用環境で使用しないでください。

メッセージ作成の種類とその強制型を指定します。メッセージは、新しいメッセージ、または返信または転送できます。強制型には、HTML またはプレーンテキストを使用できます。

getComposeTypeAsync(callback: (asyncResult: Office.AsyncResult<any>) => void): void;

パラメーター

callback: (asyncResult: Office.AsyncResult<any>) => void

メソッドが完了すると、 callback パラメーターで渡された関数が、 Office.AsyncResult型の 1 つのパラメーターで呼び出されます。成功すると、 asyncResult.value プロパティには、アイテムの compose 型と強制型を持つオブジェクトが含まれます。

戻り値

void

メッセージ項目の ComposeType と CoercionType 列挙値を持つオブジェクト。

注釈

最小アクセス許可レベル: 読み取り項目

適用できる Outlook モード: メッセージ Compose

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。この API は運用環境で使用しないでください。

会話スレッド内の現在のメッセージの Base64 でエンコードされた位置を取得します。

getConversationIndexAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void): void;

パラメーター

options: Office.AsyncContextOptions

次のプロパティの 1 つ以上を含むオブジェクトリテラル:- asyncContext: 開発者は、コールバック関数でアクセスする任意のオブジェクトを指定できます。

callback: (asyncResult: Office.AsyncResult<string>) => void

メソッドが完了すると、callback パラメーターで渡された関数が、Office.AsyncResult オブジェクトである 1 つのパラメーターasyncResultで呼び出されます。スレッド内の現在のメッセージの Base64 でエンコードされた位置は、 asyncResult.value プロパティで返されます。

戻り値

void

注釈

最小アクセス許可レベル: 読み取り項目

適用できる Outlook モード: メッセージ Compose

ヒント: 会話インデックスを使用して、会話スレッド内のメッセージを見つけることができます。次に、その内容を使用して、構成されている現在のメッセージのコンテキストを提供します。

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。この API は運用環境で使用しないでください。

会話スレッド内の現在のメッセージの Base64 でエンコードされた位置を取得します。

getConversationIndexAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;

パラメーター

callback: (asyncResult: Office.AsyncResult<string>) => void

メソッドが完了すると、callback パラメーターで渡された関数が、Office.AsyncResult オブジェクトである 1 つのパラメーターasyncResultで呼び出されます。スレッド内の現在のメッセージの Base64 でエンコードされた位置は、 asyncResult.value プロパティで返されます。

戻り値

void

注釈

最小アクセス許可レベル: 読み取り項目

適用できる Outlook モード: メッセージ Compose

ヒント: 会話インデックスを使用して、会話スレッド内のメッセージを見つけることができます。次に、その内容を使用して、構成されている現在のメッセージのコンテキストを提供します。

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。この API は運用環境で使用しないでください。

アクション可能なメッセージによってアドインがアクティブ化されたときに渡される初期化データを取得します。

getInitializationContextAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void): void;

パラメーター

options: Office.AsyncContextOptions

次のプロパティの 1 つ以上を含むオブジェクトリテラル:- asyncContext: 開発者は、コールバック関数でアクセスする任意のオブジェクトを指定できます。

callback: (asyncResult: Office.AsyncResult<string>) => void

メソッドが完了すると、 callback パラメーターで渡された関数が、 Office.AsyncResult型の 1 つのパラメーターで呼び出されます。成功すると、初期化コンテキストデータは、 asyncResult.value プロパティの文字列 (または初期化コンテキストがない場合は空の文字列) として提供されます。

戻り値

void

注釈

最小アクセス許可レベル: 読み取り項目

適用できる Outlook モード: メッセージ Compose

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。この API は運用環境で使用しないでください。

アクション可能なメッセージによってアドインがアクティブ化されたときに渡される初期化データを取得します。

getInitializationContextAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;

パラメーター

callback: (asyncResult: Office.AsyncResult<string>) => void

メソッドが完了すると、 callback パラメーターで渡された関数が、 Office.AsyncResult型の 1 つのパラメーターで呼び出されます。成功すると、初期化コンテキストデータは、 asyncResult.value プロパティの文字列 (または初期化コンテキストがない場合は空の文字列) として提供されます。

戻り値

void

注釈

最小アクセス許可レベル: 読み取り項目

適用できる Outlook モード: メッセージ Compose

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。この API は運用環境で使用しないでください。

選択したメッセージの Exchange Web Services アイテムクラスを取得します。

getItemClassAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void): void;

パラメーター

options: Office.AsyncContextOptions

次のプロパティの 1 つ以上を含むオブジェクトリテラル:- asyncContext: 開発者は、コールバック関数でアクセスする任意のオブジェクトを指定できます。

callback: (asyncResult: Office.AsyncResult<string>) => void

メソッドが完了すると、callback パラメーターで渡された関数が、Office.AsyncResult オブジェクトである 1 つのパラメーターasyncResultで呼び出されます。メッセージクラスは、 asyncResult.value プロパティで返されます。

戻り値

void

注釈

最小アクセス許可レベル: 読み取り項目

適用できる Outlook モード: メッセージ Compose

重要:

次の表に、既定のメッセージクラスを示します。

アイテムクラス	説明
IPM.Note	新しいメッセージとメッセージ応答
IPM。Note.SMIME	署名可能な暗号化されたメッセージ
IPM。Note.SMIME.MultipartSigned	暗号化キーが必要です。
IPM.Schedule.Meeting.Request	会議出席依頼
IPM.Schedule.Meeting.Canceled	会議のキャンセル
IPM。Schedule.Meeting.Resp.Neg	会議出席依頼に対する辞退の通知
IPM。Schedule.Meeting.Resp.Pos	会議出席依頼を受け入れるための応答
IPM。Schedule.Meeting.Resp.Tent	会議出席依頼に対する仮の受諾の通知

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。この API は運用環境で使用しないでください。

選択したメッセージの Exchange Web Services アイテムクラスを取得します。

getItemClassAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;

パラメーター

callback: (asyncResult: Office.AsyncResult<string>) => void

メソッドが完了すると、callback パラメーターで渡された関数が、Office.AsyncResult オブジェクトである 1 つのパラメーターasyncResultで呼び出されます。メッセージクラスは、 asyncResult.value プロパティで返されます。

戻り値

void

注釈

最小アクセス許可レベル: 読み取り項目

適用できる Outlook モード: メッセージ Compose

重要:

次の表に、既定のメッセージクラスを示します。

アイテムクラス	説明
IPM.Note	新しいメッセージとメッセージ応答
IPM。Note.SMIME	署名可能な暗号化されたメッセージ
IPM。Note.SMIME.MultipartSigned	暗号化キーが必要です。
IPM.Schedule.Meeting.Request	会議出席依頼
IPM.Schedule.Meeting.Canceled	会議のキャンセル
IPM。Schedule.Meeting.Resp.Neg	会議出席依頼に対する辞退の通知
IPM。Schedule.Meeting.Resp.Pos	会議出席依頼を受け入れるための応答
IPM。Schedule.Meeting.Resp.Tent	会議出席依頼に対する仮の受諾の通知

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。この API は運用環境で使用しないでください。

保存されたアイテムの Exchange Web Services (EWS) アイテム識別子を非同期的に取得します。

呼び出されると、このメソッドはコールバック関数を使用して項目 ID を返します。

getItemIdAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void): void;

パラメーター

options: Office.AsyncContextOptions

次のプロパティの 1 つ以上を含むオブジェクトリテラル:- asyncContext: 開発者は、コールバック関数でアクセスする任意のオブジェクトを指定できます。

callback: (asyncResult: Office.AsyncResult<string>) => void

メソッドが完了すると、 callback パラメーターで渡された関数が、 Office.AsyncResult型の 1 つのパラメーターで呼び出されます。アイテムの EWS アイテム ID は、 asyncResult.value プロパティで返されます。

戻り値

void

注釈

最小アクセス許可レベル: 読み取り項目

適用できる Outlook モード: メッセージ Compose

重要:

返されるアイテム ID は、Outlook エントリ ID または Outlook REST API で使用される ID と同じではありません。この値を使用して REST API 呼び出しを行う前に、 Office.context.mailbox.convertToRestIdを使用して変換する必要があります。
アドインが作成モードのアイテムで getItemIdAsync を呼び出す場合 (EWS や REST API で使用する itemId を取得する場合など)、Outlook がキャッシュモードの場合、アイテムがサーバーに同期されるまでに時間がかかる場合があることに注意してください。アイテムが同期されるまで、 itemId は認識されないため、使用するとエラーが返されます。

エラー:

ItemNotSaved : 項目が保存されるまで ID を取得できません。

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。この API は運用環境で使用しないでください。

保存済みアイテムの ID を非同期的に取得します。

呼び出されると、このメソッドはコールバック関数を使用して項目 ID を返します。

注: アドインが作成モードのアイテムで getItemIdAsync を呼び出す場合 (EWS や REST API で使用する itemId を取得する場合など)、Outlook がキャッシュモードの場合、アイテムがサーバーに同期されるまでに時間がかかる場合があることに注意してください。アイテムが同期されるまで、 itemId は認識されないため、使用するとエラーが返されます。

getItemIdAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;

パラメーター

callback: (asyncResult: Office.AsyncResult<string>) => void

メソッドが完了すると、 callback パラメーターで渡された関数が、 Office.AsyncResult型の 1 つのパラメーターで呼び出されます。

戻り値

void

注釈

[ API セット: 共有フォルダーのサポート用メールボックス 1.8、共有メールボックスサポート用メールボックス 1.13 ]

最小アクセス許可レベル: 読み取り項目

適用できる Outlook モード: メッセージ Compose

エラー:

ItemNotSaved : 項目が保存されるまで ID を取得できません。

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。この API は運用環境で使用しないでください。

共有フォルダーまたは共有メールボックス内の予定またはメッセージのプロパティを取得します。

この API の使用方法の詳細については、「 Outlook アドインで共有フォルダーと共有メールボックスのシナリオを有効にする」を参照してください。

getSharedPropertiesAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<SharedProperties>) => void): void;

パラメーター

options: Office.AsyncContextOptions

次のプロパティの 1 つ以上を含むオブジェクトリテラル:- asyncContext: 開発者は、コールバック関数でアクセスする任意のオブジェクトを指定できます。

callback: (asyncResult: Office.AsyncResult<Office.SharedProperties>) => void

メソッドが完了すると、callback パラメーターで渡された関数が、Office.AsyncResult オブジェクトである 1 つのパラメーターasyncResultで呼び出されます。 asyncResult.value プロパティは、共有アイテムのプロパティを提供します。

戻り値

void

注釈

最小アクセス許可レベル: 読み取り項目

適用できる Outlook モード: メッセージ Compose

重要: メッセージ Compose モードでは、次の条件が満たされていない限り、この API はOutlook on the webまたは Windows (新規およびクラシック) ではサポートされません。

a. アクセス/共有フォルダーを委任する

メールボックスの所有者がメッセージを開始します。これは、新しいメッセージ、返信、転送のいずれかです。
メッセージを保存し、独自の Drafts フォルダーからデリゲートと共有されているフォルダーに移動します。
デリゲートは、共有フォルダーから下書きを開き、作成を続行します。

b. 共有メールボックス (従来の Outlook on Windows にのみ適用)

共有メールボックスユーザーがメッセージを開始します。これは、新しいメッセージ、返信、転送のいずれかです。
メッセージを保存し、独自の 下書き フォルダーから共有メールボックス内のフォルダーに移動します。
別の共有メールボックスユーザーが共有メールボックスから下書きを開き、作成を続行します。

メッセージは共有コンテキストに入り、これらの共有シナリオをサポートするアドインはアイテムの共有プロパティを取得できます。メッセージが送信されると、通常は送信者の [送信済みアイテム] フォルダーに表示されます。

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。この API は運用環境で使用しないでください。

共有フォルダーまたは共有メールボックス内の予定またはメッセージのプロパティを取得します。

この API の使用方法の詳細については、「 Outlook アドインで共有フォルダーと共有メールボックスのシナリオを有効にする」を参照してください。

getSharedPropertiesAsync(callback: (asyncResult: Office.AsyncResult<SharedProperties>) => void): void;

パラメーター

callback: (asyncResult: Office.AsyncResult<Office.SharedProperties>) => void

メソッドが完了すると、callback パラメーターで渡された関数が、Office.AsyncResult オブジェクトである 1 つのパラメーターasyncResultで呼び出されます。 asyncResult.value プロパティは、共有アイテムのプロパティを提供します。

戻り値

void

注釈

[ API セット: 共有フォルダーのサポート用メールボックス 1.8、共有メールボックスサポート用メールボックス 1.13 ]

最小アクセス許可レベル: 読み取り項目

適用できる Outlook モード: メッセージ Compose

重要: メッセージ Compose モードでは、次の条件が満たされていない限り、この API はOutlook on the webまたは Windows (新規およびクラシック) ではサポートされません。

a. アクセス/共有フォルダーを委任する

メールボックスの所有者がメッセージを開始します。これは、新しいメッセージ、返信、転送のいずれかです。
メッセージを保存し、独自の Drafts フォルダーからデリゲートと共有されているフォルダーに移動します。
デリゲートは、共有フォルダーから下書きを開き、作成を続行します。

b. 共有メールボックス (Outlook on Windows にのみ適用)

共有メールボックスユーザーがメッセージを開始します。これは、新しいメッセージ、返信、転送のいずれかです。
メッセージを保存し、独自の 下書き フォルダーから共有メールボックス内のフォルダーに移動します。
別の共有メールボックスユーザーが共有メールボックスから下書きを開き、作成を続行します。

メッセージは共有コンテキストに入り、これらの共有シナリオをサポートするアドインはアイテムの共有プロパティを取得できます。メッセージが送信されると、通常は送信者の [送信済みアイテム] フォルダーに表示されます。

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。この API は運用環境で使用しないでください。

クライアント署名が有効になっているかどうかを取得します。

Outlook on Windows (クラシック) では、新しいメッセージ、返信、転送の既定の署名が送信 Outlook アカウントのテンプレートに設定されている場合、API 呼び出しは true を返します。 Outlook on the webおよび新しい Outlook on Windows では、新規作成の種類newMail、reply、またはforwardに対して署名が有効になっている場合、API 呼び出しはtrueを返します。 Outlook on Windows (クラシック) で設定が "(none)" に設定されているか、Outlook on the webまたは新しい Outlook on Windows で無効になっている場合、API 呼び出しはfalseを返します。

isClientSignatureEnabledAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<boolean>) => void): void;

パラメーター

options: Office.AsyncContextOptions

次のプロパティの 1 つ以上を含むオブジェクトリテラル:- asyncContext: 開発者は、コールバック関数でアクセスする任意のオブジェクトを指定できます。

callback: (asyncResult: Office.AsyncResult<boolean>) => void

メソッドが完了すると、 callback パラメーターで渡された関数が、 Office.AsyncResult型の 1 つのパラメーターで呼び出されます。

戻り値

void

注釈

最小アクセス許可レベル: 読み取り項目

適用できる Outlook モード: メッセージ Compose

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。この API は運用環境で使用しないでください。

クライアント署名が有効になっているかどうかを取得します。

Outlook on Windows (クラシック) では、新しいメッセージ、返信、転送の既定の署名が送信 Outlook アカウントのテンプレートに設定されている場合、API 呼び出しは true を返します。 Outlook on the webおよび新しい Outlook on Windows では、新規作成の種類newMail、reply、またはforwardに対して署名が有効になっている場合、API 呼び出しはtrueを返します。 Outlook on Windows (クラシック) で設定が "(none)" に設定されているか、Outlook on the webまたは新しい Outlook on Windows で無効になっている場合、API 呼び出しはfalseを返します。

isClientSignatureEnabledAsync(callback: (asyncResult: Office.AsyncResult<boolean>) => void): void;

パラメーター

callback: (asyncResult: Office.AsyncResult<boolean>) => void

メソッドが完了すると、 callback パラメーターで渡された関数が、 Office.AsyncResult型の 1 つのパラメーターで呼び出されます。

戻り値

void

注釈