Office.LoadedMessageRead interface

パッケージ:

outlook

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

注釈

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

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

適用可能な Outlook モード: メッセージの読み取り

重要:

• アイテムの複数選択機能を実装するときに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();
            });
        });
    });
}

プロパティ

attachments	アイテムの添付ファイルを配列として取得します。
body	アイテムの本文と形式を取得します。
categories	項目のカテゴリを管理するメソッドを提供するオブジェクトを取得します。
cc	メッセージの Cc (カーボン コピー) 行の受信者を取得します。 cc プロパティは、メッセージの CC 行に記載されている各受信者の EmailAddressDetails オブジェクトを含む配列を返します。 返される受信者の最大数は、Outlook クライアントごとに異なります。 Windows (クラシック): 500 人の受信者 Windows (クラシック - バージョン 2511 (ビルド 19426.20000) 以降のプレビュー): 1,000 人の受信者 Web ブラウザー、Windows (新規): 20 人の受信者 (折りたたみ表示)、500 人の受信者 (展開表示)
conversationId	特定のメッセージが含まれている電子メールの会話の識別子を取得します。 メール アプリを閲覧フォームでアクティブ化するか、新規作成フォームの返信でアクティブ化すると、このプロパティで整数を取得することができます。 その後、ユーザーが返信の件名を変更した場合、その返信の送信時にメッセージの会話 ID が変更され、以前に取得した値は適用されなくなります。
dateTimeCreated	アイテムが作成された日時を取得します。
dateTimeModified	アイテムが最後に変更された日時を取得します。
end	予定を終了する日時を取得します。 end プロパティは、協定世界時 (UTC) の日付と時刻の値として表されるDate オブジェクトです。 convertToLocalClientTime メソッドを使用すると、end プロパティ値をクライアントのローカル日付と時刻に変換できます。 Time.setAsync メソッドを使用して終了時刻を設定する場合、convertToUtcClientTime メソッドを使用して、クライアント上のローカルの時刻をサーバーの UTC に変換する必要があります。
from	メッセージの送信者の電子メール アドレスを取得します。 from プロパティは EmailAddressDetails オブジェクトを返します。
internetMessageId	メッセージのインターネット メッセージ識別子を取得します。
itemClass	選択したメッセージの Exchange Web サービス項目クラスを取得します。
itemId	現在のアイテムの Exchange Web サービス アイテム識別子 を取得します。
itemType	インスタンスが表しているアイテムの種類を取得します。 itemType プロパティは、アイテム オブジェクト インスタンスがメッセージか予定かを示す、ItemType列挙値のいずれかを返します。
location	会議出席依頼の場所を取得します。 location プロパティは、予定の場所を格納した文字列を返します。
normalizedSubject	すべてのプレフィックス (RE: と FWD:を含む) を削除したアイテムの件名を取得します。 normalizedSubject プロパティは、メール プログラムによって追加された標準のプレフィックス (RE: や FW:など) と共に、アイテムの件名を取得します。 これらのプレフィックスが付いたままの状態でアイテムの件名を取得するには、subject プロパティを使用します。
notificationMessages	項目の通知メッセージを取得します。
recurrence	予定の繰り返しパターンを取得します。 会議出席依頼の定期的なパターンを取得します。 予定アイテムの読み取りおよび作成モード。 会議出席依頼アイテムの読み取りモード。 アイテムが系列または系列内のインスタンスである場合、 recurrence プロパティは定期的な予定または会議出席依頼の Recurrence オブジェクトを返します。 null は、1 つの予定および 1 つの予定の会議出席依頼に対して返されます。 undefined 会議出席依頼ではないメッセージに対して返されます。
sender	電子メール メッセージの送信者の電子メール アドレスを取得します。
seriesId	インスタンスが属するシリーズの ID を取得します。 Outlook on the web および Windows (新規およびクラシック) では、seriesIdは、このアイテムが属する親 (系列) アイテムの Exchange Web サービス (EWS) ID を返します。
start	予定を開始する日時を取得します。 start プロパティは、協定世界時 (UTC) の日付と時刻の値として表されるDate オブジェクトです。 convertToLocalClientTime メソッドを使用すると、値をクライアントのローカル日付と時刻に変換できます。
subject	アイテムの [件名] フィールドに表示される説明を取得します。 subject プロパティは、メール サーバーから送信されたアイテムの件名全体を取得します。 subject プロパティは文字列を返します。 normalizedSubject プロパティを使用して、件名から先頭プレフィックス (RE: や FW: など) を引いた値を取得します。
to	メッセージの To 行の受信者を取得します。 メッセージの To 行にある受信者へのアクセスを提供します。 オブジェクトのタイプとアクセス レベルは、現在の項目のモードによって異なります。 to プロパティは、メッセージの [宛先] 行に一覧表示された各受信者の EmailAddressDetails オブジェクトを含む配列を返します。 返される受信者の最大数は、Outlook クライアントごとに異なります。 Windows (クラシック): 500 人の受信者 Windows (クラシック - バージョン 2511 (ビルド 19426.20000) 以降のプレビュー): 1,000 人の受信者 Web ブラウザー、Windows (新規): 20 人の受信者 (折りたたみ表示)、500 人の受信者 (展開表示)

