Office.LoadedMessageCompose interface

パッケージ:

outlook

現在読み込まれている作成モードのメッセージを表します。 作成モードでメッセージに対して Office.context.mailbox.loadItemByIdAsync が呼び出されると、LoadedMessageCompose オブジェクトが返されます。

注釈

API セット: メールボックス 1.15

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

対象となる Outlook モード: メッセージ Compose

重要:

• アイテムの複数選択機能を実装するときにOffice.context.mailbox.getSelectedItemsAsync呼び出しを使用して、選択したアイテムの必須プロパティに既にアクセスできるかどうかを確認します。 可能であれば、 loadItemByIdAsync に電話する必要はありません。

• 一度に読み込むことができるメール アイテムは 1 つだけです。 loadItemByIdAsync を実装するときは、アイテムを処理した後に unloadAsync を呼び出す必要があります。 この操作は、別のアイテムで loadItemByIdAsync を呼び出す前に行う必要があります。

使用元

• Office.Mailbox: 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 (カーボン コピー) 行の受信者を取得します。
conversationId	特定のメッセージが含まれている電子メールの会話の識別子を取得します。 メール アプリを閲覧フォームでアクティブ化するか、新規作成フォームの返信でアクティブ化すると、このプロパティで整数を取得することができます。 その後、ユーザーが返信の件名を変更した場合、その返信の送信時にメッセージの会話 ID が変更され、以前に取得した値は適用されなくなります。 新規作成フォームで新しいアイテムに対してこのプロパティに null を取得します。
delayDeliveryTime	メッセージの遅延配信日時を取得します。
from	メッセージの送信者の電子メール アドレスを取得します。
inReplyTo	現在のメッセージから返信される元のメッセージのメッセージ ID を取得します。
internetHeaders	メッセージのカスタム インターネット ヘッダーを取得します。 詳細については、「Outlook アドインでメッセージのインターネット ヘッダーを取得して設定する」を参照してください。
itemType	インスタンスが表しているアイテムの種類を取得します。 itemType プロパティは、アイテム オブジェクト インスタンスがメッセージか予定かを示す、ItemType列挙値のいずれかを返します。
notificationMessages	項目の通知メッセージを取得します。
sensitivityLabel	メッセージの秘密度ラベルを取得します。
seriesId	インスタンスが属するシリーズの ID を取得します。 Outlook on the web および Windows (新規およびクラシック) では、seriesIdは、このアイテムが属する親 (系列) アイテムの Exchange Web サービス (EWS) ID を返します。
subject	アイテムの [件名] フィールドに表示される説明を取得します。 subject プロパティは、メール サーバーから送信されたアイテムの件名全体を取得します。
to	メッセージの To 行の受信者を取得します。 メッセージの To 行にある受信者へのアクセスを提供します。 オブジェクトのタイプとアクセス レベルは、現在の項目のモードによって異なります。

メソッド

