次の方法で共有

メール、予定表、連絡先、タスク REST API (バージョン 1.0) のリソース リファレンス

  • [アーティクル]

適用対象: Exchange Online | Office 365 | Hotmail.com | Live.com | MSN.com | Outlook.com | Passport.com

注意

Outlook REST API のバージョン 1.0 は廃止されます。 ** 2018 年 11 月 1 日** 以降、アプリは v1.0 REST エンドポイントで基本認証を使用することができなくなります。 2019 年 11 月 1 日までに、v1.0 REST エンドポイントは完全に使用停止になり、 v1.0 のドキュメントはその後間もなく削除されます。 Microsoft Graph の v1.0 での Outlook REST API を使用するように、アプリの移行を始めてください。 詳細については、このお知らせをご覧ください。

この記事では、REST API エンティティ、プロパティ、複合型、列挙型、OData クエリ パラメーターについて説明します。これらを、Outlook メール、予定表、連絡先、タスク の API で使用すると、Office 365、Hotmail.com、Live.com、MSN.com、Outlook.com、Passport.com のユーザー メールボックス データにアクセスできます。

注意

リファレンスをわかりやすくするため、この記事の残りの部分では Outlook.com を、これら Microsoft のアカウント ドメインを含無ものとして使用しています。

Outlook REST API のすべてのサブセットに共通な情報について詳しくは、「Outlook REST API の使用」を参照してください。

API v1.0 が不要な場合 左の目次で、** Office 365 REST API reference** セクションに移動し、使用したいバージョンを選択します。

ヒント

Web ブラウザー ($metadata など) で https://outlook.office.com/api/v1.0/$metadata エンドポイントに移動することによって、メール、予定表、連絡先、およびタスクのエンティティ データ モデルに関するメタデータ ドキュメントのすべてを表示できます。

添付ファイル

イベントまたはメッセージに添付されるファイルまたはアイテム (連絡先、イベント、メッセージ)です。
対応する fileAttachment、itemAttachment リソースは、Attachment リソースから派生します。

型: Microsoft.OutlookServices.Entity

プロパティ 型 説明 書き込み可能 フィルター処理可能
コンテンツ タイプ 文字列 添付ファイルの MIME タイプ。 はい いいえ
インライン​ ブール値 true 添付ファイルがインライン添付ファイルの場合は true、それ以外の場合は false。 はい はい
最後に変更された日時 日付/時刻オフセット 添付ファイルが最後に変更された日時です。 日付と時間はISO 8601形式を使用し、常に UTC 時間です。

たとえば、2014 年 1 月 1 日午前 0 時 (UTC) は、次のようになります。		 いいえ はい
名前 文字列 添付ファイルの表示名。実際のファイル名である必要はありません。 はい はい
サイズ Int32 添付ファイルの長さ (バイト単位)。 いいえ いいえ

予定表

イベントのコンテナーである予定表です。

型: Microsoft.OutlookServices.Calendar

Calendar コレクションは、OData 応答の value プロパティで予定表の配列を返します。$count を使用してコレクション内のエンティティ数 (.../me/calendars/$count) を取得します。 .../me/calendars/$count

サポートされているアクションについては、「Calendar の操作」を参照してください。

プロパティ 型 説明 書き込み可能 フィルター処理可能
名前 文字列 予定表の名前。 はい はい
変更キー 文字列 予定表オブジェクトのバージョンを識別します。予定表を変更するたびに ChangeKey も変更されます。これにより、Exchange は正しいバージョンのオブジェクトに変更を適用できます。 いいえ いいえ
色 予定表の色 UI で予定表を他の予定表から区別するための配色テーマを指定します。プロパティ値は次のとおりです。薄い青=0、薄い緑=1、薄いオレンジ=2、薄い灰色=3、薄い黄=4、薄い青緑=5、薄いピンク=6、薄い茶色=7、薄い赤=8、最大色=9、自動=-1 はい はい
ID 文字列 予定表の一意の識別子。 いいえ いいえ
予定表ビュー コレクション (イベント) 予定表のカレンダー ビュー。ナビゲーション プロパティです。 いいえ いいえ
イベント コレクション (イベント) 予定表内のイベント。ナビゲーション プロパティです。 いいえ いいえ

予定表のグループ

予定表のグループです。

注意

Outlook.com によってサポートされるのは、../me/calendars ショートカットでアクセス可能な既定の予定表グループのみです。 その予定表グループを削除することはできません。

型: Microsoft.OutlookServices.CalendarGroup

CalendarGroup コレクションは、OData 応答の value プロパティで予定表グループの配列を返します。$count を使用してコレクション内のエンティティ数 (.../me/calendargroups/$count) を取得します。 .../me/calendargroups/$count

サポートされているアクションについては、「CalendarGroup の操作」を参照してください。

プロパティ 型 説明 書き込み可能 フィルター処理可能
名前 文字列 グループの名前。 はい はい
変更キー 文字列 予定表グループのバージョンを識別します。予定表グループを変更するたびに ChangeKey も変更されます。これにより、Exchange は正しいバージョンのオブジェクトに変更を適用できます。 いいえ いいえ
クラス ID 文字列 クラス識別子。 いいえ はい
ID 文字列 予定表グループの一意の識別子。 いいえ いいえ
予定表 コレクション (予定表) 予定表グループ内の予定表。ナビゲーション プロパティです。 いいえ いいえ

連絡先

連絡先。ユーザーが通信する人や組織に関する情報を編成および保存するために使用する、Outlook 内のアイテムです。連絡先は連絡先フォルダーに格納されます。

型: Microsoft.OutlookServices.Contact

Contact コレクションは、OData 応答の value プロパティで連絡先の配列を返します。$count を使用してコレクション内のエンティティ数 (.../me/contacts/$count) を取得します。 .../me/contacts/$count

サポートされているアクションについては、「Contact の操作」を参照してください。

プロパティ 型 説明 書き込み可能 フィルター処理可能
アシスタント名 文字列 連絡先のアシスタントの名前。 はい はい
生年月日

