Office.Entities interface

パッケージ:

outlook

電子メール メッセージまたは予定に含まれているエンティティのコレクションを表します。 閲覧モードのみ。

Entities オブジェクトは、サーバーによって見つけられた 1 つ以上のエンティティがアイテム (電子メール メッセージまたは予定) に含まれている場合に、getEntities メソッドと getEntitiesByType メソッドによって返されるエンティティ配列のコンテナーです。 これらのエンティティをコード内で使用することにより、アイテム内のアドレスへのマップなどの追加のコンテキスト情報をビューアーに提供したり、アイテム内の電話番号に対してダイヤラーを開いたりできます。

プロパティで指定された型のエンティティがアイテムに存在しない場合、そのエンティティに関連付けられているプロパティは null です。 たとえば、メッセージに番地と電話番号が含まれている場合、address プロパティと phoneNumbers プロパティには情報が含まれます。その他のプロパティは null になります。

住所として認識されるには、文字列に米国の住所 (少なくとも番地、通り名、都市名、州名、郵便番号の要素を含む) が含まれている必要があります。

電話番号として認識されるためには、北アメリカの電話番号の形式を文字列に含める必要があります。

エンティティの認識には、大量のデータの機械学習に基づいた自然言語認識を利用しています。 エンティティの認識は決定論的ではなく、結果がアイテムの特定のコンテキストに左右されることがあります。

プロパティ配列が メソッドによって getEntitiesByType 返される場合、指定されたエンティティのプロパティにのみデータが含まれます。その他のプロパティはすべて null です。

注釈

最小アクセス許可レベル: アイテムの読み取り

適用される Outlook モード: 読み取り

重要: エンティティベースのコンテキスト Outlook アドインは、2024 年第 2 四半期に廃止される予定です。 この機能を廃止する作業は 5 月に開始され、6 月末まで継続されます。 6 月以降、コンテキスト アドインはメール アイテム内のエンティティを検出してタスクを実行できなくなります。 次の API も廃止されます。

• Office.context.mailbox.item.getEntities - Office.context.mailbox.item.getEntitiesByType - Office.context.mailbox.item.getFilteredEntitiesByName - Office.context.mailbox.item.getSelectedEntities

中断の可能性を最小限に抑えるために、エンティティ ベースのコンテキスト アドインが廃止された後も、次の機能がサポートされます。

• オンライン会議アドインによってアクティブ化される [会議に参加 ] ボタンの代替実装が開発されています。 エンティティベースのコンテキスト アドインのサポートが終了すると、オンライン会議アドインは自動的に別の実装に移行して [ 会議に参加 ] ボタンをアクティブ化します。

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

詳細については、「 エンティティ ベースのコンテキスト Outlook アドインの廃止」を参照してください。

プロパティ

addresses	電子メール メッセージまたは予定に含まれている物理的な住所 (番地または郵送先住所) を取得します。
contacts	電子メール アドレスまたは予定に含まれている連絡先を取得します。
emailAddresses	電子メール メッセージまたは予定に含まれている電子メール アドレスを取得します。
meetingSuggestions	電子メール メッセージ含まれている会議の提案を取得します。
phoneNumbers	電子メール メッセージや予定に含まれている電話番号を取得します。
taskSuggestions	電子メール メッセージまたは予定に含まれている、タスクの提案を取得します。
urls	電子メール メッセージまたは予定に含まれているインターネット URL を取得します。

プロパティの詳細

addresses

電子メール メッセージまたは予定に含まれている物理的な住所 (番地または郵送先住所) を取得します。

addresses: string[];

プロパティ値

string[]

例

const item = Office.context.mailbox.item;
const addresses = item.getEntitiesByType(Office.MailboxEnums.EntityType.Address);

contacts

電子メール アドレスまたは予定に含まれている連絡先を取得します。

contacts: Contact[];

プロパティ値

Office.Contact[]

例

const item = Office.context.mailbox.item;
const contacts = item.getEntitiesByType(Office.MailboxEnums.EntityType.Contact);

emailAddresses

電子メール メッセージまたは予定に含まれている電子メール アドレスを取得します。

emailAddresses: string[];

プロパティ値

string[]

例

const item = Office.context.mailbox.item;
const emailAddresses = item.getEntitiesByType(Office.MailboxEnums.EntityType.EmailAddress);

meetingSuggestions

電子メール メッセージ含まれている会議の提案を取得します。

meetingSuggestions: MeetingSuggestion[];

プロパティ値

Office.MeetingSuggestion[]

例

const item = Office.context.mailbox.item;
const meetingSuggestions = item.getEntitiesByType(Office.MailboxEnums.EntityType.MeetingSuggestion);

phoneNumbers

電子メール メッセージや予定に含まれている電話番号を取得します。

phoneNumbers: PhoneNumber[];

プロパティ値

Office.PhoneNumber[]

例

const item = Office.context.mailbox.item;
const phoneNumbers = item.getEntitiesByType(Office.MailboxEnums.EntityType.PhoneNumber);

taskSuggestions

電子メール メッセージまたは予定に含まれている、タスクの提案を取得します。

taskSuggestions: string[];

プロパティ値

string[]

例

const item = Office.context.mailbox.item;
const taskSuggestions = item.getEntitiesByType(Office.MailboxEnums.EntityType.TaskSuggestion);

urls

電子メール メッセージまたは予定に含まれているインターネット URL を取得します。

urls: string[];

プロパティ値

string[]

例

const item = Office.context.mailbox.item;
const urls = item.getEntitiesByType(Office.MailboxEnums.EntityType.Url);