閲覧または新規作成フォームの Outlook アイテム データを取得および設定する

  • [アーティクル]

Office アドイン マニフェスト スキーマのバージョン 1.1 以降、Outlook は、アイテムの表示または作成時にアドインをアクティブ化できます。 アドインが閲覧フォームまたは新規作成フォームのどちらでアクティブ化されるかによって、アイテムでアドインが使用できるプロパティも異なります。

たとえば、dateTimeCreated プロパティと dateTimeModified プロパティは送信済みのアイテム (アイテムは、その後閲覧フォームで表示されます) のみで定義され、(新規作成フォームで) メッセージの作成時にはこれらのプロパティは定義されません。 もう 1 つの例は bcc プロパティです。このプロパティは、(新規作成フォームで) メッセージを作成する場合にのみ使用でき、閲覧フォームでは使用できません。

新規作成フォームと閲覧フォームで使用できるアイテムのプロパティ

表 1 は、メール アドインの各モード (読み取りと新規作成) で使用できる Office JavaScript API のアイテム レベルのプロパティを示しています。通常、読み取りフォームで使用できるプロパティは読み取り専用であり、新規作成フォームで使用できるプロパティは読み取り/書き込みです。 itemId、 conversationId、 itemType プロパティは例外です。これは、常に読み取り専用です。

新規作成フォームで使用可能な残りのアイテムレベルのプロパティは、アドインとユーザーが同時に同じプロパティの読み取りまたは書き込みを行う可能性があるため、新規作成モードでこれらのプロパティの取得や設定を行うメソッドは非同期です。このため、これらのプロパティが返すオブジェクトの種類も、新規作成フォームと閲覧フォームとで異なることがあります。 新規作成フォームで非同期のメソッドを使用してアイテムレベルのプロパティを取得または設定することについて詳しくは、「Outlook で新規作成フォームのアイテム データを取得および設定する」をご覧ください。

表 1. 新規作成フォームと閲覧フォームで使用できるアイテムのプロパティ


アイテムの種類 プロパティ 閲覧フォームにおけるプロパティのタイプ 新規作成フォームにおけるプロパティのタイプ
予定とメッセージ dateTimeCreated JavaScript Date オブジェクト このプロパティは使用できません
予定とメッセージ dateTimeModified JavaScript Date オブジェクト このプロパティは使用できません
予定とメッセージ itemClass String このプロパティは使用できません
予定とメッセージ itemId String このプロパティは使用できません
予定とメッセージ itemType ItemType 列挙型の文字列 ItemType 列挙型の文字列 (読み取り専用)
予定とメッセージ attachments AttachmentDetails このプロパティは使用できません
予定とメッセージ body 本文 Body
予定とメッセージ normalizedSubject String このプロパティは使用できません
予定とメッセージ subject String Subject
予定 end JavaScript Date オブジェクト Time
予定 location String Location
予定 optionalAttendees EmailAddressDetails 受信者
予定 organizer EmailAddressDetails Organizer
予定 requiredAttendees EmailAddressDetails 受信者
予定 start JavaScript Date オブジェクト Time
メッセージ bcc このプロパティは使用できません 受信者
メッセージ cc EmailAddressDetails 受信者
メッセージ conversationId String String (読み取り専用)
メッセージ from EmailAddressDetails From
メッセージ internetMessageId 整数 このプロパティは使用できません
メッセージ sender EmailAddressDetails このプロパティは使用できません
メッセージ to EmailAddressDetails 受信者

Exchange Server コールバック トークンを閲覧アドインから使用する

Outlook アドインが閲覧フォームでアクティブ化されると、Exchange コールバック トークンを取得できます。 このトークンをサーバー側のコードで使用して、Exchange Web Services (EWS) を介してすべてのアイテムにアクセスできます。

アドイン マニフェストで アイテムの読み取りアクセス許可 を指定すると、 mailbox.getCallbackTokenAsync メソッドを使用して Exchange コールバック トークン、 mailbox.ewsUrl プロパティを使用してユーザーのメールボックスの EWS エンドポイントの URL を取得し、 item.itemId を使用して選択したアイテムの EWS ID を取得できます。 その後、コールバック トークン、EWS エンドポイントの URL、EWS アイテム ID をサーバー側のコードに渡して GetItem の操作にアクセスし、アイテムのその他のプロパティを取得することができます。

閲覧アドインまたは新規作成アドインから EWS にアクセスする

mailbox.makeEwsRequestAsync メソッドを使用すると、Exchange Web Services (EWS) の操作である GetItem および UpdateItem にアドインから直接アクセスすることもできます。 これらの操作を使用して、指定したアイテムの多数のプロパティを取得および設定できます。 このメソッドは、アドイン マニフェストで読み取り /書き込みメールボックス のアクセス許可を指定する限り、アドインが読み取りフォームまたは新規作成フォームでアクティブ化されているかどうかに関係なく、Outlook アドインで使用できます。 読み取り/書き込みメールボックスのアクセス許可の詳細については、「Outlook アドインのアクセス許可について」を参照してください。

makeEwsRequestAsync を使用した EWS の操作へのアクセスの詳細については、「Outlook アドインから Web サービスを呼び出す」を参照してください。

関連項目