Office.Contact interface

パッケージ:

outlook

アイテムの本文から抽出された連絡先 (物理的な連絡先やビジネス カードと同様) に関する詳細を表します。 閲覧モードのみ。

電子メール メッセージまたは予定の本文から抽出された連絡先の一覧は、contacts現在のアイテムの または getEntitiesByType メソッドによって返される Entities オブジェクトのプロパティでgetEntities返されます。

注釈

最小アクセス許可レベル: 制限

適用される 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 アドインの廃止」を参照してください。

例

const item = Office.context.mailbox.item;
// Get an array of strings that represent contacts in the current item's body.
const contacts = item.getEntitiesByType(Office.MailboxEnums.EntityType.Contact);
console.log("There are " + contacts.length + " contacts.")
contacts.forEach(function (contact) {
    console.log("Person name: " + JSON.stringify(contact.personName));
    console.log("Business name: " + JSON.stringify(contact.businessName));
    console.log("Addresses: " + JSON.stringify(contact.addresses));
    console.log("Phone numbers: " + JSON.stringify(contact.phoneNumbers));
    console.log("Email addresses: " + JSON.stringify(contact.emailAddresses));
    console.log("Urls: " + JSON.stringify(contact.urls));
});

/* Example email that includes contact details of sender, John Smith:
Hi there,
I have received the package.

Thanks.
John Smith
Account Manager
Contoso Corporation
1 Contoso Way, Redmond, WA 98052
john.smith@contoso.com
111-111-1111
https://contoso.com/john.smith
*/

プロパティ

addresses	連絡先に関連付けられているメールアドレスと住所を含む文字列の配列。 Null 許容型。
businessName	連絡先に関連付けられた取引先の名前が含まれている文字列。 Null 許容型。
emailAddresses	連絡先に関連付けられている SMTP メールアドレスを含む文字列の配列。 Null 許容型。
personName	連絡先に関連付けられた人物の名前が含まれている文字列。 Null 許容型。
phoneNumbers	連絡先に関連付けられた各電話番号の PhoneNumber オブジェクトが含まれている配列。 Null 許容型。
urls	連絡先に関連付けられているインターネットの URL を含む文字列の配列。 Null 許容型。

プロパティの詳細

addresses

連絡先に関連付けられているメールアドレスと住所を含む文字列の配列。 Null 許容型。

addresses: string[];

プロパティ値

string[]

businessName

連絡先に関連付けられた取引先の名前が含まれている文字列。 Null 許容型。

businessName: string;

プロパティ値

string

emailAddresses

連絡先に関連付けられている SMTP メールアドレスを含む文字列の配列。 Null 許容型。

emailAddresses: string[];

プロパティ値

string[]

personName

連絡先に関連付けられた人物の名前が含まれている文字列。 Null 許容型。

personName: string;

プロパティ値

string

phoneNumbers

連絡先に関連付けられた各電話番号の PhoneNumber オブジェクトが含まれている配列。 Null 許容型。

phoneNumbers: PhoneNumber[];

プロパティ値

Office.PhoneNumber[]

urls

連絡先に関連付けられているインターネットの URL を含む文字列の配列。 Null 許容型。

urls: string[];

プロパティ値

string[]