outlook package

インターフェイス

Office.Appointment

予定を処理する アイテムの サブクラス。

重要: これは内部の Outlook オブジェクトであり、既存のインターフェイスを通じて直接公開されることはありません。 これを Office.context.mailbox.item モードとして扱う必要があります。 詳細については、「 Outlook アイテム オブジェクト モデル」を参照してください。

子インターフェイス:

Office.AppointmentCompose

Office.context.mailbox.item の予定開催者モード。

重要: これは内部の Outlook オブジェクトであり、既存のインターフェイスを通じて直接公開されることはありません。 これを Office.context.mailbox.item モードとして扱う必要があります。 詳細については、「 Outlook アイテム オブジェクト モデル」を参照してください。

親インターフェイス:

Office.AppointmentForm

新しい予定を作成するためのフォームの詳細を表します。

Office.AppointmentRead

Office.context.mailbox.item の予定出席者モード。

重要: これは内部の Outlook オブジェクトであり、既存のインターフェイスを通じて直接公開されることはありません。 これを Office.context.mailbox.item モードとして扱う必要があります。 詳細については、「 Outlook アイテム オブジェクト モデル」を参照してください。

親インターフェイス:

Office.AttachmentDetails

サーバーからのアイテムの添付ファイルを表します。 閲覧モードのみ。

AttachmentDetailsオブジェクトの配列は、予定またはメッセージ アイテムの attachments プロパティとして返されます。

Office.Body

body オブジェクトは、メッセージまたは予定のコンテンツを追加および更新するためのメソッドを提供します。 選択した項目の body プロパティで返されます。

Office.CoercionTypeOptions

データ形式のオプションを指定します。

Office.Contact

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

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

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

Office.CustomProperties

CustomProperties オブジェクトは、特定のメール アイテムおよび Outlook アドインに固有のカスタム プロパティを表します。 たとえば、アドインをアクティブにした現在のメッセージに固有のデータをアドインで保存する必要がある場合があります。 ユーザーが後で同じメッセージに再度アクセスしてアドインを再度アクティブ化した場合、アドインはカスタム プロパティとして保存されたデータを取得できます。

CustomProperties の詳細については、「Outlook アドインのアドイン メタデータを取得して設定する」を参照してください

Office.Diagnostics

Outlook アドインに診断情報を提供します。

Office.EmailAddressDetails

電子メール メッセージまたは予定の送信者または指定受信者の電子メール プロパティを提供します。

Office.EmailUser

Exchange Server 上の電子メール アカウントを表します。

Office.Entities

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

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

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

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

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

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

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

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

Office.Item

アイテム名前空間は、現在選択されているメッセージ、会議出席依頼、または予定にアクセスするために使用されます。 itemType プロパティを使用して、項目の種類を特定できます。

特定の種類またはモードについてのみ IntelliSense を表示する場合は、この項目を次のいずれかにキャストします。

Office.ItemCompose

Office.context.mailbox.item の作成モード。

重要: これは内部の Outlook オブジェクトであり、既存のインターフェイスを通じて直接公開されることはありません。 これを Office.context.mailbox.item モードとして扱う必要があります。 詳細については、「 Outlook アイテム オブジェクト モデル」を参照してください。

子インターフェイス:

Office.ItemRead

Office.context.mailbox.item の読み取りモード。

重要: これは内部の Outlook オブジェクトであり、既存のインターフェイスを通じて直接公開されることはありません。 これを Office.context.mailbox.item モードとして扱う必要があります。 詳細については、「 Outlook アイテム オブジェクト モデル」を参照してください。

子インターフェイス:

Office.LocalClientTime

ローカルのクライアントのタイム ゾーンの日付と時刻を表します。 閲覧モードのみ。

Office.Location

Outlook アドインで会議の場所を取得し設定する方法を提供します。

Office.Mailbox

Microsoft Outlook アドイン オブジェクト モデルへのアクセスを提供します。

主なプロパティ:

  • diagnostics : Outlook アドインに診断情報を提供します。

  • item : Outlook アドインのメッセージまたは予定にアクセスするためのメソッドおよびプロパティを提供します。

  • userProfile : Outlook アドインでユーザーに関する情報を提供します。

Office.MeetingSuggestion

アイテムに含まれている提案された会議を表します。 閲覧モードのみ。

電子メール メッセージで提案された会議の一覧は、アクティブなアイテムで getEntities メソッドまたは getEntitiesByType メソッドが呼び出されたときに返される Entities オブジェクトの meetingSuggestions プロパティで返されます。

開始値と終了値は、提案された会議の開始日時と終了日時を含む Date オブジェクトの文字列表現です。 値は、現在のユーザーに対して指定された既定のタイム ゾーンです。

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

Office.Message

メッセージの アイテム のサブクラス。

重要: これは内部の Outlook オブジェクトであり、既存のインターフェイスを通じて直接公開されることはありません。 これを Office.context.mailbox.item モードとして扱う必要があります。 詳細については、「 Outlook アイテム オブジェクト モデル」を参照してください。

子インターフェイス:

Office.MessageCompose

Office.context.mailbox.item のメッセージ作成モード。