メソッド

displayReplyAllFormAsync(formData, options, callback)	選択したメッセージの送信者とすべての受信者、または選択した予定の開催者とすべての出席者を含む返信フォームを表示します。
displayReplyAllFormAsync(formData, callback)	選択したメッセージの送信者とすべての受信者、または選択した予定の開催者とすべての出席者を含む返信フォームを表示します。
displayReplyFormAsync(formData, options, callback)	選択したメッセージの送信者のみ、または選択した予定の開催者のみを含む回答フォームが表示されます。
displayReplyFormAsync(formData, callback)	選択したメッセージの送信者のみ、または選択した予定の開催者のみを含む回答フォームが表示されます。
getAllInternetHeadersAsync(options, callback)	メッセージのすべてのインターネット ヘッダーを文字列として取得します。 詳細については、「Outlook アドインでメッセージのインターネット ヘッダーを取得して設定する」を参照してください。
getAllInternetHeadersAsync(callback)	メッセージのすべてのインターネット ヘッダーを文字列として取得します。 詳細については、「Outlook アドインでメッセージのインターネット ヘッダーを取得して設定する」を参照してください。
getAsFileAsync(options, callback)	Base64 でエンコードされた EML 形式で現在のメッセージを取得します。
getAsFileAsync(callback)	Base64 でエンコードされた EML 形式で現在のメッセージを取得します。
getAttachmentContentAsync(attachmentId, options, callback)	メッセージまたは予定から添付ファイルを取得し、 AttachmentContent オブジェクトとして返します。
getAttachmentContentAsync(attachmentId, callback)	メッセージまたは予定から添付ファイルを取得し、 AttachmentContent オブジェクトとして返します。
getInitializationContextAsync(options, callback)	アクション可能なメッセージによってアドインがアクティブ化されたときに渡される初期化データを取得します。
getInitializationContextAsync(callback)	アクション可能なメッセージによってアドインがアクティブ化されたときに渡される初期化データを取得します。
getRegExMatches()	選択した項目のうち、XML マニフェスト ファイルで定義されている正規表現に一致する文字列値を返します。
getRegExMatchesByName(name)	選択した項目のうち、XML マニフェスト ファイルで定義されている名前付き正規表現と一致する文字列値を返します。
getSelectedRegExMatches()	XML マニフェスト ファイルで定義されている正規表現と一致する文字列値を強調表示した文字列値を返します。 強調表示された一致は、コンテキスト アドインに適用されます。
getSharedPropertiesAsync(options, callback)	共有フォルダーまたは共有メールボックス内の予定またはメッセージのプロパティを取得します。 この API の使用方法の詳細については、「Outlook アドインで共有フォルダーと共有メールボックスのシナリオを有効にする」を参照してください。
getSharedPropertiesAsync(callback)	共有フォルダーまたは共有メールボックス内の予定またはメッセージのプロパティを取得します。 この API の使用方法の詳細については、「Outlook アドインで共有フォルダーと共有メールボックスのシナリオを有効にする」を参照してください。
loadCustomPropertiesAsync(callback, userContext)	選択されたアイテムのこのアドインのカスタム プロパティを非同期に読み込みます。 カスタム プロパティは、アプリごと、アイテムごとにキーと値のペアとして格納されます。 このメソッドはコールバックで CustomProperties オブジェクトを返します。このオブジェクトには、現在の項目と現在のアドインに固有のカスタム プロパティにアクセスするメソッドが用意されています。 カスタム プロパティはアイテムで暗号化されていないため、これをセキュリティで保護されたストレージとして使用しないでください。 カスタム プロパティは asyncResult.value プロパティの CustomProperties オブジェクトとして指定されます。 このオブジェクトを使用して、メール アイテムからカスタム プロパティを取得できます。
unloadAsync(options, callback)	複数のメール アイテムを選択している場合は、現在読み込まれているアイテムを閉じて、選択した別のメール アイテムを処理対象として読み込むことができます。
unloadAsync(callback)	複数のメール アイテムを選択している場合は、現在読み込まれているアイテムを閉じて、選択した別のメール アイテムを処理対象として読み込むことができます。