getAttachmentContentAsync(attachmentId, options, callback)	メッセージまたは予定から添付ファイルを取得し、 AttachmentContent オブジェクトとして返します。
getAttachmentContentAsync(attachmentId, callback)	メッセージまたは予定から添付ファイルを取得し、 AttachmentContent オブジェクトとして返します。
getAttachmentsAsync(options, callback)	アイテムの添付ファイルを配列として取得します。
getAttachmentsAsync(callback)	アイテムの添付ファイルを配列として取得します。
getComposeTypeAsync(options, callback)	メッセージ作成の種類とその強制の種類を指定します。 メッセージは新しいメッセージ、返信または転送にすることができます。 強制の種類は HTML またはプレーン テキストです。
getComposeTypeAsync(callback)	メッセージ作成の種類とその強制の種類を指定します。 メッセージは新しいメッセージ、返信または転送にすることができます。 強制の種類は HTML またはプレーン テキストです。
getConversationIndexAsync(options, callback)	Base64 でエンコードされたスレッド内の現在のメッセージの位置を取得します。
getConversationIndexAsync(callback)	Base64 でエンコードされたスレッド内の現在のメッセージの位置を取得します。
getInitializationContextAsync(options, callback)	アクション可能なメッセージによってアドインがアクティブ化されたときに渡される初期化データを取得します。
getInitializationContextAsync(callback)	アクション可能なメッセージによってアドインがアクティブ化されたときに渡される初期化データを取得します。
getItemClassAsync(options, callback)	選択したメッセージの Exchange Web サービス項目クラスを取得します。
getItemClassAsync(callback)	選択したメッセージの Exchange Web サービス項目クラスを取得します。
getItemIdAsync(options, callback)	保存されたアイテムの Exchange Web サービス (EWS) アイテム識別子 を非同期で取得します。 このメソッドは呼び出すと、コールバック関数によってアイテム ID を返します。
getItemIdAsync(callback)	保存された項目の ID を非同期で取得します。 このメソッドは呼び出すと、コールバック関数によってアイテム ID を返します。 注: アドインが作成モードのアイテムに対して getItemIdAsync を呼び出す場合 (たとえば、EWS または REST API で使用する itemId を取得する場合)、Outlook がキャッシュ モードの場合、アイテムがサーバーに同期されるまでに時間がかかる可能性があることに注意してください。 アイテムが同期されるまで、 itemId は認識されず、それを使用するとエラーが返されます。
getSharedPropertiesAsync(options, callback)	共有フォルダーまたは共有メールボックス内の予定またはメッセージのプロパティを取得します。 この API の使用方法の詳細については、「Outlook アドインで共有フォルダーと共有メールボックスのシナリオを有効にする」を参照してください。
getSharedPropertiesAsync(callback)	共有フォルダーまたは共有メールボックス内の予定またはメッセージのプロパティを取得します。 この API の使用方法の詳細については、「Outlook アドインで共有フォルダーと共有メールボックスのシナリオを有効にする」を参照してください。
isClientSignatureEnabledAsync(options, callback)	クライアント署名が有効になっているかどうかを取得します。 Windows 上の Outlook (クラシック) では、新しいメッセージ、返信、または転送の既定の署名が、送信元の Outlook アカウントのテンプレートに設定されている場合、API 呼び出しによって true が返されます。 Outlook on the web および新しい Outlook on Windows では、作成の種類 newMail、reply、または forward に対して署名が有効になっている場合、API 呼び出しによって true が返されます。 Windows 上の Outlook (クラシック) で設定が「(なし)」に設定されている場合、または Windows 上の Outlook on the web または新しい Outlook で設定が無効になっている場合、API 呼び出しはfalseを返します。
isClientSignatureEnabledAsync(callback)	クライアント署名が有効になっているかどうかを取得します。 Windows 上の Outlook (クラシック) では、新しいメッセージ、返信、または転送の既定の署名が、送信元の Outlook アカウントのテンプレートに設定されている場合、API 呼び出しによって true が返されます。 Outlook on the web および新しい Outlook on Windows では、作成の種類 newMail、reply、または forward に対して署名が有効になっている場合、API 呼び出しによって true が返されます。 Windows 上の Outlook (クラシック) で設定が「(なし)」に設定されている場合、または Windows 上の Outlook on the web または新しい Outlook で設定が無効になっている場合、API 呼び出しはfalseを返します。
loadCustomPropertiesAsync(callback, userContext)	選択されたアイテムのこのアドインのカスタム プロパティを非同期に読み込みます。 カスタム プロパティは、アプリごと、アイテムごとにキーと値のペアとして格納されます。 このメソッドはコールバックで CustomProperties オブジェクトを返します。このオブジェクトには、現在の項目と現在のアドインに固有のカスタム プロパティにアクセスするメソッドが用意されています。 カスタム プロパティはアイテムで暗号化されていないため、これをセキュリティで保護されたストレージとして使用しないでください。 カスタム プロパティは asyncResult.value プロパティの CustomProperties オブジェクトとして指定されます。 このオブジェクトを使用して、メール アイテムからカスタム プロパティを取得できます。
saveAsync(options, callback)	現在のメッセージを下書きとして非同期に保存します。
saveAsync(callback)	現在のメッセージを下書きとして非同期に保存します。
unloadAsync(options, callback)	複数のメール アイテムを選択している場合は、現在読み込まれているアイテムを閉じて、選択した別のメール アイテムを処理対象として読み込むことができます。
unloadAsync(callback)	複数のメール アイテムを選択している場合は、現在読み込まれているアイテムを閉じて、選択した別のメール アイテムを処理対象として読み込むことができます。