| 日付/時刻オフセット|連絡先の誕生日です。|はい|はい| |勤務先住所| 物理アドレス|連絡先の勤務先の住所。|はい|はい| |勤務先のホームページ| 文字列|連絡先の勤務先のホーム ページ。|はい|はい| |勤務先の電話番号| コレクション (文字列)|連絡先の勤務先の電話番号。|はい|いいえ| |カテゴリ| コレクション (文字列)|連絡先に関連付けられたカテゴリ。|はい|いいえ| |変更キー| 文字列|連絡先のバージョンを識別します。連絡先を変更するたびに ChangeKey も変更されます。これにより、Exchange は正しいバージョンのオブジェクトに変更を適用できます。|いいえ|いいえ| |子供|コレクション (文字列)|連絡先の子供の名前。 |はい|はい| |会社名| 文字列|連絡先の会社の名前。|はい|はい| |部署| 文字列|連絡先の部署。|はい|はい| |​作成日時| 日付/時刻オフセット|連絡先が作成された時刻です。|いいえ|はい| |最終更新日時| 日付/時刻オフセット|連絡先が変更された時刻です。|いいえ|はい| |表示名| 文字列|連絡先の表示名。|はい|はい| |電子メールアドレス| コレクション (メールアドレス)|連絡先のメール アドレス。|はい|いいえ| |ファイルとして| 文字列|連絡先がファイルされる名前。|はい|はい| |ジェネレーション|文字列|連絡先の世代。|はい|はい| |名| 文字列|連絡先の名。|はい|はい| |ご住所| 物理アドレス|連絡先の自宅住所。|はい|はい| |自宅の電話番号| コレクション (文字列)|連絡先の自宅の電話番号。|はい|いいえ| |ID| 文字列|連絡先の一意の識別子。|いいえ|いいえ| |Im アドレス| コレクション (文字列)|連絡先のインスタント メッセージング (IM) アドレス。|はい|いいえ| |イニシャル| 文字列|連絡先のイニシャル。|はい|はい| |役職| 文字列|連絡先の役職。|はい|はい| |マネジャー| 文字列|連絡先の上司の名前。|はい|はい| |ミドルネーム| 文字列|連絡先のミドル ネーム。|はい|はい| |携帯電話番号1| 文字列|連絡先の携帯電話番号。|はい|はい| |ニックネーム| 文字列|連絡先のニックネーム。|はい|はい| |オフィス所在地|文字列|連絡先のオフィスの所在地。|はい|はい| |他の住所| 物理アドレス|連絡先の別の住所。|はい|はい| |親フォルダーID|文字列|連絡先の親フォルダーの ID。|いいえ|いいえ| |ユーザーのメモ|文字列|連絡先に関するユーザーのメモ。|はい|はい| |職業|文字列|連絡先の専門的職業。|はい|はい| |配偶者名|文字列|連絡先の配偶者の名前。|はい|はい| |姓 (ラストネーム)| 文字列|連絡先の姓。|はい|はい| |件名|文字列|連絡先の肩書。|はい|いいえ| |会社名のフリガナ|文字列|連絡先の会社名の読み仮名。このプロパティは省略可能です。|はい|いいえ| |名のフリガナ|文字列|連絡先の名 (ファースト ネーム) の読み仮名。このプロパティは省略可能です。|はい|いいえ| |姓のフリガナ|文字列|連絡先の姓 (ラスト ネーム) の読み仮名。このプロパティは省略可能です。|はい|いいえ|

連絡先フォルダー

連絡先が格納されたフォルダーです。

型: Microsoft.OutlookServices.ContactFolder

ContactFolder コレクションは、OData 応答の value プロパティで連絡先フォルダーの配列を返します。$count を使用してコレクション内のエンティティ数 (.../me/contactfolders/$count) を取得します。 .../me/contactfolders/$count

サポートされているアクションについては、「ContactFolder の操作」を参照してください。

プロパティ 型 説明 書き込み可能 フィルター処理可能
子フォルダー コレクション (連絡先フォルダー) フォルダー内の子フォルダーのコレクション。ナビゲーション プロパティです。 いいえ いいえ
連絡先 コレクション (連絡先) フォルダー内の連絡先。ナビゲーション プロパティです。 いいえ いいえ
表示名 文字列 フォルダーの表示名。 はい はい
ID 文字列 連絡先フォルダーの一意の識別子。 いいえ いいえ
親フォルダーID 文字列 フォルダーの親フォルダーの ID。 いいえ いいえ

イベント

予定表内のイベントです。

型: Microsoft.OutlookServices.Event

Event コレクションは、OData 応答の value プロパティでイベントの配列を返します。$count を使用してコレクション内のエンティティ数 (.../me/events/$count) を取得します。 .../me/events/$count

サポートされているアクションについては、「Event の操作」を参照してください。

プロパティ 型 説明 書き込み可能 フィルター処理可能
添付ファイル コレクション(添付ファイル) イベントの FileAttachment 添付ファイルと ItemAttachment 添付ファイルのコレクションです。ナビゲーション プロパティです。 いいえ いいえ
参加者 コレクション (参加者) イベントの参加者のコレクション。 はい いいえ
本文 アイテムの本文 イベントに関連付けられたメッセージの本文。 はい いいえ
本文プレビュー 文字列 イベントに関連付けられたメッセージのプレビュー。 いいえ いいえ
予定表 予定表 イベントを含む予定表。ナビゲーション プロパティです。 いいえ いいえ
カテゴリ コレクション (文字列) イベントに関連付けられたカテゴリ。 はい いいえ
変更キー 文字列 イベント オブジェクトのバージョンを識別します。イベントを変更するたびに ChangeKey も変更されます。これにより、Exchange は正しいバージョンのオブジェクトに変更を適用できます。 いいえ いいえ
​作成日時 日付/時刻オフセット イベントが作成された日時です。 いいえ はい
最終更新日時 日付/時刻オフセット イベントが最後に変更された日時です。 いいえ はい
終了 日付/時刻オフセット イベントが終了する日時。

既定で、終了時刻は UTC 単位です。EndTimeZone でオプションのタイム ゾーンを指定して、そのタイム ゾーンで終了時刻を表現し、UTC からの時間オフセットを含めることができます。EndTimeZone を使用する場合、StartTimeZone の値も指定する必要があります。

この例では、太平洋標準時で 2015 年 2 月 25 日午後 9:34 を指定します ("2015-02-25T21:34:00-08:00")。		 はい はい
EndTimeZone 文字列 会議終了時刻のタイム ゾーンを識別します (End プロパティを参照)。このプロパティは、Windows に格納されているタイム ゾーン名に設定されます。System.TimeZoneInfo.GetSystemTimeZones() を呼び出すことによって、タイム ゾーン名を取得できます。

このプロパティは、v1.0 では省略可能です。ただし、StartTimeZone プロパティを使用する場合は、このプロパティを使用する必要があります。

