Office.LoadedMessageRead interface

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

attachments: AttachmentDetails[];

プロパティ値

注釈

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

適用できる Outlook モード: メッセージの読み取り

注: 一部の種類のファイルは、潜在的なセキュリティの問題のために Outlook によってブロックされるため、返されません。 詳細については、「 Outlook でブロックされた添付ファイル」を参照してください。

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

body: Body;

プロパティ値

注釈

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

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

適用できる Outlook モード: メッセージの読み取り

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

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

categories: Categories;

プロパティ値

注釈

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

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

適用できる Outlook モード: メッセージの読み取り

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

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

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

• Web ブラウザー、新しい Outlook: 20 人の受信者 (折りたたまれたビュー)、500 人の受信者 (展開ビュー)

cc: EmailAddressDetails[];

プロパティ値

注釈

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

適用できる Outlook モード: メッセージの読み取り

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

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

conversationId: string;

プロパティ値

注釈

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

適用できる Outlook モード: メッセージの読み取り

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

dateTimeCreated: Date;

プロパティ値

注釈

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

適用できる Outlook モード: メッセージの読み取り

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

dateTimeModified: Date;

プロパティ値

注釈

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

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

適用できる Outlook モード: 予定出席者

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

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

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

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

end: Date;

プロパティ値

注釈

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

適用できる Outlook モード: メッセージの読み取り

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

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

from: EmailAddressDetails;

プロパティ値

注釈

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

適用できる Outlook モード: メッセージの読み取り

重要:

• メッセージが代理人から送信された場合を除き、from プロパティと sender プロパティは同一人物を表します。 その場合、 from プロパティは委任子を表し、 sender プロパティはデリゲートを表します。

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

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

internetMessageId: string;

プロパティ値

注釈

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

適用できる Outlook モード: メッセージの読み取り

重要: [送信済みアイテム] フォルダーでは、最近送信されたアイテムで internetMessageId をまだ使用できない場合があります。 その場合は、Exchange Web Services を使用してサーバーからこのプロパティを取得することを検討してください。

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

itemClass: string;

プロパティ値

注釈

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

適用できる Outlook モード: メッセージの読み取り

重要:

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

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

現在の アイテムの Exchange Web Services アイテム識別子 を取得します。

itemId: string;

プロパティ値

注釈

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

適用できる Outlook モード: メッセージの読み取り

重要:

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

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

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

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

itemType: MailboxEnums.ItemType | string;

プロパティ値

注釈

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

適用できる Outlook モード: メッセージの読み取り

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

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

location: string;

プロパティ値

注釈

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

適用できる Outlook モード: メッセージの読み取り

すべてのプレフィックスが削除された項目の件名を取得します (RE: と FWD:を含む)。

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

normalizedSubject: string;

プロパティ値

注釈

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

適用できる Outlook モード: メッセージの読み取り

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

notificationMessages: NotificationMessages;

プロパティ値

注釈

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

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

適用できる Outlook モード: メッセージの読み取り

重要:

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

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

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

recurrence: Recurrence;

プロパティ値

注釈

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

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

適用できる Outlook モード: メッセージの読み取り

重要:

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

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

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

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

sender: EmailAddressDetails;

プロパティ値

注釈

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

適用できる Outlook モード: メッセージの読み取り

重要:

• メッセージが代理人から送信された場合を除き、from プロパティと sender プロパティは同一人物を表します。 その場合、 from プロパティは委任子を表し、 sender プロパティはデリゲートを表します。

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

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

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

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

start: Date;

プロパティ値

注釈

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

適用できる Outlook モード: メッセージの読み取り

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

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

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

subject: string;

プロパティ値

注釈

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

適用できる Outlook モード: メッセージの読み取り

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

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

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

• Web ブラウザー、新しい Outlook: 20 人の受信者 (折りたたまれたビュー)、500 人の受信者 (展開ビュー)

to: EmailAddressDetails[];

プロパティ値

注釈

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

適用できる Outlook モード: メッセージの読み取り

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

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

パラメーター

戻り値

注釈

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

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

適用できる Outlook モード: メッセージの読み取り