プロパティの詳細

bcc

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

bcc: Recipients;

プロパティ値

Office.Recipients

注釈

API セット: メールボックス 1.1

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

対象となる Outlook モード: メッセージ Compose

重要:

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

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

body

項目の本文と形式を取得します。

body: Body;

プロパティ値

Office.Body

注釈

API セット: メールボックス 1.1

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

対象となる Outlook モード: メッセージ Compose

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

categories

項目のカテゴリを管理するメソッドを提供するオブジェクトを取得します。

categories: Categories;

プロパティ値

Office.Categories

注釈

API セット: メールボックス 1.8

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

対象となる Outlook モード: メッセージ Compose

cc

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

cc: Recipients;

プロパティ値

Office.Recipients

注釈

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

対象となる Outlook モード: メッセージ Compose

重要:

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

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

conversationId

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

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

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

conversationId: string;

プロパティ値

string

注釈

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

対象となる Outlook モード: メッセージ Compose

delayDeliveryTime

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

delayDeliveryTime: DelayDeliveryTime;

プロパティ値

Office.DelayDeliveryTime

注釈

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

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

対象となる Outlook モード: メッセージ Compose

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

from

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

from: From;

プロパティ値

Office.From

注釈

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

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

対象となる Outlook モード: メッセージ Compose

inReplyTo

現在のメッセージから返信される元のメッセージのメッセージ ID を取得します。

inReplyTo: string;

プロパティ値

string

注釈

API セット: メールボックス 1.14

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

対象となる Outlook モード: メッセージ Compose

重要:

• Windows 上の Outlook では、返信の件名の変更など、ユーザーが行った変更に関係なく、すべての返信で inReplyTo 値が保持されます。

• inReplyTo プロパティは、会議の開催者でもあるユーザーによって転送される新しいメッセージと会議出席依頼のnullを返します。

internetHeaders

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

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

internetHeaders: InternetHeaders;

プロパティ値

Office.InternetHeaders

注釈

API セット: メールボックス 1.8

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

対象となる Outlook モード: メッセージ Compose

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

itemType

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

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

itemType: MailboxEnums.ItemType | string;

プロパティ値

Office.MailboxEnums.ItemType | string

注釈

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

対象となる Outlook モード: メッセージ Compose

notificationMessages

項目の通知メッセージを取得します。

notificationMessages: NotificationMessages;

プロパティ値

Office.NotificationMessages

注釈

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

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

対象となる Outlook モード: メッセージ Compose

重要:

• 実装できるさまざまな種類の通知メッセージの詳細については、「 Outlook アドインの通知を作成する」を参照してください。

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

sensitivityLabel

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

sensitivityLabel: SensitivityLabel;

プロパティ値

Office.SensitivityLabel

注釈

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

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

対象となる Outlook モード: メッセージ Compose

重要:

• アドインで秘密度ラベル機能を使用するには、Microsoft 365 E5 サブスクリプションが必要です。

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

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

seriesId

インスタンスが属するシリーズの ID を取得します。

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

seriesId: string;

プロパティ値

string

注釈

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

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

対象となる Outlook モード: メッセージ Compose

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

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

subject

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

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

subject: Subject;

プロパティ値

Office.Subject

注釈

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

対象となる Outlook モード: メッセージ Compose

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

to

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

to: Recipients;

プロパティ値

Office.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

取得する添付ファイルの識別子。 Outlook on the web と新しい Outlook on Windows では、サーバーにまだアップロードされていないインライン画像に対してローカルで生成される一時的な添付ファイル ID が、現在の作成セッションの間サポートされます。

options

Office.AsyncContextOptions

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

callback

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

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

返品

void

注釈

API セット: メールボックス 1.8

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

対象となる Outlook モード: メッセージ Compose

重要:

• getAttachmentContentAsync メソッドは、指定された識別子を持つ添付ファイルをアイテムから取得します。 ベスト プラクティスとしては、 getAttachmentsAsync 呼び出しから添付ファイルの識別子を取得し、同じセッションでその識別子を使用して添付ファイルを取得する必要があります。