詳細については、「TimeZone」を参照してください。		 はい いいえ
添付ファイル付き ブール値 イベントに添付ファイルが含まれている場合に、true に設定します。 いいえ はい
ID 文字列 イベントの一意識別子。 いいえ いいえ
重要度 重要度 イベントの重要度: Low、Normal、High。 はい はい
インスタンス コレクション (イベント) イベントのインスタンス。ナビゲーション プロパティです。 いいえ いいえ
iCalUID 文字列 複数の予定表を通して 1 つのイベントのすべてのインスタンスで共有される一意の識別子。 いいえ はい
一日中 ブール値 イベントが一日中続く場合に、true に設定します。このプロパティを調整するには、イベントの Start および End プロパティの調整も必要になります。 はい はい
キャンセルされます ブール値 イベントがキャンセルされた場合に、true に設定します。 はい はい
主催者 ブール値 メッセージの送信者が主催者でもある場合に、true に設定します。 はい はい
場所​ 場所​ イベントの場所。 はい はい
主催者 受信者 イベントの主催者。 はい はい
再発 パターン化された繰り返し イベントの繰り返しパターン。 はい いいえ
要求の応答 ブール値 イベントが承諾または辞退されたときに、送信者が応答を要求する場合に、true に設定します。 はい はい
応答ステータス 応答ステータス イベント メッセージへの応答で送信される応答のタイプを識別します。 いいえ はい
感度 感度 イベントのプライバシーのレベルを示します。標準 = 0、個人 = 1、非公開 = 2、社外秘 = 3 です。 はい はい
一連のマスター ID 文字列 アイテムに割り当てられたカテゴリ。 はい いいえ
表示形式 空き時間状態 次のようなステータスを示します。予定なし = 0、仮の予定 = 1、予定あり = 2、休暇 = 3、離席 = 4、不明 = -1。 はい 可能
開始 日付/時刻オフセット イベントの開始時刻です。

既定で、開始時刻は UTC 単位です。EndTimeZone でオプションのタイム ゾーンを指定して、そのタイム ゾーンで開始時刻を表現し、UTC からの時間オフセットを含めることができます。StartTimeZone を使用する場合、EndTimeZone の値も指定する必要があります。

この例では、太平洋標準時で 2015 年 2 月 25 日午後 7:34 を指定します "2015-02-25T19:34:00-08:00".		 はい はい
開始タイムゾーン 文字列 会議開始時刻のタイム ゾーンを識別します (Start プロパティを参照)。このプロパティは、クライアントの代わりにサービスがタイム ゾーンの変更を処理できるようにします。このプロパティは、Windows に格納されているタイム ゾーン名に設定されます。System.TimeZoneInfo.GetSystemTimeZones() を呼び出すことによって、タイム ゾーン名を取得できます。

このプロパティは、v1.0 では省略可能です。ただし、EndTimeZone プロパティを使用する場合は、このプロパティを使用する必要があります。

このプロパティの値の例は、"太平洋標準時" です。詳細については、「TimeZone」を参照してください。		 はい いいえ
件名 文字列 イベントの件名行のテキスト。 はい はい
型 イベントの種類 次のようなイベント タイプがあります。単一インスタンス = 0、発生 = 1、例外 = 2、連続マスター = 3。 はい はい
ウェブリンク 文字列 Outlook Web App でイベントを開く URL。

Outlook Web App のメールボックスにログインしている場合、ブラウザーでイベントが開きます。まだブラウザーでログインしていない場合、ログインするように求められます。

この URL には、iFrame 内からアクセスできます。		 いいえ いいえ

イベント メッセージ

会議出席依頼、会議中止メッセージ、会議承諾メッセージ、会議仮承諾メッセージ、または会議辞退メッセージを表すメッセージです。

基本型: Message

通常、EventMessage インスタンスは、イベント主催者が会議を作成した結果、または、参加者が会議出席依頼に応答した結果として、受信トレイ フォルダーに届けられます。イベント メッセージには Message と同様の方法で対処しますが、次の表に示すようなわずかな違いがあります。

アクション/動詞 アクセス許可 説明
イベント メッセージの作成 (POST) 該当なし 許可されていません。400 応答コードが生成されます。
イベント メッセージの更新 (PATCH) メールを書く From、Sender、ToRecipients、CcRecipients、BccRecipients、ReplyTo、IsDeliveryReceiptRequested、IsReadReceiptRequested、IsDraft、IsRead、Subject、Body、Importance、および Categories の各プロパティを更新できます。
イベント メッセージの削除 (DELETE) メールを書く Message の場合と同じアクションです。
イベント メッセージの移動 (POST) メールを書く Message の場合と同じアクションです。
イベント メッセージのコピー (POST) メールを書く Message の場合と同じアクションです。
返信メッセージの下書きの作成 (POST) メールを書く Message の場合と同じアクションです。
全員に返信メッセージの下書きの作成 (POST) メールを書く Message の場合と同じアクションです。
返信の作成 (POST) メールを書く Message の場合と同じアクションです。
全員に返信の作成 (POST) メールを書く Message の場合と同じアクションです。
既存のイベント メッセージの送信 (POST) メールを書く IsDraft プロパティの値が true になっているイベント メッセージのみを送信できます。メッセージのコピーは送信済みアイテム フォルダーに保存されます。
転送イベント メッセージの下書きの作成 メールを書く Message の場合と同じアクションです。
イベント メッセージの転送 メールを書く Message の場合と同じアクションです。

EventMessage インスタンスには、基本型の Message のプロパティと、次の表のプロパティが含まれます。

プロパティ 型 説明 書き込み可能 フィルター処理可能
イベント イベント イベント メッセージに関連付けられたイベント。参加者または部屋リソースの前提は、会議出席依頼イベント メッセージが届いたときにイベントを含む予定表を自動的に更新するようにカレンダー アテンダントが設定されていることです。ナビゲーション プロパティです。 いいえ いいえ
会議メッセージの種類 会議メッセージの種類 イベント メッセージのタイプ。なし = 0、会議開催依頼 = 1、会議の中止 = 2、会議の承諾 = 3、会議の一時承諾 = 4、会議の辞退 = 5。 いいえ はい

イベント メッセージ要求 (プレビュー)

この機能は現在ベータ版および v2.0 で利用できます。 詳細を確認するには、左側の目次で、 ** Office 365 REST API リファレンス** のセクションに移動し、 ** ベータ版** を選択します。

拡張プロパティ

この機能は現在ベータ版および v2.0 で利用できます。 左側の目次で、Office 365 REST API リファレンス セクションに移動し、使用したいバージョンを選択します。

添付ファイル

メッセージまたはイベントに関連付けられている (テキスト ファイル、または Word 文書) などのファイルです。 ContentBytes プロパティには、base64 でエンコードされたファイルの内容が含まれています。 添付ファイル のエンティティから派生します。

型: Microsoft.OutlookServices.FileAttachment

基本型: Microsoft.OutlookServices.Attachment