重要:

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

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

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

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

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

パラメーター

戻り値

注釈

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

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

適用できる Outlook モード: メッセージの読み取り

重要:

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

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

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

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

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

パラメーター

戻り値

注釈

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

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

適用できる Outlook モード: メッセージの読み取り

重要:

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

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

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

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

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

パラメーター

戻り値

注釈

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

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

適用できる Outlook モード: メッセージの読み取り

重要:

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

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

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

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

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

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

パラメーター

戻り値

注釈

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

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

適用できる Outlook モード: メッセージの読み取り

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

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

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

パラメーター

戻り値

注釈

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

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

適用できる Outlook モード: メッセージの読み取り

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

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

パラメーター

戻り値

注釈

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

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

適用できる Outlook モード: メッセージの読み取り

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

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

パラメーター

戻り値

注釈

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

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

適用できる Outlook モード: メッセージの読み取り

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

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

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

パラメーター

戻り値

注釈

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

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

適用できる Outlook モード: メッセージの読み取り

エラー:

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

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

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

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

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

パラメーター

戻り値

注釈

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

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

適用できる Outlook モード: メッセージの読み取り

エラー:

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

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

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

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

パラメーター

戻り値

注釈

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

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

適用できる Outlook モード: メッセージの読み取り

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

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

パラメーター

戻り値

注釈

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

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

適用できる Outlook モード: メッセージの読み取り

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

getRegExMatches(): any;

戻り値

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

注釈

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

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

適用できる Outlook モード: 予定出席者

重要:

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

• このメソッドは、Outlook アドインのライセンス認証ルール機能で使用されます。これは、Microsoft 365 の統合マニフェストではサポートされていません。

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

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

getRegExMatchesByName(name: string): string[];

パラメーター

戻り値

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

注釈

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

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

適用できる Outlook モード: 予定出席者

重要:

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

• このメソッドは、Outlook アドインのライセンス認証ルール機能で使用されます。これは、Microsoft 365 の統合マニフェストではサポートされていません。

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

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

getSelectedRegExMatches(): any;

戻り値

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

注釈

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

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

適用できる Outlook モード: メッセージの読み取り

重要:

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

• このメソッドは、Outlook アドインのライセンス認証ルール機能で使用されます。これは、Microsoft 365 の統合マニフェストではサポートされていません。

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

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

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

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

パラメーター

戻り値

注釈

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

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

適用できる Outlook モード: メッセージの読み取り

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

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

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

パラメーター

戻り値

注釈

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

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

適用できる Outlook モード: メッセージの読み取り

選択されたアイテムのこのアドインのカスタム プロパティを非同期に読み込みます。

カスタム プロパティは、アプリごとに項目ごとにキーと値のペアとして格納されます。 このメソッドはコールバックで CustomProperties オブジェクトを返します。これにより、現在のアイテムと現在のアドインに固有のカスタム プロパティにアクセスするメソッドが提供されます。 カスタム プロパティはアイテムで暗号化されないため、セキュリティで保護されたストレージとして使用しないでください。

カスタム プロパティは asyncResult.value プロパティの CustomProperties オブジェクトとして指定されます。 このオブジェクトを使用して、メール アイテムからカスタム プロパティを取得できます。

loadCustomPropertiesAsync(callback: (asyncResult: Office.AsyncResult<CustomProperties>) => void, userContext?: any): void;

パラメーター

戻り値

注釈

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

カスタム プロパティの詳細については、「 Outlook アドインのアドイン メタデータを取得して設定する」を参照してください。

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

適用できる Outlook モード: メッセージの読み取り

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

複数のメール アイテムが選択されている場合は、現在読み込まれているアイテムを閉じて、選択した別のメール アイテムを処理用に読み込むことができます。

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

パラメーター

戻り値

注釈

[ API セット: メールボックス プレビュー ]

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

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

重要:

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

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

複数のメール アイテムが選択されている場合は、現在読み込まれているアイテムを閉じて、選択した別のメール アイテムを処理用に読み込むことができます。

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

パラメーター

戻り値

注釈

[ API セット: メールボックス プレビュー ]

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

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

重要:

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

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