Office.LoadedMessageCompose interface
現在読み込まれている作成モードのメッセージを表します。
LoadedMessageCompose オブジェクトは、作成モードのメッセージでOffice.context.mailbox.loadItemByIdAsyncが呼び出されると返されます。
注釈
最小アクセス許可レベル: 項目の読み取り/書き込み
適用できる Outlook モード: メッセージ Compose
重要:
アイテムの複数選択機能を実装する場合、
Office.context.mailbox.getSelectedItemsAsync呼び出しを通じて、選択したアイテムの必要なプロパティに既にアクセスできるかどうかを判断します。 可能な場合は、loadItemByIdAsyncを呼び出す必要はありません。一度に読み込めることができるメール アイテムは 1 つだけです。
loadItemByIdAsyncを実装するときは、アイテムの処理後にunloadAsyncを呼び出す必要があります。 これは、別の項目でloadItemByIdAsyncを呼び出す前に行う必要があります。
例
// Gets the sender's email address of each selected message.
async function getSenderEmailAddress(item) {
const itemId = item.itemId;
await new Promise((resolve) => {
Office.context.mailbox.loadItemByIdAsync(itemId, (result) => {
if (result.status === Office.AsyncResultStatus.Failed) {
console.log(result.error.message);
return;
}
const loadedItem = result.value;
const sender = loadedItem.from.emailAddress;
console.log(sender);
// Unload the current message before processing another selected message.
loadedItem.unloadAsync((asyncResult) => {
if (asyncResult.status === Office.AsyncResultStatus.Failed) {
console.log(asyncResult.error.message);
return;
}
resolve();
});
});
});
}
プロパティ
| bcc | メッセージの Bcc (ブラインド カーボン コピー) 行の受信者を取得します。 |
| body | アイテムの本文と形式を取得します。 |
| categories | アイテムのカテゴリを管理するメソッドを提供する オブジェクトを取得します。 |
| cc | メッセージの Cc (カーボン コピー) 行の受信者を取得します。 |
| conversation |
特定のメッセージが含まれている電子メールの会話の識別子を取得します。 メール アプリを閲覧フォームでアクティブ化するか、新規作成フォームの返信でアクティブ化すると、このプロパティで整数を取得することができます。 その後、ユーザーが返信の件名を変更した場合、その返信の送信時にメッセージの会話 ID が変更され、以前に取得した値は適用されなくなります。 新規作成フォームで新しいアイテムに対してこのプロパティに null を取得します。 |
| delay |
メッセージの遅延配信日時を取得します。 |
| from | メッセージの送信者の電子メール アドレスを取得します。 |
| in |
現在のメッセージによって返信される元のメッセージのメッセージ ID を取得します。 |
| internet |
メッセージのカスタム インターネット ヘッダーを取得します。 詳細については、「 Outlook アドインのメッセージでインターネット ヘッダーを取得して設定する」を参照してください。 |
| item |
インスタンスが表しているアイテムの種類を取得します。
|
| notification |
アイテムの通知メッセージを取得します。 |
| sensitivity |
メッセージの秘密度ラベルを取得します。 |
| series |
インスタンスが属する系列の ID を取得します。 Outlook on the webおよび Windows (新規およびクラシック) では、 |
| subject | アイテムの件名フィールドに表示される説明を取得します。
|
| to | メッセージの [宛先 ] 行の受信者を取得します。 メッセージの To 行にある受信者へのアクセスを提供します。 オブジェクトの種類とアクセス レベルは、現在の項目のモードによって異なります。 |
メソッド
| get |
メッセージまたは予定から添付ファイルを取得し、 |
| get |
メッセージまたは予定から添付ファイルを取得し、 |
| get |
項目の添付ファイルを配列として取得します。 |
| get |
項目の添付ファイルを配列として取得します。 |
| get |
メッセージ作成の種類とその強制型を指定します。 メッセージは、新しいメッセージ、または返信または転送できます。 強制型には、HTML またはプレーン テキストを使用できます。 |
| get |
メッセージ作成の種類とその強制型を指定します。 メッセージは、新しいメッセージ、または返信または転送できます。 強制型には、HTML またはプレーン テキストを使用できます。 |
| get |
会話スレッド内の現在のメッセージの Base64 でエンコードされた位置を取得します。 |
| get |
会話スレッド内の現在のメッセージの Base64 でエンコードされた位置を取得します。 |
| get |
アクション可能なメッセージによってアドインがアクティブ化されたときに渡される初期化データを取得します。 |
| get |
アクション可能なメッセージによってアドインがアクティブ化されたときに渡される初期化データを取得します。 |
| get |
選択したメッセージの Exchange Web Services アイテム クラスを取得します。 |
| get |
選択したメッセージの Exchange Web Services アイテム クラスを取得します。 |
| get |
保存されたアイテムの Exchange Web Services (EWS) アイテム識別子 を非同期的に取得します。 呼び出されると、このメソッドはコールバック関数を使用して項目 ID を返します。 |
| get |
保存済みアイテムの ID を非同期的に取得します。 呼び出されると、このメソッドはコールバック関数を使用して項目 ID を返します。
注: アドインが作成モードのアイテムで |
| get |
共有フォルダーまたは共有メールボックス内の予定またはメッセージのプロパティを取得します。 この API の使用方法の詳細については、「 Outlook アドインで共有フォルダーと共有メールボックスのシナリオを有効にする」を参照してください。 |
| get |
共有フォルダーまたは共有メールボックス内の予定またはメッセージのプロパティを取得します。 この API の使用方法の詳細については、「 Outlook アドインで共有フォルダーと共有メールボックスのシナリオを有効にする」を参照してください。 |
| is |
クライアント署名が有効になっているかどうかを取得します。 Outlook on Windows (クラシック) では、新しいメッセージ、返信、転送の既定の署名が送信 Outlook アカウントのテンプレートに設定されている場合、API 呼び出しは |
| is |
クライアント署名が有効になっているかどうかを取得します。 Outlook on Windows (クラシック) では、新しいメッセージ、返信、転送の既定の署名が送信 Outlook アカウントのテンプレートに設定されている場合、API 呼び出しは |
| load |
選択されたアイテムのこのアドインのカスタム プロパティを非同期に読み込みます。 カスタム プロパティは、アプリごとに項目ごとにキーと値のペアとして格納されます。 このメソッドはコールバックで CustomProperties オブジェクトを返します。これにより、現在のアイテムと現在のアドインに固有のカスタム プロパティにアクセスするメソッドが提供されます。 カスタム プロパティはアイテムで暗号化されないため、セキュリティで保護されたストレージとして使用しないでください。 カスタム プロパティは |
| save |
現在のメッセージを下書きとして非同期的に保存します。 |
| save |
現在のメッセージを下書きとして非同期的に保存します。 |
| unload |
複数のメール アイテムが選択されている場合は、現在読み込まれているアイテムを閉じて、選択した別のメール アイテムを処理用に読み込むことができます。 |
| unload |
複数のメール アイテムが選択されている場合は、現在読み込まれているアイテムを閉じて、選択した別のメール アイテムを処理用に読み込むことができます。 |
プロパティの詳細
bcc
メッセージの Bcc (ブラインド カーボン コピー) 行の受信者を取得します。
bcc: Recipients;プロパティ値
注釈
最小アクセス許可レベル: 読み取り項目
適用できる Outlook モード: メッセージ Compose
重要:
Recipients オブジェクトの
getAsyncメソッドのみがサポートされています。Outlook クライアントとプラットフォームによっては、取得できる受信者の数に制限が適用される場合があります。 詳細については、「 Recipients オブジェクト」を参照してください。
body
アイテムの本文と形式を取得します。
body: Body;プロパティ値
注釈
最小アクセス許可レベル: 読み取り項目
適用できる Outlook モード: メッセージ Compose
重要: Body オブジェクトの getAsync メソッドと getTypeAsync メソッドのみがサポートされています。
categories
アイテムのカテゴリを管理するメソッドを提供する オブジェクトを取得します。
categories: Categories;プロパティ値
注釈
最小アクセス許可レベル: 読み取り項目
適用できる Outlook モード: メッセージ Compose
cc
メッセージの Cc (カーボン コピー) 行の受信者を取得します。
cc: Recipients;プロパティ値
注釈
最小アクセス許可レベル: 読み取り項目
適用できる Outlook モード: メッセージ Compose
重要:
Recipients オブジェクトの
getAsyncメソッドのみがサポートされています。Outlook クライアントとプラットフォームによっては、取得できる受信者の数に制限が適用される場合があります。 詳細については、「 Recipients オブジェクト」を参照してください。
conversationId
特定のメッセージが含まれている電子メールの会話の識別子を取得します。
メール アプリを閲覧フォームでアクティブ化するか、新規作成フォームの返信でアクティブ化すると、このプロパティで整数を取得することができます。 その後、ユーザーが返信の件名を変更した場合、その返信の送信時にメッセージの会話 ID が変更され、以前に取得した値は適用されなくなります。
新規作成フォームで新しいアイテムに対してこのプロパティに null を取得します。
conversationId: string;プロパティ値
string
注釈
最小アクセス許可レベル: 読み取り項目
適用できる Outlook モード: メッセージ Compose
delayDeliveryTime
メッセージの遅延配信日時を取得します。
delayDeliveryTime: DelayDeliveryTime;プロパティ値
注釈
最小アクセス許可レベル: 読み取り項目
適用できる Outlook モード: メッセージ Compose
重要: DelayDeliveryTime オブジェクトの getAsync メソッドのみがサポートされています。
from
メッセージの送信者の電子メール アドレスを取得します。
from: From;プロパティ値
注釈
最小アクセス許可レベル: 読み取り項目
適用できる Outlook モード: メッセージ Compose
inReplyTo
現在のメッセージによって返信される元のメッセージのメッセージ ID を取得します。
inReplyTo: string;プロパティ値
string
注釈
最小アクセス許可レベル: 読み取り項目
適用できる Outlook モード: メッセージ Compose
重要:
Outlook on Windows では、返信の件名の変更など、ユーザーが行った変更に関係なく、すべての応答で
inReplyTo値が維持されます。inReplyToプロパティは、会議の開催者でもあるユーザーが転送する新しいメッセージと会議出席依頼のnullを返します。
internetHeaders
メッセージのカスタム インターネット ヘッダーを取得します。
詳細については、「 Outlook アドインのメッセージでインターネット ヘッダーを取得して設定する」を参照してください。
internetHeaders: InternetHeaders;プロパティ値
注釈
最小アクセス許可レベル: 読み取り項目
適用できる Outlook モード: メッセージ Compose
重要: InternetHeaders オブジェクトの getAsync メソッドのみがサポートされています。
itemType
インスタンスが表しているアイテムの種類を取得します。
itemType プロパティは、アイテム オブジェクト インスタンスがメッセージか予定かを示す、ItemType列挙値のいずれかを返します。
itemType: MailboxEnums.ItemType | string;プロパティ値
Office.MailboxEnums.ItemType | string
注釈
最小アクセス許可レベル: 読み取り項目
適用できる Outlook モード: メッセージ Compose
notificationMessages
アイテムの通知メッセージを取得します。
notificationMessages: NotificationMessages;プロパティ値
注釈
最小アクセス許可レベル: 読み取り項目
適用できる Outlook モード: メッセージ Compose
重要:
実装できるさまざまな種類の通知メッセージの詳細については、「 Outlook アドインの通知を作成する」を参照してください。
NotificationMessages オブジェクトの
getAllAsyncメソッドのみがサポートされています。
sensitivityLabel
メッセージの秘密度ラベルを取得します。
sensitivityLabel: SensitivityLabel;プロパティ値
注釈
最小アクセス許可レベル: 項目の読み取り/書き込み
適用できる Outlook モード: メッセージ Compose
重要:
アドインで秘密度ラベル機能を使用するには、Microsoft 365 E5 サブスクリプションが必要です。
SensitivityLabel オブジェクトの
getAsyncメソッドのみがサポートされています。
アドインで秘密度ラベルを管理する方法の詳細については、「作成モードでメッセージまたは予定の秘密度ラベルを管理する」を参照してください。
seriesId
インスタンスが属する系列の ID を取得します。
Outlook on the webおよび Windows (新規およびクラシック) では、seriesIdは、このアイテムが属する親 (系列) アイテムの Exchange Web Services (EWS) ID を返します。
seriesId: string;プロパティ値
string
注釈
最小アクセス許可レベル: 読み取り項目
適用できる 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を返します。
subject
アイテムの件名フィールドに表示される説明を取得します。
subject プロパティは、メール サーバーから送信されたアイテムの件名全体を取得します。
subject: Subject;プロパティ値
注釈
最小アクセス許可レベル: 読み取り項目
適用できる Outlook モード: メッセージ Compose
重要: Subject オブジェクトの getAsync メソッドのみがサポートされています。
to
メッセージの [宛先 ] 行の受信者を取得します。 メッセージの To 行にある受信者へのアクセスを提供します。 オブジェクトの種類とアクセス レベルは、現在の項目のモードによって異なります。
to: Recipients;プロパティ値
注釈
最小アクセス許可レベル: 読み取り項目
適用できる Outlook モード: メッセージ Compose
重要:
Recipients オブジェクトの
getAsyncメソッドのみがサポートされています。Outlook クライアントとプラットフォームによっては、取得できる受信者の数に制限が適用される場合があります。 詳細については、「 Recipients オブジェクト」を参照してください。
メソッドの詳細
getAttachmentContentAsync(attachmentId, options, callback)
メッセージまたは予定から添付ファイルを取得し、 AttachmentContent オブジェクトとして返します。
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
重要:
getAttachmentContentAsyncメソッドは、指定した識別子を持つ添付ファイルをアイテムから取得します。 ベスト プラクティスとして、getAttachmentsAsync呼び出しから添付ファイルの識別子を取得し、同じセッションでその識別子を使用して添付ファイルを取得する必要があります。Outlook on the webと新しい Outlook on Windows では、
getAttachmentContentAsyncでは、[アップロードと共有] オプションを使用して追加された添付ファイルはサポートされていません。Outlook on the web、モバイル デバイス、および新しい Outlook on Windows では、添付ファイル識別子は同じセッション内でのみ有効です。 ユーザーがアプリを閉じると、またはユーザーがインライン フォームの作成を開始すると、その後フォームがポップアップ表示され、別のウィンドウで続行されます。
エラー:
AttachmentTypeNotSupported: 添付ファイルの種類はサポートされていません。 サポートされていない種類には、リッチ テキスト形式の埋め込み画像や、メールや予定表アイテム以外のアイテムの添付ファイルの種類 (連絡先やタスク アイテムなど) が含まれます。InvalidAttachmentId: 添付ファイル識別子が存在しません。
getAttachmentContentAsync(attachmentId, callback)
メッセージまたは予定から添付ファイルを取得し、 AttachmentContent オブジェクトとして返します。
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
重要:
getAttachmentContentAsyncメソッドは、指定した識別子を持つ添付ファイルをアイテムから取得します。 ベスト プラクティスとして、getAttachmentsAsync呼び出しから添付ファイルの識別子を取得し、同じセッションでその識別子を使用して添付ファイルを取得する必要があります。Outlook on the webと新しい Outlook on Windows では、
getAttachmentContentAsyncでは、[アップロードと共有] オプションを使用して追加された添付ファイルはサポートされていません。Outlook on the web、モバイル デバイス、および新しい Outlook on Windows では、添付ファイル識別子は同じセッション内でのみ有効です。 ユーザーがアプリを閉じると、またはユーザーがインライン フォームの作成を開始すると、その後フォームがポップアップ表示され、別のウィンドウで続行されます。
エラー:
AttachmentTypeNotSupported: 添付ファイルの種類はサポートされていません。 サポートされていない種類には、リッチ テキスト形式の埋め込み画像や、メールや予定表アイテム以外のアイテムの添付ファイルの種類 (連絡先やタスク アイテムなど) が含まれます。InvalidAttachmentId: 添付ファイル識別子が存在しません。
getAttachmentsAsync(options, callback)
項目の添付ファイルを配列として取得します。
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
重要: Outlook on the webおよび新しい Outlook on Windows では、ユーザーは [アップロードと共有] オプションを選択して添付ファイルを OneDrive にアップロードし、メール アイテムにファイルへのリンクを含めることができます。 ただし、リンクのみが含まれるため、 getAttachmentsAsync はこの添付ファイルを返しません。
getAttachmentsAsync(callback)
項目の添付ファイルを配列として取得します。
getAttachmentsAsync(callback?: (asyncResult: Office.AsyncResult<AttachmentDetailsCompose[]>) => void): void;パラメーター
- callback
-
(asyncResult: Office.AsyncResult<Office.AttachmentDetailsCompose[]>) => void
省略可能。 メソッドが完了すると、 callback パラメーターで渡された関数が、 Office.AsyncResult型の 1 つのパラメーターで呼び出されます。 呼び出しが失敗した場合、 asyncResult.error プロパティにはエラー コードが含まれます。エラーの理由が示されます。
戻り値
void
注釈
最小アクセス許可レベル: 読み取り項目
適用できる Outlook モード: メッセージ Compose
重要: Outlook on the webおよび新しい Outlook on Windows では、ユーザーは [アップロードと共有] オプションを選択して添付ファイルを OneDrive にアップロードし、メール アイテムにファイルへのリンクを含めることができます。 ただし、リンクのみが含まれるため、 getAttachmentsAsync はこの添付ファイルを返しません。
getComposeTypeAsync(options, callback)
メッセージ作成の種類とその強制型を指定します。 メッセージは、新しいメッセージ、または返信または転送できます。 強制型には、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
getComposeTypeAsync(callback)
メッセージ作成の種類とその強制型を指定します。 メッセージは、新しいメッセージ、または返信または転送できます。 強制型には、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
getConversationIndexAsync(options, callback)
会話スレッド内の現在のメッセージの 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
ヒント: 会話インデックスを使用して、会話スレッド内のメッセージを見つけることができます。 次に、その内容を使用して、構成されている現在のメッセージのコンテキストを提供します。
getConversationIndexAsync(callback)
会話スレッド内の現在のメッセージの 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
ヒント: 会話インデックスを使用して、会話スレッド内のメッセージを見つけることができます。 次に、その内容を使用して、構成されている現在のメッセージのコンテキストを提供します。
getInitializationContextAsync(options, callback)
アクション可能なメッセージによってアドインがアクティブ化されたときに渡される初期化データを取得します。
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
getInitializationContextAsync(callback)
アクション可能なメッセージによってアドインがアクティブ化されたときに渡される初期化データを取得します。
getInitializationContextAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;パラメーター
- callback
-
(asyncResult: Office.AsyncResult<string>) => void
メソッドが完了すると、 callback パラメーターで渡された関数が、 Office.AsyncResult型の 1 つのパラメーターで呼び出されます。 成功すると、初期化コンテキスト データは、 asyncResult.value プロパティの文字列 (または初期化コンテキストがない場合は空の文字列) として提供されます。
戻り値
void
注釈
最小アクセス許可レベル: 読み取り項目
適用できる Outlook モード: メッセージ Compose
getItemClassAsync(options, callback)
選択したメッセージの 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.Schedule.Meeting.Request | 会議出席依頼 |
| IPM.Schedule.Meeting.Canceled | 会議のキャンセル |
| IPM。Schedule.Meeting.Resp.Neg | 会議出席依頼に対する辞退の通知 |
| IPM。Schedule.Meeting.Resp.Pos | 会議出席依頼を受け入れるための応答 |
| IPM。Schedule.Meeting.Resp.Tent | 会議出席依頼に対する仮の受諾の通知 |
getItemClassAsync(callback)
選択したメッセージの 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.Schedule.Meeting.Request | 会議出席依頼 |
| IPM.Schedule.Meeting.Canceled | 会議のキャンセル |
| IPM。Schedule.Meeting.Resp.Neg | 会議出席依頼に対する辞退の通知 |
| IPM。Schedule.Meeting.Resp.Pos | 会議出席依頼を受け入れるための応答 |
| IPM。Schedule.Meeting.Resp.Tent | 会議出席依頼に対する仮の受諾の通知 |
getItemIdAsync(options, callback)
保存されたアイテムの 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 を取得できません。
getItemIdAsync(callback)
保存済みアイテムの 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
注釈
最小アクセス許可レベル: 読み取り項目
適用できる Outlook モード: メッセージ Compose
エラー:
-
ItemNotSaved: 項目が保存されるまで ID を取得できません。
getSharedPropertiesAsync(options, callback)
共有フォルダーまたは共有メールボックス内の予定またはメッセージのプロパティを取得します。
この 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
注釈
[ API セット: 共有フォルダーのサポート用メールボックス 1.8、共有メールボックスサポート用メールボックス 1.13 ]
最小アクセス許可レベル: 読み取り項目
適用できる Outlook モード: メッセージ Compose
重要: メッセージ Compose モードでは、次の条件が満たされていない限り、この API はOutlook on the webまたは Windows (新規およびクラシック) ではサポートされません。
a. アクセス/共有フォルダーを委任する
メールボックスの所有者がメッセージを開始します。 これは、新しいメッセージ、返信、転送のいずれかです。
メッセージを保存し、独自の Drafts フォルダーからデリゲートと共有されているフォルダーに移動します。
デリゲートは、共有フォルダーから下書きを開き、作成を続行します。
b. ユーザーのプライマリ メールボックス (Web、クラシック Windows) または完全なアカウントに昇格されていない共有メールボックス (新しい Windows) と同じパネルで開かれた共有メールボックス
共有メールボックス ユーザーがメッセージを開始します。 これは、新しいメッセージ、返信、転送のいずれかです。
メッセージを保存し、独自の 下書き フォルダーから共有メールボックス内のフォルダーに移動します。
別の共有メールボックス ユーザーが共有メールボックスから下書きを開き、作成を続行します。
これらの条件が満たされると、メッセージは共有コンテキストで使用できるようになり、これらの共有シナリオをサポートするアドインはアイテムの共有プロパティを取得できます。 メッセージが送信されると、通常は送信者の個人用メールボックスの [送信済みアイテム] フォルダーに表示されます。
getSharedPropertiesAsync メソッドは、追加の条件なしで、次のプラットフォームでサポートされています。
[別のメールボックスを開く] オプションを使用して、共有メールボックスが別のタブまたはウィンドウで開かれている場合にOutlook on the webします。
共有メールボックスが完全なアカウントに昇格されたときの Windows 上の新しい Outlook。
getSharedPropertiesAsync(callback)
共有フォルダーまたは共有メールボックス内の予定またはメッセージのプロパティを取得します。
この 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. ユーザーのプライマリ メールボックス (Web、クラシック Windows) または完全なアカウントに昇格されていない共有メールボックス (新しい Windows) と同じパネルで開かれた共有メールボックス
共有メールボックス ユーザーがメッセージを開始します。 これは、新しいメッセージ、返信、転送のいずれかです。
メッセージを保存し、独自の 下書き フォルダーから共有メールボックス内のフォルダーに移動します。
別の共有メールボックス ユーザーが共有メールボックスから下書きを開き、作成を続行します。
これらの条件が満たされると、メッセージは共有コンテキストで使用できるようになり、これらの共有シナリオをサポートするアドインはアイテムの共有プロパティを取得できます。 メッセージが送信されると、通常は送信者の個人用メールボックスの [送信済みアイテム] フォルダーに表示されます。
getSharedPropertiesAsync メソッドは、追加の条件なしで、次のプラットフォームでサポートされています。
[別のメールボックスを開く] オプションを使用して、共有メールボックスが別のタブまたはウィンドウで開かれている場合にOutlook on the webします。
共有メールボックスが完全なアカウントに昇格されたときの Windows 上の新しい Outlook。
isClientSignatureEnabledAsync(options, callback)
クライアント署名が有効になっているかどうかを取得します。
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
isClientSignatureEnabledAsync(callback)
クライアント署名が有効になっているかどうかを取得します。
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
注釈
最小アクセス許可レベル: 読み取り項目
適用できる Outlook モード: メッセージ Compose
loadCustomPropertiesAsync(callback, userContext)
選択されたアイテムのこのアドインのカスタム プロパティを非同期に読み込みます。
カスタム プロパティは、アプリごとに項目ごとにキーと値のペアとして格納されます。 このメソッドはコールバックで CustomProperties オブジェクトを返します。これにより、現在のアイテムと現在のアドインに固有のカスタム プロパティにアクセスするメソッドが提供されます。 カスタム プロパティはアイテムで暗号化されないため、セキュリティで保護されたストレージとして使用しないでください。
カスタム プロパティは asyncResult.value プロパティの CustomProperties オブジェクトとして指定されます。 このオブジェクトを使用して、メール アイテムからカスタム プロパティを取得できます。
loadCustomPropertiesAsync(callback: (asyncResult: Office.AsyncResult<CustomProperties>) => void, userContext?: any): void;パラメーター
- callback
-
(asyncResult: Office.AsyncResult<Office.CustomProperties>) => void
メソッドが完了すると、 callback パラメーターで渡された関数が、 Office.AsyncResult型の 1 つのパラメーターで呼び出されます。
- userContext
-
any
省略可能。 開発者は、コールバック関数でアクセスする任意のオブジェクトを指定できます。 このオブジェクトには、コールバック関数の asyncResult.asyncContext プロパティによってアクセスすることができます。
戻り値
void
注釈
カスタム プロパティの詳細については、「 Outlook アドインのアドイン メタデータを取得して設定する」を参照してください。
最小アクセス許可レベル: 読み取り項目
適用できる Outlook モード: メッセージ Compose
saveAsync(options, callback)
現在のメッセージを下書きとして非同期的に保存します。
saveAsync(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で呼び出されます。 EWS メッセージ ID は、 asyncResult.value プロパティで返されます。
戻り値
void
注釈
最小アクセス許可レベル: 項目の読み取り/書き込み
適用できる Outlook モード: メッセージ Compose
重要:
Outlook on the web、新しい Outlook on Windows、またはオンライン モード (キャッシュなしモード) の従来の Outlook では、アイテムがサーバーに保存されます。 キャッシュ モードの Outlook では、ローカル キャッシュにアイテムが保存されます。
HTML 形式のコンテンツを操作する場合は、Outlook クライアントがコンテンツを変更する可能性があることに注意することが重要です。 つまり、
Body.getAsync、Body.setAsync、saveAsyncなどのメソッドに対する後続の呼び出しは、同じコンテンツにならない可能性があります。返される識別子は、 Exchange Web Services (EWS) アイテム識別子と同じです。 返されるアイテム ID は、Outlook エントリ ID または Outlook REST API で使用される ID と同じではありません。 この値を使用して REST API 呼び出しを行う前に、
Office.context.mailbox.convertToRestIdを使用して変換する必要があります。EWS または REST API で使用するアイテム ID を取得するために、アドインが作成モードでアイテムに
saveAsyncを呼び出す場合は、Outlook がキャッシュ モードの場合、アイテムが実際にサーバーに同期されるまでに時間がかかる場合があることに注意してください。 アイテムが同期されるまで、アイテム ID を使用するとエラーが返されます。Outlook on the webおよび新しい Outlook on Windows では、共有メールボックス アカウントから送信されるメッセージに
saveAsyncが呼び出されると、下書きが保存されるメールボックス アカウントが異なります。 送信者が個人用メールボックスから新しいメッセージを作成し、[ 差 出人] フィールドで共有メールボックス アカウントを選択saveAsync、下書きをユーザーの個人用メールボックスの 下書き フォルダーに保存します。 送信者が別のブラウザー タブ ([別のメールボックスを 開く ] オプションなど) で共有メールボックス アカウントを開き、そこに新しいメッセージを作成saveAsync場合、下書きは共有メールボックスの 下書き フォルダーに保存されます。
エラー:
-
InvalidAttachmentId: 添付ファイル識別子が存在しません。
saveAsync(callback)
現在のメッセージを下書きとして非同期的に保存します。
saveAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;パラメーター
- callback
-
(asyncResult: Office.AsyncResult<string>) => void
メソッドが完了すると、callback パラメーターで渡された関数が、Office.AsyncResult オブジェクトである 1 つのパラメーターasyncResultで呼び出されます。 EWS メッセージ ID は、 asyncResult.value プロパティで返されます。
戻り値
void
注釈
最小アクセス許可レベル: 項目の読み取り/書き込み
適用できる Outlook モード: メッセージ Compose
重要:
Outlook on the web、新しい Outlook on Windows、またはオンライン モード (キャッシュなしモード) の従来の Outlook では、アイテムがサーバーに保存されます。 キャッシュ モードの Outlook では、ローカル キャッシュにアイテムが保存されます。
HTML 形式のコンテンツを操作する場合は、Outlook クライアントがコンテンツを変更する可能性があることに注意することが重要です。 つまり、
Body.getAsync、Body.setAsync、saveAsyncなどのメソッドに対する後続の呼び出しは、同じコンテンツにならない可能性があります。返される識別子は、 Exchange Web Services (EWS) アイテム識別子と同じです。 返されるアイテム ID は、Outlook エントリ ID または Outlook REST API で使用される ID と同じではありません。 この値を使用して REST API 呼び出しを行う前に、
Office.context.mailbox.convertToRestIdを使用して変換する必要があります。EWS または REST API で使用するアイテム ID を取得するために、アドインが作成モードでアイテムに
saveAsyncを呼び出す場合は、Outlook がキャッシュ モードの場合、アイテムが実際にサーバーに同期されるまでに時間がかかる場合があることに注意してください。 アイテムが同期されるまで、アイテム ID を使用するとエラーが返されます。Outlook on the webおよび新しい Outlook on Windows では、共有メールボックス アカウントから送信されるメッセージに
saveAsyncが呼び出されると、下書きが保存されるメールボックス アカウントが異なります。 送信者が個人用メールボックスから新しいメッセージを作成し、[ 差 出人] フィールドで共有メールボックス アカウントを選択saveAsync、下書きをユーザーの個人用メールボックスの 下書き フォルダーに保存します。 送信者が別のブラウザー タブ ([別のメールボックスを 開く ] オプションなど) で共有メールボックス アカウントを開き、そこに新しいメッセージを作成saveAsync場合、下書きは共有メールボックスの 下書き フォルダーに保存されます。
エラー:
-
InvalidAttachmentId: 添付ファイル識別子が存在しません。
unloadAsync(options, callback)
複数のメール アイテムが選択されている場合は、現在読み込まれているアイテムを閉じて、選択した別のメール アイテムを処理用に読み込むことができます。
unloadAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;パラメーター
- options
- Office.AsyncContextOptions
asyncContext プロパティを含むオブジェクト リテラル。 コールバック関数でアクセスするオブジェクトを asyncContext プロパティに割り当てます。
- callback
-
(asyncResult: Office.AsyncResult<void>) => void
省略可能。 メソッドが完了すると、コールバック パラメーターで渡された関数が、Office.AsyncResult オブジェクトである 1 つのパラメーターasyncResultで呼び出されます。
戻り値
void
注釈
最小アクセス許可レベル: 項目の読み取り/書き込み
適用できる Outlook モード: メッセージ Compose
重要:
選択した複数のメッセージの処理の詳細については、「複数のメッセージ で Outlook アドインをアクティブ化する」を参照してください。
選択したメール アイテムが
loadItemByIdAsyncを使用して読み込まれる場合は、処理後にunloadAsyncを呼び出す必要があります。 これは、選択した別のアイテムでloadItemByIdAsyncを呼び出す前に行う必要があります。
unloadAsync(callback)
複数のメール アイテムが選択されている場合は、現在読み込まれているアイテムを閉じて、選択した別のメール アイテムを処理用に読み込むことができます。
unloadAsync(callback?: (asyncResult: Office.AsyncResult<void>) => void): void;パラメーター
- callback
-
(asyncResult: Office.AsyncResult<void>) => void
省略可能。 メソッドが完了すると、コールバック パラメーターで渡された関数が、Office.AsyncResult オブジェクトである 1 つのパラメーターasyncResultで呼び出されます。
戻り値
void
注釈
最小アクセス許可レベル: 項目の読み取り/書き込み
適用できる Outlook モード: メッセージ Compose
重要:
選択した複数のメッセージの処理の詳細については、「複数のメッセージ で Outlook アドインをアクティブ化する」を参照してください。
選択したメール アイテムが
loadItemByIdAsyncを使用して読み込まれる場合は、処理後にunloadAsyncを呼び出す必要があります。 これは、選択した別のアイテムでloadItemByIdAsyncを呼び出す前に行う必要があります。