プロパティの詳細

attachments

アイテムの添付ファイルを配列として取得します。

attachments: AttachmentDetails[];

プロパティ値

Office.AttachmentDetails[]

注釈

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

適用可能な Outlook モード: メッセージの読み取り

重要:

• セキュリティ上の問題がある可能性があるため、特定の種類のファイルは Outlook によってブロックされるので、返されません。 詳細については、「Outlook でブロックされる添付ファイル」を参照してください。

• [アップロードして共有] オプションを使用して追加した添付ファイルは返されません。

body

アイテムの本文と形式を取得します。

body: Body;

プロパティ値

Office.Body

注釈

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

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

適用可能な Outlook モード: メッセージの読み取り

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

categories

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

categories: Categories;

プロパティ値

Office.Categories

注釈

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

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

適用可能な Outlook モード: メッセージの読み取り

cc

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

cc プロパティは、メッセージの CC 行に記載されている各受信者の EmailAddressDetails オブジェクトを含む配列を返します。 返される受信者の最大数は、Outlook クライアントごとに異なります。

• Windows (クラシック): 500 人の受信者

• Windows (クラシック - バージョン 2511 (ビルド 19426.20000) 以降のプレビュー): 1,000 人の受信者

• Web ブラウザー、Windows (新規): 20 人の受信者 (折りたたみ表示)、500 人の受信者 (展開表示)

cc: EmailAddressDetails[];

プロパティ値

Office.EmailAddressDetails[]

注釈

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

適用可能な Outlook モード: メッセージの読み取り

conversationId

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

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

conversationId: string;

プロパティ値

string

注釈

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

適用可能な Outlook モード: メッセージの読み取り

dateTimeCreated

アイテムが作成された日時を取得します。

dateTimeCreated: Date;

プロパティ値

Date

注釈

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

適用可能な Outlook モード: メッセージの読み取り

dateTimeModified

アイテムが最後に変更された日時を取得します。

dateTimeModified: Date;

プロパティ値

Date

注釈

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

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

適用可能な Outlook モード: 予定の出席者

重要: このプロパティは Outlook on Android または iOS ではサポートされていません。 Outlook Mobile でサポートされている API の詳細については、「モバイル デバイスの Outlook でサポートされている Outlook JavaScript API」を参照してください。

end

予定を終了する日時を取得します。

end プロパティは、協定世界時 (UTC) の日付と時刻の値として表されるDate オブジェクトです。 convertToLocalClientTime メソッドを使用すると、end プロパティ値をクライアントのローカル日付と時刻に変換できます。

Time.setAsync メソッドを使用して終了時刻を設定する場合、convertToUtcClientTime メソッドを使用して、クライアント上のローカルの時刻をサーバーの UTC に変換する必要があります。

end: Date;

プロパティ値

Date

注釈

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

適用可能な Outlook モード: メッセージの読み取り

from

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

from プロパティは EmailAddressDetails オブジェクトを返します。

from: EmailAddressDetails;

プロパティ値

Office.EmailAddressDetails

注釈

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

適用可能な Outlook モード: メッセージの読み取り