プロパティ 型 説明 書き込み可能
コンテンツのバイト単位 バイナリ ファイルのバイナリ コンテンツです。 いいえ
コンテンツ ID 文字列 Exchange ストア内の添付ファイルの ID。 いいえ
コンテンツの場所 文字列 添付ファイルのコンテンツの場所に対応する Uniform Resource Identifier (URI)。 いいえ
コンテンツ タイプ 文字列 添付ファイルのコンテンツ タイプ。 はい
最終更新日時 日付/時刻オフセット 添付ファイルが最後に変更された日時です。 いいえ
ID 文字列 添付ファイル ID。 いいえ
連絡先の写真 ブール値 現在は使用されていません。 はい
インライン ブール値 インライン添付ファイルの場合、true に設定します。 はい
名前 文字列 埋め込み添付ファイルを表すアイコンの下に表示されるテキストを表す名前。これは、実際のファイル名にする必要はありません。 はい
サイズ Int32 添付ファイルのバイト単位のサイズ。 いいえ

フォルダー/メールフォルダー

注意

バージョン 1.0 以降では、Folder エンティティと型が MailFolder という名前に変更されました。

受信トレイ、下書き、送信済みアイテムなどのユーザーのメールボックス内のフォルダーです。フォルダーにはメッセージと他のフォルダーを含めることができます。

型: Microsoft.OutlookServices.Folder

Folder コレクションは、OData 応答の value プロパティでフォルダーの配列を返します。$count を使用してコレクション内のエンティティ数 (.../me/folders/$count) を取得します。 .../me/folders/$count

サポートされているアクションについては、「Folder の操作」を参照してください。

プロパティ 型 説明 書き込み可能 フィルター処理可能
子フォルダー数 Int32 フォルダー内のフォルダー数。 いいえ はい
子フォルダー コレクション (フォルダー) フォルダー内の子フォルダーのコレクション。ナビゲーション プロパティです。 いいえ いいえ
表示名 文字列 フォルダーの表示名。 はい はい
ID 文字列 フォルダーの一意の識別子。 次の既知の名前を使用して対応するフォルダーにアクセスできます。Inbox、Drafts、SentItems、DeletedItems。 いいえ いいえ
メッセージ コレクション (メッセージ) フォルダー内のメッセージのコレクション。ナビゲーション プロパティです。 いいえ いいえ
親フォルダーID 文字列 フォルダーの親フォルダーの一意の識別子。 いいえ いいえ
合計項目数 Int32 フォルダーに含まれるアイテムの数。 いいえ はい
未読アイテム数 Int32 フォルダー内で未読としてマークされているアイテム数。 いいえ はい

アイテム数の効率的な取得

フォルダーの TotalItemCount プロパティと UnreadItemCount プロパティを使用すると、ファイル内の既読アイテム数を簡単に算出できます。 これにより、大幅な遅延が発生する可能性がある次のようなクエリを回避できます。

https://outlook.office.com/api/v1.0/me/folders/inbox/messages?$count=true&$filter=isread%20eq%20false

Outlook 内のフォルダーには、複数の種類のアイテムを含めることができます。たとえば、受信トレイには、メール アイテムとは異なる会議出席依頼アイテムを入れることができます。TotalItemCount と UnreadItemCount には、アイテムの種類に関係なく、フォルダー内のアイテムが含まれます。

推論の分類

この機能は現在 v2.0 とベータ版で利用できます。 詳細を確認するには、左側の目次で、 Office 365 REST API リファレンス のセクションに移動し、これらのバージョンのいずれかを選択します。

推論分類オーバーライド

この機能は現在 v2.0 とベータ版で利用できます。 詳細を確認するには、左側の目次で、 Office 365 REST API リファレンス のセクションに移動し、これらのバージョンのいずれかを選択します。

項目の添付ファイル

別のメッセージまたはイベントに添付されたメッセージ、連絡先、またはイベントです。 添付ファイル エンティティから派生します。

型: Microsoft.OutlookServices.ItemAttachment

基本型: Microsoft.OutlookServices.Attachment

プロパティ 型 説明 書き込み可能
コンテンツ タイプ 文字列 添付ファイルのコンテンツ タイプ。 はい
最終更新日時 日付/時刻オフセット 添付ファイルが変更された最後の日時です。 いいえ
ID 文字列 添付ファイル ID。 いいえ
​アイテム ​アイテム 添付されたメッセージまたはイベントです。ナビゲーション プロパティです。 はい
インライン​ ブール値 添付ファイルがインライン (アイテムの本文に埋め込まれた画像など) の場合に、true に設定します。 はい
名前 文字列 添付ファイルの表示名。 はい
サイズ Int32 添付ファイルのバイト単位のサイズ。 はい

説明 (プレビュー)

この機能は現在ベータ版でのみ利用できます。 詳細を確認するには、左側の目次で、 ** Office 365 REST API リファレンス** のセクションに移動し、 ** ベータ版** を選択します。

メッセージ

メールボックス フォルダー内のメッセージです。

型: Microsoft.OutlookServices.Message

Message コレクションは、OData 応答の value プロパティでメッセージの配列を返します。$count を使用してコレクション内のエンティティ数 (.../me/messages/$count) を取得します。 .../me/messages/$count

サポートされているアクションについては、「Message の操作」を参照してください。