重要:

  • これは内部の Outlook オブジェクトであり、既存のインターフェイスを通じて直接公開されることはありません。 これを Office.context.mailbox.item モードとして扱う必要があります。 詳細については、「 Outlook アイテム オブジェクト モデル」を参照してください。

  • メッセージで Office.context.mailbox.item を呼び出すときは、Outlook クライアントの閲覧ウィンドウがオンになっている必要があることに注意してください。 閲覧ウィンドウを構成する方法については、「 閲覧ウィンドウを使用してメッセージをプレビューする」を参照してください。

親インターフェイス:

Office.MessageRead

Office.context.mailbox.item のメッセージ読み取りモード。

重要:

  • これは内部の Outlook オブジェクトであり、既存のインターフェイスを通じて直接公開されることはありません。 これを Office.context.mailbox.item モードとして扱う必要があります。 詳細については、「 Outlook アイテム オブジェクト モデル」を参照してください。

  • メッセージで Office.context.mailbox.item を呼び出すときは、Outlook クライアントの閲覧ウィンドウがオンになっている必要があることに注意してください。 閲覧ウィンドウを構成する方法については、「 閲覧ウィンドウを使用してメッセージをプレビューする」を参照してください。

親インターフェイス:

Office.NotificationMessageDetails

NotificationMessageDetails オブジェクトの配列は、NotificationMessages.getAllAsync メソッドによって返されます。

Office.NotificationMessages

NotificationMessages オブジェクトは、アイテムの notificationMessages プロパティとして返されます。

Office.PhoneNumber

アイテム内の識別される電話番号を表します。 閲覧モードのみ。

電子メール メッセージで見つかった電話番号を含む PhoneNumber オブジェクトの配列は、選択したアイテムに対して getEntities メソッドを呼び出したときに返される Entities オブジェクトの phoneNumbers プロパティで返されます。

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

Office.Recipients

アイテムの受信者を表します。 新規作成モードのみです。

Office.ReplyFormAttachment

ファイルまたはアイテムの添付ファイル。 返信フォームを表示するときに使用します。

Office.ReplyFormData

本文または添付ファイルのデータとコールバック関数を含む ReplyFormData オブジェクト。 返信フォームを表示するときに使用します。

Office.RoamingSettings

RoamingSettings オブジェクトのメソッドを使用して作成された設定は、アドインごと、およびユーザーごとに保存されます。 つまり、それらを作成したアドインと、それらが保存されているユーザーのメールボックスからのみ利用できます。

Outlook アドイン API は、これらの設定へのアクセスを作成したアドインのみに制限しますが、これらの設定をセキュリティで保護されたストレージと見なすべきではありません。 これらの設定は、Exchange Web サービスや拡張 MAPI からアクセスできます。 ユーザー資格情報やセキュリティ トークンなどの機密情報を格納するために使用しないでください。

設定の名前は String ですが、値は String、Number、Boolean、null、Object、Array のいずれかになります。

RoamingSettings オブジェクトには、Office.context 名前空間の roamingSettings プロパティを介してアクセスできます。

RoamingSettings の詳細については、「Outlook アドインのアドイン メタデータを取得して設定する」を参照してください

Office.Subject

Outlook のアドインで、予定またはメッセージの件名を取得および設定するメソッドを提供します。

Office.TaskSuggestion

アイテム内の識別される推奨タスクを表します。 閲覧モードのみ。

メール メッセージで提案されたタスクの一覧は、アクティブなアイテムで getEntities メソッドまたは getEntitiesByType メソッドが呼び出されたときに返される Entities オブジェクトの taskSuggestions プロパティで返されます。

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

Office.Time

作成モードでは、 Time オブジェクトは予定の start プロパティまたは end プロパティとして返されます。

Office.UserProfile

メールボックスに関連付けられているユーザーに関する情報。 これには、アカウントの種類、表示名、メール アドレス、タイム ゾーンが含まれます。

列挙型

Office.MailboxEnums.AttachmentType

添付ファイルの種類を指定します。

Office.MailboxEnums.BodyMode

複数のメッセージを含む会話スレッドへの返信に対して表示されるメッセージ本文の部分を指定します。

Office.MailboxEnums.EntityType

エンティティの種類を指定します。

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

Office.MailboxEnums.ItemNotificationMessageType

予定またはメッセージの通知メッセージの種類を指定します。

Office.MailboxEnums.ItemType

アイテムの種類を指定します。

Office.MailboxEnums.OpenLocation

アドインがデータにアクセスする場所を指定します。

Office.MailboxEnums.OWAView

Outlook on the web の現在のビューを表します。

Office.MailboxEnums.RecipientType

メッセージまたは予定の受信者の種類を指定します。

Office.MailboxEnums.ResponseType

会議出席依頼への応答の種類を指定します。

Office.MailboxEnums.RestVersion

REST 形式のアイテム ID に対応する REST API のバージョンを指定します。

Office.MailboxEnums.SaveLocation

アドインでデータを保存する場所を指定します。

Office.MailboxEnums.SourceProperty

アイテム内で選択したデータのソースを指定します (詳細については Office.mailbox.item.getSelectedDataAsync を参照してください)。