重要:

• from プロパティと sender プロパティは、メッセージが代理送信アクセス許可を持つ代理人によって送信される場合を除き、同一ユーザーを表します。 この場合、 from プロパティはメールボックスの所有者または共有メールボックスの電子メール アドレスを返し、 sender プロパティは代理人のアドレスを返します。 代理人に [代理送信 ] アクセス許可と [送信者] アクセス許可の両方がある場合は、[ 送信者] アクセス許可が適用されます。 メールボックスの委任の詳細については、「Exchange Online で受信者のアクセス許可を管理する」を参照してください。

• from プロパティの EmailAddressDetails オブジェクトの recipientType プロパティが未定義です。

internetMessageId

メッセージのインターネット メッセージ識別子を取得します。

internetMessageId: string;

プロパティ値

string

注釈

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

適用可能な Outlook モード: メッセージの読み取り

重要: [ 送信済みアイテム ] フォルダーでは、最近送信したアイテムの internetMessageId がまだ利用できない場合があります。 その場合は、Exchange 環境に応じて、次のいずれかのオプションを使用することをお勧めします。

• Exchange Online の場合は、Microsoft Graph を使用して internetMessageId プロパティを取得します。

• Exchange Server (オンプレミス) の場合は、Exchange Web サービスを使用してサーバーから InternetMessageId プロパティを取得します。

itemClass

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

itemClass: string;

プロパティ値

string

注釈

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

適用可能な Outlook モード: メッセージの読み取り

重要:

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

アイテム クラス	説明
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	会議出席依頼に対する仮の受諾の通知

既定の項目クラスを拡張するカスタム クラスを作成できます。 たとえば、「 IPM.Note.Contoso」と入力します。

itemId

現在のアイテムの Exchange Web サービス アイテム識別子 を取得します。

itemId: string;

プロパティ値

string

注釈

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

適用可能な Outlook モード: メッセージの読み取り

重要:

• itemId プロパティは作成モードでは使用できません。 アイテム識別子が必要な場合は、 Office.context.mailbox.item.saveAsync メソッドを使用してストアにアイテムを保存できます。ストアでは、コールバック関数の asyncResult.value パラメーターでアイテム識別子が返されます。 アイテムが既に保存されている場合は、代わりに Office.context.mailbox.item.getItemIdAsync メソッドを呼び出すことができます。

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

itemType

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

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

itemType: MailboxEnums.ItemType | string;

プロパティ値

Office.MailboxEnums.ItemType | string

注釈

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

適用可能な Outlook モード: メッセージの読み取り

location

会議出席依頼の場所を取得します。

location プロパティは、予定の場所を格納した文字列を返します。

location: string;

プロパティ値

string

注釈

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

適用可能な Outlook モード: メッセージの読み取り

normalizedSubject

すべてのプレフィックス (RE: と FWD:を含む) を削除したアイテムの件名を取得します。

normalizedSubject プロパティは、メール プログラムによって追加された標準のプレフィックス (RE: や FW:など) と共に、アイテムの件名を取得します。 これらのプレフィックスが付いたままの状態でアイテムの件名を取得するには、subject プロパティを使用します。

normalizedSubject: string;

プロパティ値

string

注釈

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

適用可能な Outlook モード: メッセージの読み取り

notificationMessages

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

notificationMessages: NotificationMessages;

プロパティ値

Office.NotificationMessages

注釈

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

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

適用可能な Outlook モード: メッセージの読み取り

重要:

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

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

recurrence

予定の繰り返しパターンを取得します。 会議出席依頼の定期的なパターンを取得します。 予定アイテムの読み取りおよび作成モード。 会議出席依頼アイテムの読み取りモード。

アイテムが系列または系列内のインスタンスである場合、 recurrence プロパティは定期的な予定または会議出席依頼の Recurrence オブジェクトを返します。 null は、1 つの予定および 1 つの予定の会議出席依頼に対して返されます。 undefined 会議出席依頼ではないメッセージに対して返されます。

recurrence: Recurrence;

プロパティ値

Office.Recurrence

注釈

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

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

適用可能な Outlook モード: メッセージの読み取り