プロパティ 型 説明 書き込み可能 フィルター処理可能 検索可能かどうか
添付ファイル コレクション(添付ファイル) メッセージの FileAttachment 添付ファイルと ItemAttachment 添付ファイル。ナビゲーション プロパティです。 はい いいえ はい
BCC 受信者 コレクション(受信者) メッセージの BCC 受信者。 はい いいえ はい
本文 アイテムの本文 メッセージの本文。 はい いいえ 既定
本文プレビュー 文字列 メッセージ本文の内容の最初の 255 文字。 いいえ いいえ はい
カテゴリ コレクション (文字列) メッセージに関連付けられたカテゴリ。 はい はい はい
CC 受信者 コレクション(受信者) メッセージの CC 受信者。 はい いいえ はい
変更キー 文字列 メッセージのバージョン。 いいえ いいえ いいえ
会話 ID 文字列 電子メールが属している会話の ID。 いいえ はい いいえ
​作成日時 日付/時刻オフセット メッセージが作成された日時です。 いいえ はい いいえ
最終更新日時 日付/時刻オフセット メッセージが最後に変更された日時です。 いいえ はい いいえ
受信した日時 日付/時刻オフセット メッセージが受信された日時です。 いいえ はい はい
送信日時 日付/時刻オフセット メッセージが送信された日時です。 いいえ はい いいえ
From 受信者 メッセージのメールボックス所有者と送信者。 はい はい はい
添付ファイル付き ブール値 メッセージに添付ファイルがあるかどうかを示します。 はい はい はい
ID 文字列 メッセージの一意識別子。 いいえ いいえ いいえ
重要度 重要度 次のようなメッセージの重要度があります。低 = 0、標準 = 1、高 = 2。 はい はい はい
配信確認の要求 ブール値 メッセージの開封応答が要求されているかどうかを示します。 はい はい いいえ
下書き ブール値 メッセージが下書きかどうかを示します。メッセージがまだ送信されていなければ下書きです。 いいえ はい いいえ
既読 ブール値 メッセージが読み取られたかどうかを示します。 はい はい いいえ
開封通知を要求 ブール値 メッセージの開封応答が要求されているかどうかを示します。 はい はい いいえ
親フォルダーID 文字列 メッセージの親フォルダーの一意の識別子。 いいえ いいえ いいえ
返信先 コレクション(受信者) 返信時に使用される電子メール アドレス。 はい いいえ いいえ
送信者 受信者 メッセージを生成するために実際に使用されるアカウント。 はい はい 既定
件名 文字列 メッセージの件名を指定します。 はい はい 既定
メッセージの宛先 コレクション(受信者) メッセージの宛先。 はい いいえ はい
独自の本文 アイテムの本文 会話に特有のメッセージの本文。 いいえ いいえ いいえ
ウェブリンク 文字列 Outlook Web App でメッセージを開く URL。

URL の末尾に ispopout 引数を付加して、メッセージの表示方法を変更できます。ispopout が存在しない、または 1 に設定されている場合は、メッセージがポップアウト ウィンドウに表示されます。ispopout が 0 に設定されている場合、ブラウザーの Outlook Web App レビュー ウィンドウにメッセージが表示されます。

Outlook Web App のメールボックスにログインしている場合、ブラウザーでメッセージが開きます。まだブラウザーでログインしていない場合、ログインするように求められます。

この URL には、iFrame 内からアクセスできます。		 いいえ はい いいえ

Body プロパティからのスクリプトの削除

メッセージ本文は、HTML またはテキストのいずれかにできます。本文が HTML の場合、既定では、Body プロパティに組み込まれている安全ではない可能性がある HTML (たとえば、JavaScript など) が、本文の内容が REST 応答で返される前に削除されます。

元の HTML コンテンツ全体を取得するには、次の HTTP 要求ヘッダーを含めます。

Prefer: outlook.allow-unsafe-html

From プロパティと Sender プロパティの設定

メッセージが作成されるとき、ほとんどの場合には From プロパティと Sender プロパティは、同じサインイン ユーザーを示します。ただし、次のシナリオで説明されているように、どちらかが更新される場合は例外です。

  • From プロパティは、Exchange 管理者がメールボックスの SendAs 権限を他のユーザーに割り当てた場合には変更が可能です。管理者は、Azure 管理ポータルでメールボックス所有者のメールボックスのアクセス許可を選択するか、Exchange 管理センターまたは Windows PowerShell Add-ADPermission コマンドレットを使用してこれを行えます。その後、プログラムを使用して、From プロパティを、対象メールボックスの SendAs 権限を持ついずれかのユーザーに自動的に設定できます。

  • Sender プロパティは、メールボックス所有者が 1 人以上のユーザーにそのメールボックスからメッセージを送信する権限を委任すると、変更できます。メールボックス所有者は、Outlook で委任できます。代理人がメールボックス所有者に代わってメッセージを送信する場合、Sender プロパティは代理人のアカウントに設定され、From プロパティはメールボックス所有者のままになります。プログラムを使用して、Sender プロパティは、対象メールボックスの委任権限を取得したユーザーに設定できます。

MessageRule (プレビュー)

この機能は現在ベータ版および v2.0 で利用できます。 詳細を確認するには、左側の目次で、 ** Office 365 REST API リファレンス** のセクションに移動し、 ** ベータ版** を選択します。

OutlookCategory (プレビュー)

この機能は現在ベータ版および v2.0 で利用できます。 詳細を確認するには、左側の目次で、 ** Office 365 REST API リファレンス** のセクションに移動し、 ** ベータ版** を選択します。

写真

この機能は現在 v2.0 とベータ版で利用できます。 詳細を確認するには、左側の目次で、 Office 365 REST API リファレンス のセクションに移動し、これらのバージョンのいずれかを選択します。

参照添付ファイル

この機能は現在ベータ版および v2.0 で利用できます。 詳細を確認するには、左側の目次で、 ** Office 365 REST API リファレンス** のセクションに移動し、 ** ベータ版** を選択します。

タスク

この機能は現在ベータ版および v2.0 で利用できます。 詳細を確認するには、左側の目次で、 Office 365 REST API リファレンス のセクションに移動し、これらのバージョンのいずれかを選択します。

タスク フォルダー

この機能は現在ベータ版および v2.0 で利用できます。 詳細を確認するには、左側の目次で、 Office 365 REST API リファレンス のセクションに移動し、これらのバージョンのいずれかを選択します。

タスク グループ

この機能は現在ベータ版および v2.0 で利用できます。 詳細を確認するには、左側の目次で、 Office 365 REST API リファレンス のセクションに移動し、これらのバージョンのいずれかを選択します。

ユーザー

システム内のユーザーです。 Me エンドポイントが、現在のユーザーを SMTP アドレスで指定するためのショートカット (users/sadie@contoso.com) として提供されます。

型: Microsoft.OutlookServices.User

コレクションは、OData 応答の value プロパティでユーザーの配列を返します。$count を使用してコレクション内のエンティティ数 (.../me/users/$count) を取得します。 .../me/users/$count

注意

User エンティティには、多くのプロパティとリレーションシップ (ナビゲーション プロパティ) が含まれていて、頻繁に拡張されます。 次のセクションでは、サブセットのみについて説明します。 最新の情報については、ご使用のバージョンのメタデータ ファイルにある User 定義を参照してください。

