outlook package

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

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

子インターフェイス:

• AppointmentCompose

• AppointmentRead

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

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

親インターフェイス:

• ItemCompose

• Appointment

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

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

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

親インターフェイス:

• ItemRead

• Appointment

Office.EventType.AppointmentTimeChanged イベントを発生させた予定の現在の日時を提供します。

メッセージまたは予定アイテムの添付ファイルのコンテンツを表します。

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

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

アイテムの添付ファイルを表します。 新規作成モードのみです。

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

Office.EventType.AttachmentsChanged イベントを発生させたメール アイテムの添付ファイルに関する情報を提供します。

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

アイテムのカテゴリを表します。

Outlook では、ユーザーはカテゴリを使用して色分けすることで、メッセージや予定にタグを付けることができます。 ユーザーがメールボックス のマスター リストでカテゴリ を定義する。 その後、アイテムに 1 つ以上のカテゴリを適用できます。

重要: Windows のOutlook on the webおよび新しい Outlook では、API を使用してComposeモードのメッセージに適用されるカテゴリを管理することはできません。

名前や関連する色などのカテゴリの詳細を表します。

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

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

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

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

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

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

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

マウス ポインターの位置と、 Office.EventType.DragAndDropEvent イベントが発生したときにアドインの作業ウィンドウにドラッグ アンド ドロップされるメッセージまたは添付ファイルの詳細を提供します。

メッセージまたは添付ファイルをアドインの作業ウィンドウにドラッグしたときの DragAndDropEventArgs.dragAndDropEventData オブジェクトを表します。

メッセージまたは添付ファイルがアドインの作業ウィンドウにドロップされるときの DragAndDropEventArgs.dragAndDropEventData オブジェクトを表します。

アドインの作業ウィンドウにドラッグ アンド ドロップされているメッセージまたは添付ファイルの内容と詳細を提供します。

アドインの作業ウィンドウにドラッグ アンド ドロップされるメッセージまたは添付ファイルを提供します。

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

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

予定の場所のセットを表します。

Office.EventType.EnhancedLocationsChanged イベントが発生したときに、現在の拡張位置情報を提供します。

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

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

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

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

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

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

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

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

Outlook アドインでメッセージの差出人値を取得するメソッドを提供します。

Office.EventType.InfobarClicked イベントを発生させた通知メッセージに関する基本的な詳細を提供します。

Office.EventType.InfobarClicked イベントを発生させた通知メッセージに関する追加の詳細を提供します。

InternetHeaders オブジェクトは、メッセージ アイテムが Exchange を離れて MIME メッセージに変換された後、保持されるカスタム インターネット ヘッダーを表します。

インターネット ヘッダーは、項目ごとに文字列キーと値のペアで格納されます。

注: このオブジェクトは、メッセージ アイテムのカスタム ヘッダーを設定して取得するためのものです。 詳細については、「Outlook アドインでメッセージのインターネット ヘッダーを取得して設定する」を参照してください。

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

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

• AppointmentCompose

• AppointmentRead

• MessageCompose

• MessageRead

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

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

子インターフェイス:

• AppointmentCompose

• MessageCompose

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

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

子インターフェイス:

• AppointmentRead

• MessageRead

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

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

場所を表します。 読み取り専用です。

場所の ID を表します。

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

主なプロパティ:

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

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

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

MailboxEvent オブジェクトはスマート アラート、統合されたスパム報告機能、暗号化解除などイベント ベースのアクティベーションを実装するアドインのイベント ハンドラーとして渡されます暗号化解除。 これにより、アドインは、イベントの処理が完了したことを Outlook クライアントに通知できます。

メールボックスのカテゴリ マスター リストを表します。

Outlook では、ユーザーはカテゴリを使用して色分けすることで、メッセージや予定にタグを付けることができます。 ユーザーは自分のメールボックスのマスター リストにカテゴリを定義します。 その後、アイテムに 1 つ以上のカテゴリを適用できます。

重要: デリゲートまたは共有シナリオでは、デリゲートはマスター リスト内のカテゴリを取得できますが、カテゴリを追加または削除することはできません。

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

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

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

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

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

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

子インターフェイス:

• MessageCompose

• MessageRead

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

重要:

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

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

親インターフェイス:

• ItemCompose

• Message

新しいメッセージを作成するためのフォームの詳細を表します。

ファイルまたは Outlook アイテムの添付ファイル。 新しいメッセージ フォームを表示するときに使用します。

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

重要:

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

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

親インターフェイス:

• ItemRead

• Message

通知メッセージに対するアクションの定義。

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

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

エイリアスまたは代理人を使用して予定を作成した場合でも、予定の開催者を表します。 このオブジェクトは、Outlook アドインで予定の開催者の値を取得するメソッドを提供します。

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

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

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

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

Office.EventType.RecipientsChanged イベントが発生したときの受信者フィールドの変更状態を提供します。

オブジェクトを表し RecipientsChangedEventArgs.changedRecipientFields 。

Recurrence オブジェクトには、予定の定期的なパターンを取得して設定するメソッドが用意されていますが、会議出席依頼の定期的なパターンのみを取得するメソッドが用意されています。 このファイルには、 seriesTime、 recurrenceType、 recurrenceProperties、 recurrenceTimeZone (省略可能) のキーを持つ辞書があります。

Office.EventType.RecurrenceChanged イベントを発生させた更新された再帰オブジェクトを提供します。

繰り返しのプロパティを表します。

定期的なタイム ゾーンを表します。

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

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

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

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

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

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

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

SeriesTime オブジェクトには、定期的な系列の予定の日時を取得および設定するメソッドと、定期的な系列の会議出席依頼の日時を取得するメソッドが用意されています。

項目のセッション データを管理するためのメソッドを提供します。

セッション データは 1 つのメール アイテムに固有です。 同じアドインを使用してデータを設定または取得する場合でも、複数のアイテム間で共有されることはありません。

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

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

スマート アラート アドインがOnMessageSendイベントまたはOnAppointmentSendイベントの処理を完了したときの動作を指定します。

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

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

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

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

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

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

通知メッセージ内のカスタム アクションの種類を指定します。

添付ファイルのコンテンツに適用される書式設定を指定します。

アイテムに添付ファイルが追加されたか、アイテムから削除されたかを指定します。

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

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

カテゴリの色を指定します。

メッセージの作成の種類を指定します。

曜日または曜日の種類を指定します。

このビットマスクは、共有フォルダーに対する代理人のアクセス許可を表します。

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

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

Office.EventType.InfobarClicked でサポートされているアクションの種類。

Office.EventType.InfobarClicked で許可されている通知の種類。

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

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

予定の場所の種類を指定します。

月を指定します。

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

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

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

繰り返しに適用されるタイム ゾーンを指定します。

繰り返しの種類を指定します。

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

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

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

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

月の週を指定します。