• 2026 年 3 月 30 日以降、isInline を true に設定した addFileAttachmentAsync または addFileAttachmentFromBase64Async への呼び出しが完了すると、Outlook on the web のメッセージと新しい Outlook on Windows のメッセージ内のインライン画像は、サーバーにアップロードされる間、ローカルに一時的な添付ファイル ID が割り当てられます。 添付ファイルの一時IDのプレフィックスは addinId。 画像がサーバーにアップロードされると、Exchange Web サービス (EWS) ID が割り当てられます。 一時添付ファイル ID は、現在の作成セッションの期間中のみサポートされます。 インライン画像の処理方法の変更の詳細については、「 Outlook アドインでのインライン画像の添付ファイル ID の変更」を参照してください。

• 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

取得する添付ファイルの識別子。 Outlook on the web と新しい Outlook on Windows では、サーバーにまだアップロードされていないインライン画像に対してローカルで生成される一時的な添付ファイル ID が、現在の作成セッションの間サポートされます。

callback

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

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

返品

void

注釈

API セット: メールボックス 1.8

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

対象となる Outlook モード: メッセージ Compose

重要:

• getAttachmentContentAsync メソッドは、指定された識別子を持つ添付ファイルをアイテムから取得します。 ベスト プラクティスとしては、 getAttachmentsAsync 呼び出しから添付ファイルの識別子を取得し、同じセッションでその識別子を使用して添付ファイルを取得する必要があります。

• 2026 年 3 月 30 日以降、isInline を true に設定した addFileAttachmentAsync または addFileAttachmentFromBase64Async への呼び出しが完了すると、Outlook on the web のメッセージと新しい Outlook on Windows のメッセージ内のインライン画像は、サーバーにアップロードされる間、ローカルに一時的な添付ファイル ID が割り当てられます。 添付ファイルの一時IDのプレフィックスは addinId。 画像がサーバーにアップロードされると、Exchange Web サービス (EWS) ID が割り当てられます。 一時添付ファイル ID は、現在の作成セッションの期間中のみサポートされます。 インライン画像の処理方法の変更の詳細については、「 Outlook アドインでのインライン画像の添付ファイル ID の変更」を参照してください。

• 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 プロパティにはエラーの理由を含むエラー コードが含まれます。 呼び出しが成功すると、 AttachmentDetailsCompose オブジェクトの配列が asyncResult.value プロパティで返されます。

返品

void

注釈

API セット: メールボックス 1.8

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

対象となる Outlook モード: メッセージ Compose

重要:

• 2026 年 3 月 30 日以降、isInline を true に設定した addFileAttachmentAsync または addFileAttachmentFromBase64Async への呼び出しが完了すると、Outlook on the web のメッセージと新しい Outlook on Windows のメッセージ内のインライン画像は、サーバーにアップロードされる間、ローカルに一時的な添付ファイル ID が割り当てられます。 添付ファイルの一時IDのプレフィックスは addinId。 画像がサーバーにアップロードされると、Exchange Web サービス (EWS) ID が割り当てられます。 一時添付ファイル ID は、現在の作成セッションの期間中のみサポートされます。 インライン画像の処理方法の変更の詳細については、「 Outlook アドインでのインライン画像の添付ファイル ID の変更」を参照してください。

• 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 プロパティにはエラーの理由を含むエラー コードが含まれます。 呼び出しが成功すると、 AttachmentDetailsCompose オブジェクトの配列が asyncResult.value プロパティで返されます。

返品

void

注釈

API セット: メールボックス 1.8

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

対象となる Outlook モード: メッセージ Compose

重要:

• 2026 年 3 月 30 日以降、isInline を true に設定した addFileAttachmentAsync または addFileAttachmentFromBase64Async への呼び出しが完了すると、Outlook on the web のメッセージと新しい Outlook on Windows のメッセージ内のインライン画像は、サーバーにアップロードされる間、ローカルに一時的な添付ファイル ID が割り当てられます。 添付ファイルの一時IDのプレフィックスは addinId。 画像がサーバーにアップロードされると、Exchange Web サービス (EWS) ID が割り当てられます。 一時添付ファイル ID は、現在の作成セッションの期間中のみサポートされます。 インライン画像の処理方法の変更の詳細については、「 Outlook アドインでのインライン画像の添付ファイル ID の変更」を参照してください。