プロパティ 型 説明 書き込み可能 フィルター処理可能
エイリアス 文字列 ユーザーのエイリアス。通常は、ユーザーの SMTP アドレスです。 はい はい
予定表 予定表 ユーザーの標準予定表。ナビゲーション プロパティです。 いいえ いいえ
予定表のグループ コレクション (CalendarGroup) ユーザーの予定表グループ。ナビゲーション プロパティです。 いいえ いいえ
予定表 コレクション (予定表) ユーザーの予定表。ナビゲーション プロパティです。 いいえ いいえ
予定表ビュー コレクション (イベント) 予定表のカレンダー ビュー。ナビゲーション プロパティです。 いいえ いいえ
連絡先フォルダー コレクション (連絡先フォルダー) ユーザーの連絡先フォルダー。ナビゲーション プロパティです。 いいえ いいえ
連絡先 コレクション (連絡先) ユーザーの連絡先。ナビゲーション プロパティです。 いいえ いいえ
表示名 文字列 ユーザーの表示名。 はい はい
イベント コレクション (イベント) ユーザーのイベント。既定は、既定の予定表の下にイベントを表示することです。ナビゲーション プロパティです。 いいえ いいえ
フォルダ コレクション (フォルダー) メールボックスまたはフォルダー内のフォルダー。ナビゲーション プロパティです。 いいえ いいえ
ID 文字列 ユーザーの一意の識別子。 いいえ いいえ
メールボックスGUID 型 GUID 型 (GUID) ユーザーのメールボックスに割り当てられた GUID です。 いいえ はい
メッセージ コレクション (メッセージ) メールボックスまたはフォルダー内のメッセージ。ナビゲーション プロパティです。 いいえ いいえ
ルート フォルダ フォルダ ユーザーのメールボックスのルート フォルダー。ナビゲーション プロパティです。 いいえ いいえ

複合型

出席者

イベントの参加者です。

型: Microsoft.OutlookServices.Recipient

プロパティ 型 説明
状況 応答ステータス 応答 (なし、承諾、辞退など) と時刻。
型 出席者の種類 出席者の種類です: Required、Optional、Resource。

電子メール アドレス

連絡先またはメッセージ受信者の名前と電子メール アドレスです。

型: Microsoft.OutlookServices.EmailAddress

プロパティ 型 説明
名前 文字列 個人またはエンティティの表示名。
アドレス 文字列 個人またはエンティティの電子メール アドレス。

地理座標

場所の地理的座標と標高です。

型:Microsoft.OutlookServices.GeoCoordinates

プロパティ 型 説明
標高 ダブル 場所の標高です。
緯度 ダブル 場所の緯度です。
経度 ダブル 場所の経度です。
正確性 ダブル 緯度と経度を提供するセンサーの精度です。
標高の精度 ダブル 標高を提供するセンサーの精度。

アイテムの本文

メッセージまたはイベントの本文の内容。

型: Microsoft.OutlookServices.ItemBody

プロパティ 型 説明
コンテンツ タイプ 本文の種類 次のようなコンテンツ タイプがあります。テキスト = 0、HTML = 1。
コンテンツ 文字列 テキストまたは HTML コンテンツ。

場所​

イベントの場所です。

型: Microsoft.OutlookServices.Location

プロパティ 型 説明
表示名 文字列 場所に関連付けられた名前。
アドレス 物理アドレス 場所の物理アドレス。
座標 地理座標 場所の地理的座標と標高です。

パターン化された繰り返し

繰り返しのパターンと範囲です。

型: Microsoft.OutlookServices.PatternedRecurrence

プロパティ 型 説明
パターン 繰り返しパターン イベントの頻度。
範囲 繰り返しの期間 イベントの期間。

物理アドレス

連絡先の住所です。

型: Microsoft.OutlookServices.PhysicalAddress

プロパティ 型 説明
勤務先の番地 文字列 番地。
市 文字列 市区町村。
状態 文字列 都道府県。
国または地域 文字列 国または地域。自由形式の文字列値です。例: 「米国」。
郵便番号 文字列 郵便番号。

受信者

イベントまたはメッセージの送信側または受信側のユーザーに関する情報を表します。

型: Microsoft.OutlookServices.Recipient

プロパティ 型 説明
電子メール アドレス 電子メール アドレス 受信者の電子メール アドレス。

繰り返しパターン

イベントの頻度。

型: Microsoft.OutlookServices.RecurrencePattern

プロパティ 型 説明
型 繰り返しパターン型 次のような繰り返しパターン タイプがあります。日単位 = 0、週単位 = 1、絶対月単位 = 2、相対月単位 = 3、絶対年単位 = 4、相対年単位 = 5。
パターンの規則:
- AbsoluteYearly。 発生の Month と DayOfMonth を設定する必要があります
- RelativeYearly。 Month、DaysOfWeek、および FirstDayOfWeek インデックスを設定する必要があります
- AbsoluteMonthly。 DayOfMonth を設定する必要があります
- RelativeMonthly。 FirstDayOfWeek インデックスと RecurrenceRange.NumberOfOccurrences を設定する必要があります
- Weekly。 DaysOfWeek と FirstDayOfWeek を設定する必要があります
- Daily。 追加のパターン情報は必要ありません。
間隔 Int32 発生と発生の間の指定された繰り返しタイプの単位数。
月の日付 Int32 アイテムが発生する月の日付。
月 Int32 アイテムが発生する月。これは、1 から 12 までの数字です。
曜日 コレクション(曜日) 次のような曜日のコレクションです。日曜日 = 0、月曜日 = 1、火曜日 = 2、水曜日 = 3、木曜日 = 4、金曜日 = 5、土曜日 = 6。
最初の曜日 曜日 次のような曜日があります。日曜日 = 0、月曜日 = 1、火曜日 = 2、水曜日 = 3、木曜日 = 4、金曜日 = 5、土曜日 = 6。
インデックス 曜日インデックス 次のような週インデックスです。第 1 週 = 0、第 2 週 = 1、第 3 週 = 2、第 4 週 = 3、最後 = 4。

繰り返しの期間

イベントの期間。

型: Microsoft.OutlookServices.RecurrenceRange

プロパティ 型 説明
型 繰り返し範囲型 次のような繰り返し範囲があります。終了日 = 0、無制限 = 1、番号順 = 2。
開始日 日付/時刻オフセット 必須: 繰り返しの開始日です。
終了日 日付/時刻オフセット 日付限定パターンで必須: 繰り返しの終了日です。 開始日より後である必要があります。
繰り返し回数 Int32 ** 番号順パターンで必須 ** : イベントを繰り返す回数です。

応答ステータス

会議出席依頼の応答状態です。

型: Microsoft.OutlookServices.ResponseStatus

プロパティ 型 説明
応答 応答の種類 応答タイプ: None、Organizer、TentativelyAccepted、Accepted、Declined、NotResponded。
所要時間 日付/時刻オフセット 応答が返された日時。

列挙型

曜日

曜日のセット。

サポートされている値:

  • 日曜日
  • 月曜日
  • 火曜日
  • 水曜日
  • 木曜日
  • 金曜日
  • 土曜日

空き時間状態

会議の出席者の空き時間状態を示します。

サポートされている値:

  • 取り込み中
  • フリー
  • Oof
  • Tentative
  • Unknown
  • 離席