重要:

• 会議出席依頼の itemClass 値は IPM.Schedule.Meeting.Request です。

• recurrence オブジェクトが null の場合、オブジェクトが一連の予定ではなく、単一の予定または 1 つの予定の会議出席依頼であることを示します。

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

sender

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

sender: EmailAddressDetails;

プロパティ値

Office.EmailAddressDetails

注釈

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

適用可能な Outlook モード: メッセージの読み取り

重要:

• from プロパティと sender プロパティは、メッセージが代理送信アクセス許可を持つ代理人によって送信される場合を除き、同一ユーザーを表します。 この場合、 from プロパティはメールボックスの所有者または共有メールボックスの電子メール アドレスを返し、 sender プロパティは代理人のアドレスを返します。 代理人に [代理送信 ] アクセス許可と [送信者] アクセス許可の両方がある場合は、[ 送信者] アクセス許可が適用されます。 メールボックスの委任の詳細については、「Exchange Online で受信者のアクセス許可を管理する」を参照してください。

• sender プロパティの EmailAddressDetails オブジェクトの recipientType プロパティが未定義です。

seriesId

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

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

seriesId: string;

プロパティ値

string

注釈

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

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

適用可能な Outlook モード: メッセージの読み取り

重要:

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

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

start

予定を開始する日時を取得します。

start プロパティは、協定世界時 (UTC) の日付と時刻の値として表されるDate オブジェクトです。 convertToLocalClientTime メソッドを使用すると、値をクライアントのローカル日付と時刻に変換できます。

start: Date;

プロパティ値

Date

注釈

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

適用可能な Outlook モード: メッセージの読み取り

subject

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

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

subject プロパティは文字列を返します。 normalizedSubject プロパティを使用して、件名から先頭プレフィックス (RE: や FW: など) を引いた値を取得します。

subject: string;

プロパティ値

string

注釈

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

適用可能な Outlook モード: メッセージの読み取り

to

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

to プロパティは、メッセージの [宛先] 行に一覧表示された各受信者の EmailAddressDetails オブジェクトを含む配列を返します。 返される受信者の最大数は、Outlook クライアントごとに異なります。

• Windows (クラシック): 500 人の受信者

• Windows (クラシック - バージョン 2511 (ビルド 19426.20000) 以降のプレビュー): 1,000 人の受信者

• Web ブラウザー、Windows (新規): 20 人の受信者 (折りたたみ表示)、500 人の受信者 (展開表示)

to: EmailAddressDetails[];

プロパティ値

Office.EmailAddressDetails[]

注釈

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

適用可能な Outlook モード: メッセージの読み取り

メソッドの詳細

displayReplyAllFormAsync(formData, options, callback)

選択したメッセージの送信者とすべての受信者、または選択した予定の開催者とすべての出席者を含む返信フォームを表示します。