• 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 プロパティには、アイテムの作成型と強制型のオブジェクトが含まれます。

返品

void

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

注釈

API セット: メールボックス 1.10

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

対象となる 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 プロパティには、アイテムの作成型と強制型のオブジェクトが含まれます。

返品

void

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

注釈

API セット: メールボックス 1.10

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

対象となる 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

注釈

API セット: メールボックス 1.14

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

対象となる 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

注釈

API セット: メールボックス 1.14

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

対象となる 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

注釈

API セット: メールボックス 1.8

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

対象となる 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

注釈

API セット: メールボックス 1.8

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

対象となる Outlook モード: メッセージ Compose

getItemClassAsync(options, callback)

選択したメッセージの Exchange Web サービス項目クラスを取得します。

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

注釈

API セット: メールボックス 1.14

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

対象となる 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 サービス項目クラスを取得します。

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

パラメーター

callback

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

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

返品

void

注釈

API セット: メールボックス 1.14

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

対象となる 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 サービス (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

注釈

API セット: メールボックス 1.8

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

対象となる 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

注釈

API セット: メールボックス 1.8

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

対象となる 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

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

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

1. メールボックスの所有者がメッセージを開始します。 これは、新しいメッセージ、返信、転送のいずれかです。

2. 彼らはメッセージを保存し、自分の [下書き ] フォルダーから代理人と共有しているフォルダーに移動します。

3. 代理人は共有フォルダーから下書きを開き、作成を続行します。

b. ユーザーのプライマリ メールボックス (Web、クラシック Windows) またはフル アカウントに昇格していない共有メールボックス (新しい Windows) と同じパネルで開かれている共有メールボックス

1. 共有メールボックス ユーザーがメッセージを開始します。 これは、新しいメッセージ、返信、転送のいずれかです。

2. メッセージを保存してから、自分の [下書き] フォルダーから共有メールボックス内のフォルダーに移動します。

3. 別の共有メールボックス ユーザーが共有メールボックスの下書きを開き、作成を続行します。

これらの条件が満たされると、メッセージは共有コンテキストで使用できるようになり、これらの共有シナリオをサポートするアドインはアイテムの共有プロパティを取得できます。 メッセージは送信後、通常、送信者の個人用メールボックスの [送信済みアイテム ] フォルダーで見つかります。

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

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

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

1. メールボックスの所有者がメッセージを開始します。 これは、新しいメッセージ、返信、転送のいずれかです。

2. 彼らはメッセージを保存し、自分の [下書き ] フォルダーから代理人と共有しているフォルダーに移動します。

3. 代理人は共有フォルダーから下書きを開き、作成を続行します。

b. ユーザーのプライマリ メールボックス (Web、クラシック Windows) またはフル アカウントに昇格していない共有メールボックス (新しい Windows) と同じパネルで開かれている共有メールボックス

1. 共有メールボックス ユーザーがメッセージを開始します。 これは、新しいメッセージ、返信、転送のいずれかです。

2. メッセージを保存してから、自分の [下書き] フォルダーから共有メールボックス内のフォルダーに移動します。

3. 別の共有メールボックス ユーザーが共有メールボックスの下書きを開き、作成を続行します。

これらの条件が満たされると、メッセージは共有コンテキストで使用できるようになり、これらの共有シナリオをサポートするアドインはアイテムの共有プロパティを取得できます。 メッセージは送信後、通常、送信者の個人用メールボックスの [送信済みアイテム ] フォルダーで見つかります。

getSharedPropertiesAsync メソッドは、追加条件なしで次のプラットフォームでサポートされます。

• [別のメールボックスを開く] オプションを使用して共有メールボックスを別のタブまたはウィンドウで開いた場合の Outlook on the web。

• 共有メールボックスがフル アカウントに昇格された場合の、Windows 上の新しい Outlook。

isClientSignatureEnabledAsync(options, callback)

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

Windows 上の Outlook (クラシック) では、新しいメッセージ、返信、または転送の既定の署名が、送信元の Outlook アカウントのテンプレートに設定されている場合、API 呼び出しによって true が返されます。 Outlook on the web および新しい Outlook on Windows では、作成の種類 newMail、reply、または forward に対して署名が有効になっている場合、API 呼び出しによって true が返されます。 Windows 上の Outlook (クラシック) で設定が「(なし)」に設定されている場合、または Windows 上の Outlook on the web または新しい Outlook で設定が無効になっている場合、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

注釈

API セット: メールボックス 1.10

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

対象となる Outlook モード: メッセージ Compose

isClientSignatureEnabledAsync(callback)

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

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

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

パラメーター

callback

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

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

返品

void

注釈

API セット: メールボックス 1.10

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

対象となる 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

注釈

API セット: メールボックス 1.1

カスタム プロパティの詳細については、「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

注釈

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

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

対象となる Outlook モード: メッセージ Compose

重要:

• Outlook on the web、新しい Outlook on Windows、またはオンライン モード (非キャッシュ モード) の Windows 上の従来の Outlook では、アイテムがサーバーに保存されます。 キャッシュ モードの Outlook では、ローカル キャッシュにアイテムが保存されます。

• HTML 形式のコンテンツを操作する場合、Outlook クライアントがコンテンツを変更する可能性があることに注意してください。 つまり、 Body.getAsync、 Body.setAsync、さらには saveAsync などのメソッドへの後続の呼び出しでは、同じ内容が得られない場合があります。

• 返される識別子は、Exchange Web サービス (EWS) の項目識別子と同じです。 返されるアイテム ID が、Outlook エントリ ID または Outlook REST API で使用される ID と同じではありません。 この値を使用して REST API 呼び出しを行う前に、 Office.context.mailbox.convertToRestId を使用して変換する必要があります。

• アドインがアイテム作成モードの saveAsync を呼び出して、EWS または REST API で使用するアイテム ID を取得する場合、Outlook がキャッシュ モードの場合、アイテムが実際にサーバーに同期されるまでに時間がかかる場合があることに注意してください。 アイテムが同期されるまで、アイテム ID を使用するとエラーが返されます。

• Windows 上の Outlook on the web および新しい Outlook では、共有メールボックス アカウントから送信されるメッセージに対して 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

注釈

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

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

対象となる Outlook モード: メッセージ Compose

重要:

• Outlook on the web、新しい Outlook on Windows、またはオンライン モード (非キャッシュ モード) の Windows 上の従来の Outlook では、アイテムがサーバーに保存されます。 キャッシュ モードの Outlook では、ローカル キャッシュにアイテムが保存されます。

• HTML 形式のコンテンツを操作する場合、Outlook クライアントがコンテンツを変更する可能性があることに注意してください。 つまり、 Body.getAsync、 Body.setAsync、さらには saveAsync などのメソッドへの後続の呼び出しでは、同じ内容が得られない場合があります。

• 返される識別子は、Exchange Web サービス (EWS) の項目識別子と同じです。 返されるアイテム ID が、Outlook エントリ ID または Outlook REST API で使用される ID と同じではありません。 この値を使用して REST API 呼び出しを行う前に、 Office.context.mailbox.convertToRestId を使用して変換する必要があります。

• アドインがアイテム作成モードの saveAsync を呼び出して、EWS または REST API で使用するアイテム ID を取得する場合、Outlook がキャッシュ モードの場合、アイテムが実際にサーバーに同期されるまでに時間がかかる場合があることに注意してください。 アイテムが同期されるまで、アイテム ID を使用するとエラーが返されます。

• Windows 上の Outlook on the web および新しい Outlook では、共有メールボックス アカウントから送信されるメッセージに対して 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

注釈

API セット: メールボックス 1.15

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

対象となる 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

注釈

API セット: メールボックス 1.15

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

対象となる Outlook モード: メッセージ Compose

重要:

• 選択した複数のメッセージの処理の詳細については、「 複数のメッセージに対して Outlook アドインをアクティブ化する」を参照してください。

• 選択したメール アイテムを loadItemByIdAsync を使用して読み込む場合は、処理後に unloadAsync を呼び出す必要があります。 この操作は、別の選択したアイテムで loadItemByIdAsync を呼び出す前に行う必要があります。