添付ファイルの参照権限

参照添付ファイルのファイルまたはフォルダーのアクセス許可。

サポートされている値:

  • 他
  • 表示
  • 編集
  • 匿名の表示
  • AnonymousEdit
  • OrganizationView
  • OrganizationEdit

添付ファイルのプロバイダーを参照

添付ファイルの参照可能なファイルのストレージ ・ プロバイダーです。

サポートされている値:

  • ドロップボックス
  • OneDriveBusiness
  • OneDriveConsumer
  • Other

感度

プライバシーのレベルを示します。

サポートされている値:

  • 正常
  • Personal
  • 非公開
  • 極秘

OData クエリ パラメーター

メール、予定表、および連絡先 API を操作するときに、標準の OData v4.0 クエリ パラメーターを使用してデータ要求をフィルター処理したり、結果を並べ替えてページングしたりすることができます。 クエリ パラメーターを指定するとき、 URI で特別な意味のために予約されている文字が適切にエンコードされていることを確認してください。

  • $search 検索 する特定の条件

  • $filter 特定の条件を フィルター する

  • $select 特定のプロパティを 要求 する

  • $orderby 結果を ソート する

  • $top $skip ページ 結果

  • $expand メッセージの添付ファイルとイベントの添付ファイルを展開します。

  • $count コレクション内のエンティティの 数 を取得します。 このパラメーターは URL パスに追加されます 。 .../me/calendars/$count

メール、予定表、および連絡先 API を使用した問い合わせでは、必ず、浅いスコープが使用されます。現在のフォルダー内のアイテムのみが返されます。深い検索はサポートされていません。

検索要求

$search パラメーターを使用すれば、要求の結果を検索式と一致するメッセージに制限することができます。 検索条件は、高度な検索テクニック (AQS) を使用して表現されます。 検索結果は、メッセージが送信された日時で並べ替えられます。

注意

最大で 250 の情報を得るため、 $search 要求します。 $search はメッセージのみで使用できます。 連絡先と予定表のイベントの検索はサポートされていません。

検索要求で $filter または $orderby を使用することはできません。 使用した場合は、次のようなエラー メッセージが表示されます。

    {
      "error":
      {
        "code":"ErrorInvalidUrlQuery",
        "message":"The query parameter 'OrderBy' is invalid."
      }
    }
プロパティ 説明
添付ファイル 指定された添付ファイルをタイトルで検索します。
BCC [Bcc] フィールドを検索します。
Body または Content [本文] フィールドを検索します。既定の検索でのみサポートされています。
カテゴリ [カテゴリ] フィールドを検索します。
CC [CC] フィールドを検索します。
From [差出人] フィールドを検索します。
Has [添付ファイルあり] フィールドを検索します。
参加者 [宛先]、[CC]、[BCC] の各フィールドを検索します。
受信 MM/DD/YYYY として表現された特定の日付を [受信日時] フィールドで検索します。
送信者 [送信者] フィールドを検索します。
件名 [件名] フィールドを検索します。
宛先 [ 宛先 ] フィールドを検索します。

プロパティを指定せずに $search クエリパラメータを使用して共通フィールドを検索します。 デフォルト検索では ** 本文 ** 、** 送信者 ** 、** 件名 **プロパティが検索されます 次の検索は次の 3 つの既定のプロパティのいずれかで「ピザ」を含む受信トレイですべてのメッセージを返します。

いくつかの例を見てみましょう。読みやすくするために、例内の URL はエンコードされていません。ただし、これらの例を試す場合は、URL をサーバーに送信する前にエンコードする必要があります。

From、Subject、または Body プロパティ内に「Pizza」という単語を含む受信トレイ内のすべてのメッセージを取得する場合は、この要求を使用することができます。

GET https://outlook.office.com/api/v1.0/me/messages?$search="pizza"

Subject プロパティ内に「Pizza」という単語を含む受信トレイ内のすべてのメッセージを取得する場合は、この要求を使用することができます。

GET https://outlook.office.com/api/v1.0/me/messages?$search="subject:pizza"

特定の人から送信された受信トレイ内のすべてのメッセージを取得する場合は、この要求を使用することができます。

GET https://outlook.office.com/api/v1.0/me/messages?$search="from:help@contoso.com"

上の例では、URL エンコードが含まれていませんでしたが、URL エンコードされ、サーバーに送信する準備ができた同じ例を以下に示します。

GET https://outlook.office.com/api/v1.0/me/messages?$search=%22pizza%22
GET https://outlook.office.com/api/v1.0/me/messages?$search=%22subject:pizza%22
GET https://outlook.office.com/api/v1.0/me/messages?$search=%22from:help@contoso.com%22

フィルター処理要求

$filter クエリ パラメーターを使用すれば、次のフィルター演算子を使用して検索条件を指定することができます。

すべてのプロパティがフィルタリングをサポートしているわけではありません。前述した対応する表の [フィルター処理可能] 列が [はい] になっているリソース プロパティのみを使用できます。プロパティがフィルター処理できない場合は、ChangeKey プロパティでフィルター処理しようとしたときに返される次のようなエラー メッセージが応答で返されます。

    {
      "error":
      {
        "code":"ErrorInvalidProperty",
        "message":"The property 'ChangeKey' does not support filtering."
      }
    }

サポートされていないフィルタリング メソッドを使用した場合は、Subject プロパティに対して startswith フィルター メソッドを使用したときに返される次のようなエラー メッセージが表示されます。

    {
      "error":
      {
        "code":"ErrorInvalidUrlQueryFilter",
        "message":"'contains' and 'startswith' are not supported for filtering.  Use Search instead."
      }
    }
演算子 型 例
および 論理積 (複数の条件を結合するために使用する) TotalCount gt 0 and ChildFolderCount eq 0
または 論理和 (複数の条件を結合するために使用する) TotalCount gt 0 or ChildFolderCount eq 0
eq 等しい IsRead eq false
ne 等しくない Importance ne Microsoft.Exchange.Services.OData.Model.Importance'High'
gt より大きい DateTimeReceived gt 2014-09-01T00:00:00Z
ge 以上 DateTimeLastModified ge 2014-09-01T00:00:00Z
lt より少ない DateTimeReceived lt 2014-09-01T00:00:00Z
le 以下 DateTimeLastModified le 2014-09-01T00:00:00Z