displayReplyAllFormAsync(formData: string | ReplyFormData, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

パラメーター

formData

string | Office.ReplyFormData

回答フォームの本文を表すテキストと HTML が含まれる文字列。 文字列は 32 KB に制限されています。または、本文または添付ファイル データとコールバック関数を含む ReplyFormData オブジェクトを指定してください。

options

Office.AsyncContextOptions

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

callback

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

省略可能。 メソッドが完了すると、callback パラメーターで渡された関数が、Office.AsyncResult オブジェクトである 1 つのパラメーター asyncResult を指定して呼び出されます。

返品

void

注釈

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

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

適用可能な Outlook モード: メッセージの読み取り

重要:

• Outlook on the web および新しい Outlook on Windows では、返信フォームは、3 列ビューではポップアップ フォーム、2 列または 1 列ビューではポップアップ フォームとして表示されます。

• 文字列パラメーターのいずれかが制限値を超えると、displayReplyAllFormAsync は例外をスローします。

• formData.attachments パラメーターで添付ファイルが指定されている場合、Outlook はすべての添付ファイルをダウンロードして、返信フォームに添付しようとします。 添付ファイルの追加に失敗すると、フォーム UI でエラーが表示されます。 表示できない場合、エラー メッセージはスローされません。

displayReplyAllFormAsync(formData, callback)

選択したメッセージの送信者とすべての受信者、または選択した予定の開催者とすべての出席者を含む返信フォームを表示します。

displayReplyAllFormAsync(formData: string | ReplyFormData, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

パラメーター

formData

string | Office.ReplyFormData

回答フォームの本文を表すテキストと HTML が含まれる文字列。 文字列は 32 KB に制限されています。または、本文または添付ファイル データとコールバック関数を含む ReplyFormData オブジェクトを指定してください。

callback

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

省略可能。 メソッドが完了すると、callback パラメーターで渡された関数が、Office.AsyncResult オブジェクトである 1 つのパラメーター asyncResult を指定して呼び出されます。

返品

void

注釈

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

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

適用可能な Outlook モード: メッセージの読み取り

重要:

• Outlook on the web および新しい Outlook on Windows では、返信フォームは、3 列ビューではポップアップ フォーム、2 列または 1 列ビューではポップアップ フォームとして表示されます。

• 文字列パラメーターのいずれかが制限値を超えると、displayReplyAllFormAsync は例外をスローします。

• formData.attachments パラメーターで添付ファイルが指定されている場合、Outlook はすべての添付ファイルをダウンロードして、返信フォームに添付しようとします。 添付ファイルの追加に失敗すると、フォーム UI でエラーが表示されます。 表示できない場合、エラー メッセージはスローされません。

displayReplyFormAsync(formData, options, callback)

選択したメッセージの送信者のみ、または選択した予定の開催者のみを含む回答フォームが表示されます。

displayReplyFormAsync(formData: string | ReplyFormData, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

パラメーター

formData

string | Office.ReplyFormData

回答フォームの本文を表すテキストと HTML が含まれる文字列。 文字列は 32 KB に制限されています。または、本文または添付ファイル データとコールバック関数を含む ReplyFormData オブジェクトを指定してください。

options

Office.AsyncContextOptions

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

callback

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

省略可能。 メソッドが完了すると、callback パラメーターで渡された関数が、Office.AsyncResult オブジェクトである 1 つのパラメーター asyncResult を指定して呼び出されます。

返品

void

注釈

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

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

適用可能な Outlook モード: メッセージの読み取り

重要:

• Outlook on the web および新しい Outlook on Windows では、返信フォームは、3 列ビューではポップアップ フォーム、2 列または 1 列ビューではポップアップ フォームとして表示されます。

• 文字列パラメーターのいずれかが制限値を超えると、displayReplyFormAsync は例外をスローします。

• formData.attachments パラメーターで添付ファイルが指定されている場合、Outlook はすべての添付ファイルをダウンロードして、返信フォームに添付しようとします。 添付ファイルの追加に失敗すると、フォーム UI でエラーが表示されます。 表示できない場合、エラー メッセージはスローされません。

displayReplyFormAsync(formData, callback)

選択したメッセージの送信者のみ、または選択した予定の開催者のみを含む回答フォームが表示されます。

displayReplyFormAsync(formData: string | ReplyFormData, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

パラメーター

formData

string | Office.ReplyFormData

回答フォームの本文を表すテキストと HTML が含まれる文字列。 文字列は 32 KB に制限されています。または、本文または添付ファイル データとコールバック関数を含む ReplyFormData オブジェクトを指定してください。

callback

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

省略可能。 メソッドが完了すると、callback パラメーターで渡された関数が、Office.AsyncResult オブジェクトである 1 つのパラメーター asyncResult を指定して呼び出されます。

返品

void

注釈

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

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

適用可能な Outlook モード: メッセージの読み取り

重要:

• Outlook on the web および新しい Outlook on Windows では、返信フォームは、3 列ビューではポップアップ フォーム、2 列または 1 列ビューではポップアップ フォームとして表示されます。

• 文字列パラメーターのいずれかが制限値を超えると、displayReplyFormAsync は例外をスローします。

• formData.attachments パラメーターで添付ファイルが指定されている場合、Outlook はすべての添付ファイルをダウンロードして、返信フォームに添付しようとします。 添付ファイルの追加に失敗すると、フォーム UI でエラーが表示されます。 表示できない場合、エラー メッセージはスローされません。

getAllInternetHeadersAsync(options, callback)

メッセージのすべてのインターネット ヘッダーを文字列として取得します。

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

getAllInternetHeadersAsync(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 プロパティに提供されます。 返される文字列値の書式設定情報については、 RFC 2183 を参照してください。 呼び出しが失敗した場合、 asyncResult.error プロパティにはエラーの理由を含むエラー コードが含まれます。

返品

void

注釈

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

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

適用可能な Outlook モード: メッセージの読み取り

getAllInternetHeadersAsync(callback)

メッセージのすべてのインターネット ヘッダーを文字列として取得します。

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

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

パラメーター

callback

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

省略可能。 メソッドが完了すると、callback パラメーターで渡された関数が、Office.AsyncResult オブジェクトである 1 つのパラメーター asyncResult を指定して呼び出されます。 成功すると、インターネット ヘッダー データは文字列として asyncResult.value プロパティに提供されます。 返される文字列値の書式設定情報については、 RFC 2183 を参照してください。 呼び出しが失敗した場合、 asyncResult.error プロパティにはエラーの理由を含むエラー コードが含まれます。

返品

void

注釈

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

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

適用可能な Outlook モード: メッセージの読み取り

getAsFileAsync(options, callback)

Base64 でエンコードされた EML 形式で現在のメッセージを取得します。

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

パラメーター

options

Office.AsyncContextOptions

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

callback

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

メソッドが完了すると、コールバック パラメーターに渡された関数が、Office.AsyncResult オブジェクトである 1 つのパラメーター asyncResult を使用して呼び出されます。 asyncResult.value プロパティでは、Base64 でエンコードされたメッセージの EML 形式が返されます。 発生したエラーはすべて asyncResult.error プロパティで返されます。

返品

void

注釈

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

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

適用可能な Outlook モード: メッセージの読み取り

getAsFileAsync(callback)

Base64 でエンコードされた EML 形式で現在のメッセージを取得します。

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

パラメーター

callback

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

メソッドが完了すると、コールバック パラメーターに渡された関数が、Office.AsyncResult オブジェクトである 1 つのパラメーター asyncResult を使用して呼び出されます。 asyncResult.value プロパティでは、Base64 でエンコードされたメッセージの EML 形式が返されます。 発生したエラーはすべて asyncResult.error プロパティで返されます。

返品

void

注釈

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

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

適用可能な Outlook モード: メッセージの読み取り

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

注釈

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

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

適用可能な Outlook モード: メッセージの読み取り

重要:

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

• 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

注釈

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

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

適用可能な Outlook モード: メッセージの読み取り

重要:

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

• Outlook on the web と新しい Outlook on Windows では、[アップロードして共有] オプションを使用して追加された添付ファイルはgetAttachmentContentAsyncサポートされません。

• Outlook on the web、モバイル デバイス、および新しい Outlook on Windows では、添付ファイル識別子は同じセッション内でのみ有効です。 ユーザーがアプリを閉じるか、ユーザーがインライン フォームの作成を開始した後、フォームをポップアウトして別のウィンドウで続行すると、セッションは終了です。

エラー:

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

• InvalidAttachmentId : 添付ファイル識別子は存在しません。

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 モード: メッセージの読み取り

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 モード: メッセージの読み取り

getRegExMatches()

選択した項目のうち、XML マニフェスト ファイルで定義されている正規表現に一致する文字列値を返します。

getRegExMatches(): any;

返品

any

マニフェスト XML ファイルで定義された正規表現に一致する文字列の配列が格納されたオブジェクト。 各配列の名前は、一致するItemHasRegularExpressionMatchルールの RegExName 属性または一致するItemHasKnownEntityルールの FilterName 属性の対応する値と等しくなります。 ルールの場合、そのルールで指定されたアイテムのプロパティに一致する文字列が発生する必要があります。ItemHasRegularExpressionMatch 単純型は、サポートされるプロパティを定義します。

注釈

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

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

適用可能な Outlook モード: 予定の出席者

重要:

• エンティティベースのコンテキスト Outlook アドインは廃止されました。 ただし、正規表現のルールは引き続きサポートされています。 代替ソリューションとして正規表現ルールを使用するように、コンテキスト アドインを更新することをお勧めします。 これらのルールの実装方法のガイダンスについては、「 Outlook のコンテキスト アドイン」を参照してください。

• このメソッドは、Outlook アドイン のアクティブ化ルール機能と一緒に使用しますが、これは Microsoft 365 の統合マニフェストでサポートされていません。

• 項目の body プロパティに ItemHasRegularExpressionMatch ルールを指定する場合、正規表現は本文をさらにフィルター処理し、項目の本文全体を返そうとしないでください。 .* などの正規表現を使用して項目の本文全体を取得すると、常に期待どおりの結果が返されるとは限りません。 この場合、代わりに Body.getAsync メソッドを使用して本文全体を取得します。

getRegExMatchesByName(name)

選択した項目のうち、XML マニフェスト ファイルで定義されている名前付き正規表現と一致する文字列値を返します。

getRegExMatchesByName(name: string): string[];

パラメーター

name

string

一致するフィルターを定義する ItemHasRegularExpressionMatch ルール要素の名前。

返品

string[]

指定された RegExName 要素値を使用して、マニフェスト XML ファイルの ItemHasRegularExpressionMatch ルール要素で定義された正規表現に一致する文字列を含む配列。

注釈

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

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

適用可能な Outlook モード: 予定の出席者

重要:

• エンティティベースのコンテキスト Outlook アドインは廃止されました。 ただし、正規表現のルールは引き続きサポートされています。 代替ソリューションとして正規表現ルールを使用するように、コンテキスト アドインを更新することをお勧めします。 これらのルールの実装方法のガイダンスについては、「 Outlook のコンテキスト アドイン」を参照してください。

• このメソッドは、Outlook アドイン のアクティブ化ルール機能と一緒に使用しますが、これは Microsoft 365 の統合マニフェストでサポートされていません。

• 項目の body プロパティに ItemHasRegularExpressionMatch ルールを指定する場合、正規表現は本文をさらにフィルター処理し、項目の本文全体を返そうとしないでください。 .* などの正規表現を使用して項目の本文全体を取得すると、常に期待どおりの結果が返されるとは限りません。 この場合、代わりに Body.getAsync メソッドを使用して本文全体を取得します。

getSelectedRegExMatches()

XML マニフェスト ファイルで定義されている正規表現と一致する文字列値を強調表示した文字列値を返します。 強調表示された一致は、コンテキスト アドインに適用されます。

getSelectedRegExMatches(): any;

返品

any

マニフェスト XML ファイルで定義された正規表現に一致する文字列の配列が格納されたオブジェクト。 各配列の名前は、一致する RegExName ルールの ItemHasRegularExpressionMatch 属性、または一致する FilterName ルールの ItemHasKnownEntity 属性の対応する値と等しくなります。 ルールの場合、そのルールで指定されたアイテムのプロパティに一致する文字列が発生する必要があります。ItemHasRegularExpressionMatch 単純型は、サポートされるプロパティを定義します。

注釈

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

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

適用可能な Outlook モード: メッセージの読み取り

重要:

• エンティティベースのコンテキスト Outlook アドインは廃止されました。 ただし、正規表現のルールは引き続きサポートされています。 代替ソリューションとして正規表現ルールを使用するように、コンテキスト アドインを更新することをお勧めします。 これらのルールの実装方法のガイダンスについては、「 Outlook のコンテキスト アドイン」を参照してください。

• このメソッドは、Outlook アドイン のアクティブ化ルール機能と一緒に使用しますが、これは Microsoft 365 の統合マニフェストでサポートされていません。

• 項目の body プロパティに ItemHasRegularExpressionMatch ルールを指定する場合、正規表現は本文をさらにフィルター処理し、項目の本文全体を返そうとしないでください。 .* などの正規表現を使用して項目の本文全体を取得すると、常に期待どおりの結果が返されるとは限りません。 この場合、代わりに Body.getAsync メソッドを使用して本文全体を取得します。

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 モード: メッセージの読み取り

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 モード: メッセージの読み取り

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 モード: メッセージの読み取り

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

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 を呼び出す前に行う必要があります。