フィルター条件で任意の文字列値を区切るには、単一引用符 (') を使用します。URL で単一引用符をエンコードするには、%27 を使用します。文字列自体では大文字と小文字の区別はありません。

いくつかの例を見てみましょう。読みやすくするために、例内の URL はエンコードされていません。ただし、これらの例を試す場合は、URL をサーバーに送信する前にエンコードする必要があります。

ユーザーの予定表に含まれる特定の件名のイベントすべてを取得するには、 Subject プロパティでフィルター処理できます。

GET https://outlook.office.com/api/v1.0/me/events?$filter=Subject eq 'Mega Charity Bash'

受信トレイ内のすべての未読メッセージを取得する場合は、 IsRead プロパティでフィルター処理できます。

GET https://outlook.office.com/api/v1.0/me/messages?$filter=IsRead eq false

受信トレイ内のすべての添付ファイル付きメッセージを取得する場合は、 HasAttachments プロパティでフィルター処理できます。

GET https://outlook.office.com/api/v1.0/me/messages?$filter=HasAttachments eq true

2014 年 9 月 1 日以降に受信された受信トレイ内のすべてのメッセージを取得する場合は、 DateTimeReceived プロパティでフィルター処理できます。

GET https://outlook.office.com/api/v1.0/me/messages?$filter=DateTimeReceived ge 2014-09-01

"hr@contoso.com" から送信された受信トレイ内のすべてのメッセージを取得する場合は、Sender プロパティでフィルター処理できます。

GET https://outlook.office.com/api/v1.0/me/messages?$filter=From/EmailAddress/Address eq 'hr@contoso.com'

上の例では、URL エンコードが含まれていませんでしたが、URL エンコードされ、サーバーに送信する準備ができた同じ例を以下に示します。

GET https://outlook.office.com/api/v1.0/me/events?$filter=Subject%20eq%20%27Mega%20Charity%20Bash%27
GET https://outlook.office.com/api/v1.0/me/messages?$filter=IsRead%20eq%20false
GET https://outlook.office.com/api/v1.0/me/messages?$filter=HasAttachments%20eq%20true
GET https://outlook.office.com/api/v1.0/me/messages?$filter=DateTimeReceived%20ge%202014-09-01
GET https://outlook.office.com/api/v1.0/me/messages?$filter=From/EmailAddress/Address%20eq%20%27hr@contoso.com%27

返される特定のプロパティの選択

$select クエリ パラメーターを使用すれば、アプリに必要なプロパティのみを指定することができます。

注意

メール、予定表、および連絡先アイテムを取得する場合は、必ず$select を使用して応答ペイロードから不要なプロパティを除外することによって、適切なアプリ パフォーマンスを維持してください。 $select パラメーターを省略した場合は、アイテムのすべてのプロパティが返されます。

次の例は、受信トレイ内のすべてのメッセージの Subject、Sender、DateTimeReceived プロパティを取得します。

GET https://outlook.office.com/api/v1.0/me/messages?$select=Subject,Sender,DateTimeReceived

結果の並べ替え

$orderby クエリパラメータを使用して結果を並べ替えることができます。 このパラメーターの値をプロパティ名に設定し、昇順 (既定) または降順の順序を指定します。 $search で $orderby クエリパラメータを使用することはできないことを忘れないでください。

URL エンコードを使用しない次の例では、DateTimeReceived プロパティによって受信トレイ内のすべてのメッセージが降順に並べ替えられます。

GET https://outlook.office.com/api/v1.0/me/messages?$orderby=DateTimeReceived desc

URL エンコードを使用した同じ例を以下に示します。

GET https://outlook.office.com/api/v1.0/me/messages?$orderby=DateTimeReceived%20desc

結果のページング

既定では、 メッセージ または ChildFolders プロパティ、コレクション、または 予定表ビュー の GET 要求を 10 個のエントリ (最大 50) を返します。 この動作を変更するには、 $top クエリパラメータを使用して最大数を設定します。 次の例では、受信トレイの最初の5つのメッセージを取得します。

GET https://outlook.office.com/api/v1.0/me/messages?$top=5

受信トレイに複数の 5 つのメッセージがある場合は、応答には、 odata.nextLink プロパティが含まれています。 このプロパティの存在は、サーバー上に使用可能なアイテムがまだ存在することを意味します。 このプロパティの値は、次の 5 つの項目を取得するために使用する URI です。

GET https://outlook.office.com/api/v1.0/me/messages?$top=5&$skip=5

ページングは、$top パラメーターでページ サイズを指定し、$skip パラメーターをページ サイズの倍数として使用することによって実現されます。 $skip パラメーター値をページ サイズ分だけ増やすことによって、結果セットに次のページを要求できます。

コレクション内のエンティティのカウント

$count パラメーターを使用すれば、コレクション内のエンティティ数を取得することができます。 カウント要求をフィルター処理することもできます。

次の例は、受信トレイ内のメッセージの数を取得します。

GET https://outlook.office.com/api/v1.0/me/messages/$count

また、URL エンコードを使用しないこの例は、受信トレイ内の未読メッセージの数も取得します。

GET https://outlook.office.com/api/v1.0/me/messages/$count?$filter=IsRead eq false

URL エンコードの例と同じです。

GET https://outlook.office.com/api/v1.0/me/messages/$count?$filter=IsRead%20eq%20false

すべてをまとめる

パラメーターを組み合わせて複雑なクエリを作成することができます。次の例は、受信トレイ内のメッセージのクエリを次のように精緻化します。

  • Importance が High に設定されたアイテムのみを返す。

  • Subject、Sender、および DateTimeReceived プロパティのみを返します。

  • 最初の 5 つのメッセージのみを返します。

注意

読みやすくするために、URL エンコードが省略され、改行が追加されています。

https://outlook.office.com/api/v1.0/me/messages?
    $filter=Importance eq 'High'
    &$select=Subject,Sender,DateTimeReceived
    &$top=5

$filter を指定した場合は、サーバーで結果の並べ替え順序が考慮されます。 $filter と$orderby の両方を使用する場合は、$filter 内のプロパティを他のプロパティよりも先に $orderby 内に配置して、$filter パラメーター内の順序で並べる必要があります。 次の例は、Subject と Importance の両方のプロパティでフィルター処理されてから、Subject、Importance、および Sender の各プロパティで並べ替えられたクエリを示しています。

https://outlook.office.com/api/v1.0/me/messages?
    $filter=Subject eq 'Good Times' AND Importance eq 'High'&
    $orderby=Subject,Importance,Sender

URL エンコードを使用し、改行なしの同じ例を以下に示します。

https://outlook.office.com/api/v1.0/me/messages?$filter=Importance%20eq%20%27High%27&select=Subject,Sender,DateTimeReceived&$top=5

https://outlook.office.com/api/v1.0/me/messages?$filter=Subject%20eq%20%27Good%20Times%27%20AND%20Importance%20eq%20%27High%27&$orderby=Subject,Importance,Sender

関連項目