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

[アーティクル]
06/30/2018

この記事では、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 v2.0 が不要な場合 左側の目次で、[Office 365 REST API リファレンス] セクションに移動し、使用したいバージョンを選択します。

ヒント

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

添付ファイル

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

型:Microsoft.OutlookServices.Entity

プロパティ	型	説明	書き込み可能	フィルター処理可能
ContentType	文字列	添付ファイルの MIME タイプ。	はい	いいえ
IsInline	ブール値	`true` 添付ファイルがインライン添付ファイルの場合は `true`、それ以外の場合は `false`。	はい	はい
LastModifiedDateTime	DateTimeOffset	添付ファイルが最後に変更された日時です。日付と時間は ISO 8601 形式を使用し、常に UTC 時間です。たとえば、2014 年 1 月 1 日午前 0 時 (UTC) は、'2014-01-01T00:00:00Z' となります。	いいえ	はい
名前	文字列	添付ファイルの表示名。実際のファイル名である必要はありません。	はい	はい
サイズ	Int32	添付ファイルの長さ (バイト単位)。	いいえ	いいえ

予定表

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

型: Microsoft.OutlookServices.Calendar

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

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

プロパティ	型	説明	書き込み可能	フィルター処理可能
CanEdit	ブール値	ユーザーが予定表に書き込むことができる場合は true、それ以外の場合は false です。予定表を作成したユーザーの場合は、このプロパティは true です。予定表を共有していて、書き込みアクセスが付与されているユーザーの場合も、このプロパティは true です。	いいえ	はい
CanShare	ブール値	ユーザーに予定表を共有するためのアクセス許可がある場合は true、それ以外の場合は false です。予定表を作成したユーザーのみがその予定表を共有できます。	いいえ	はい
CanViewPrivateItems	ブール値	ユーザーがプライベートとしてマークされている予定表アイテムを読み取れることができる場合は true、それ以外の場合は false です。	いいえ	はい
ChangeKey	文字列	予定表オブジェクトのバージョンを識別します。予定表を変更するたびに ChangeKey も変更されます。これにより、Exchange は正しいバージョンのオブジェクトに変更を適用できます。	いいえ	いいえ
色	CalendarColor	UI で予定表を他の予定表から区別するための配色テーマを指定します。プロパティ値は次のとおりです。薄い青=0、薄い緑=1、薄いオレンジ=2、薄い灰色=3、薄い黄=4、薄い青緑=5、薄いピンク=6、薄い茶色=7、薄い赤=8、最大色=9、自動=-1	はい	はい
ID	文字列	予定表の一意の識別子。	いいえ	いいえ
名前	文字列	予定表の名前。	はい	はい
オーナー	EmailAddress	設定すると、これは予定表を作成または追加したユーザーを表します。ユーザーが作成または追加した予定表の場合、Owner プロパティがユーザーに設定されます。ユーザーと共有されている予定表の場合は、Owner プロパティがその予定表をユーザーと共有した人に設定されます。	いいえ	はい
CalendarView	コレクション (イベント)	予定表のカレンダービュー。ナビゲーションプロパティです。	いいえ	いいえ
イベント	コレクション (イベント)	予定表内のイベント。ナビゲーションプロパティです。	いいえ	いいえ
MultiValueExtendedProperties	1 つのコレクション	MultiValueLegacyExtendedProperty 型の複数値拡張プロパティのコレクション。これはナビゲーションのプロパティです。「拡張プロパティ」の詳細を検索してください。	はい	はい
SingleValueExtendedProperties	1 つのコレクション	SingleValueLegacyExtendedProperty 型の単一値拡張プロパティのコレクション。これはナビゲーションのプロパティです。「拡張プロパティ」の詳細を検索してください。	はい	はい

CalendarGroup

予定表のグループです。

注意

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

型: Microsoft.OutlookServices.CalendarGroup

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

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

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

連絡先

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

型: Microsoft.OutlookServices.Contact

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

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

プロパティ	型	説明	書き込み可能	フィルター処理可能
AssistantName	文字列	連絡先のアシスタントの名前。	はい	はい
生年月日
datetimeoffset	連絡先の誕生日です。	はい	はい
BusinessAddress	PhysicalAddress	連絡先の勤務先の住所。	はい	はい
BusinessHomePage	文字列	連絡先の勤務先のホームページ。	はい	はい
BusinessPhones	コレクション (文字列)	連絡先の勤務先の電話番号。	はい	いいえ
カテゴリ	コレクション (文字列)	連絡先に関連付けられたカテゴリ。	はい	いいえ
ChangeKey	文字列	連絡先のバージョンを識別します。連絡先を変更するたびに ChangeKey も変更されます。これにより、Exchange は正しいバージョンのオブジェクトに変更を適用できます。	いいえ	いいえ
子供	コレクション (文字列)	連絡先の子供の名前。	はい	はい
CompanyName	文字列	連絡先の会社の名前。	はい	はい
部署	文字列	連絡先の部署。	はい	はい
CreatedDateTime	datetimeoffset	連絡先が作成された時刻です。	いいえ	はい
LastModifiedDateTime	datetimeoffset	連絡先が変更された時刻です。	いいえ	はい
DisplayName	文字列	連絡先の表示名。	はい	はい
EmailAddresses	コレクション (EmailAddress)	連絡先のメールアドレス。	はい	いいえ
拡張機能	コレクション (拡張機能)	連絡先に対して定義されているオープン型のデータ拡張機能のコレクション。ナビゲーションプロパティです。	いいえ	はい
FileAs	文字列	連絡先がファイルされる名前。	はい	はい
年代	文字列	連絡先の世代。	はい	はい
GivenName	文字列	連絡先の名。	はい	はい
HomeAddress	PhysicalAddress	連絡先の自宅住所。	はい	はい
HomePhones	コレクション (文字列)	連絡先の自宅の電話番号。	はい	いいえ
ID	文字列	連絡先の一意の識別子。	いいえ	いいえ
ImAddresses	コレクション (文字列)	連絡先のインスタントメッセージング (IM) アドレス。	はい	いいえ
イニシャル	文字列	連絡先のイニシャル。	はい	はい
JobTitle	文字列	連絡先の役職。	はい	はい
上司	文字列	連絡先の上司の名前。	はい	はい
MiddleName	文字列	連絡先のミドルネーム。	はい	はい
MobilePhone1	文字列	連絡先の携帯電話番号。	はい	はい
NickName	文字列	連絡先のニックネーム。	はい	はい
OfficeLocation	文字列	連絡先のオフィスの所在地。	はい	はい
OtherAddress	PhysicalAddress	連絡先の別の住所。	はい	はい
ParentFolderId	文字列	連絡先の親フォルダーの ID。	いいえ	いいえ
PersonalNotes	文字列	連絡先に関するユーザーのメモ。	はい	はい
職業	文字列	連絡先の専門的職業。	はい	はい
SpouseName	文字列	連絡先の配偶者の名前。	はい	はい
姓 (ラストネーム)	文字列	連絡先の姓。	はい	はい
肩書	文字列	連絡先の肩書。	はい	いいえ
YomiCompanyName	文字列	連絡先の会社名の読み仮名。	はい	いいえ
YomiGivenName	文字列	連絡先の名 (ファーストネーム) の読み仮名。	はい	いいえ
YomiSurname	文字列	連絡先の姓 (ラストネーム) の読み仮名。	はい	いいえ

ナビゲーションプロパティ MultiValueExtendedProperties と SingleValueExtendedProperties も、このリソースで利用できます。これらは、リソースインスタンスに定義されている拡張プロパティのそれぞれの型のコレクションを表します。詳細については、「拡張プロパティ REST API」を参照してください。

ContactFolder

連絡先が保存されたフォルダーです。

型: Microsoft.OutlookServices.ContactFolder

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

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

プロパティ	型	説明	書き込み可能	フィルター処理可能
ChildFolders	コレクション (ContactFolder)	フォルダー内の子フォルダーのコレクション。ナビゲーションプロパティです。	いいえ	いいえ
連絡先	コレクション (連絡先)	フォルダー内の連絡先。ナビゲーションプロパティです。	いいえ	いいえ
DisplayName	文字列	フォルダーの表示名。	はい	はい
ID	文字列	連絡先フォルダーの一意の識別子。	いいえ	いいえ
ParentFolderId	文字列	フォルダーの親フォルダーの ID。	いいえ	いいえ
MultiValueExtendedProperties	1 つのコレクション	MultiValueLegacyExtendedProperty 型の複数値拡張プロパティのコレクション。これはナビゲーションのプロパティです。「拡張プロパティ」の詳細を検索してください。	はい	はい
SingleValueExtendedProperties	1 つのコレクション	SingleValueLegacyExtendedProperty 型の単一値拡張プロパティのコレクション。これはナビゲーションのプロパティです。「拡張プロパティ」の詳細を検索してください。	はい	はい

イベント

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

型: Microsoft.OutlookServices.Event

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

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

プロパティ	型	説明	書き込み可能	フィルター処理可能
添付ファイル	コレクション (添付ファイル)	イベントの FileAttachment、ItemAttachment、ReferenceAttachment の各添付ファイルのコレクション。ナビゲーションプロパティです。	いいえ	いいえ
参加者	コレクション (参加者)	イベントの参加者のコレクション。	はい	いいえ
本文	ItemBody	イベントに関連付けられたメッセージの本文。	はい	いいえ
BodyPreview	文字列	イベントに関連付けられたメッセージのプレビュー。	いいえ	いいえ
予定表	予定表	イベントを含む予定表。ナビゲーションプロパティです。	いいえ	いいえ
カテゴリ	コレクション (文字列)	イベントに関連付けられたカテゴリ。	はい	いいえ
ChangeKey	文字列	イベントオブジェクトのバージョンを識別します。イベントを変更するたびに ChangeKey も変更されます。これにより、Exchange は正しいバージョンのオブジェクトに変更を適用できます。	いいえ	いいえ
CreatedDateTime	datetimeoffset	イベントが作成された日時です。	いいえ	はい
LastModifiedDateTime	datetimeoffset	イベントが最後に変更された日時です。	いいえ	はい
終了	DateTimeTimeZone	イベントの終了時刻。	はい	はい
拡張機能	コレクション (拡張機能)	イベントに対して定義されているオープン型のデータ拡張機能のコレクション。ナビゲーションプロパティです。	いいえ	はい
HasAttachments	ブール値	イベントに添付ファイルが含まれている場合に、true に設定します。	いいえ	はい
ID	文字列	イベントの一意識別子。	いいえ	いいえ
重要度	重要度	イベントの重要度: `Low`、`Normal`、`High`。	はい	はい
インスタンス	コレクション (イベント)	イベントのインスタンス。ナビゲーションプロパティです。	いいえ	いいえ
iCalUID	文字列	複数の予定表を通して 1 つのイベントのすべてのインスタンスで共有される一意の識別子。	いいえ	はい
IsAllDay	ブール値	イベントが一日中続く場合に、true に設定します。このプロパティを調整するには、イベントの Start および End プロパティの調整も必要になります。	はい	はい
IsCancelled	ブール値	イベントがキャンセルされた場合に、true に設定します。	はい	はい
IsOrganizer	ブール値	メッセージの送信者が主催者でもある場合に、true に設定します。	はい	はい
IsReminderOn	ブール値	ユーザーにイベントを通知するアラートを設定する場合は、true に設定します。	はい	はい
場所	場所	イベントの場所。	はい	はい
OnlineMeetingUrl	文字列	オンライン会議の URL。	はい	いいえ
主催者	宛先	イベントの主催者。	はい	はい
OriginalEndTimeZone	文字列	イベントが作成されたときに設定された終了タイムゾーン。有効なタイムゾーンの一覧については、「DateTimeTimeZone」を参照してください。	いいえ	はい
OriginalStartTimeZone	文字列	イベントが作成されたときに設定された開始タイムゾーン。有効なタイムゾーンの一覧については、「DateTimeTimeZone」を参照してください。	いいえ	はい
繰り返し	PatternedRecurrence	イベントの繰り返しパターン。	はい	いいえ
ReminderMinutesBeforeStart	Int32	アラーム通知を行う、イベント開始時間前の分数。	はい	いいえ
ResponseRequested	ブール値	イベントが承諾または辞退されたときに、送信者が応答を要求する場合に、true に設定します。	はい	はい
ResponseStatus	ResponseStatus	イベントメッセージへの応答で送信される応答のタイプを識別します。	いいえ	はい
秘密度	秘密度	イベントのプライバシーのレベルを示します。標準 = 0、個人 = 1、非公開 = 2、社外秘 = 3 です。	はい	はい
SeriesMasterId	文字列	アイテムに割り当てられたカテゴリ。	はい	いいえ
ShowAs	FreeBusyStatus	次のようなステータスを示します。予定なし = 0、仮の予定 = 1、予定あり = 2、休暇 = 3、離席 = 4、不明 = -1。	はい	はい
開始	DateTimeTimeZone	イベントの開始時刻です。	はい	はい
型	EventType	次のようなイベントタイプがあります。単一インスタンス = 0、発生 = 1、例外 = 2、連続マスター = 3。	はい	はい
WebLink	文字列	Outlook Web App でイベントを開く URL。 Outlook Web App のメールボックスにログインしている場合、ブラウザーでイベントが開きます。まだブラウザーでログインしていない場合、ログインするように求められます。この URL には、iFrame 内からアクセスできます。	いいえ	いいえ

EventMessage

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

基本型: メッセージ

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

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

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

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

EventMessageRequest (プレビュー)

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

拡張プロパティ

エンティティのカスタムプロパティを、プロパティで対象とする値に応じて MultiValueLegacyExtendedProperty または SingleValueLegacyExtendedProperty として作成できます。

MultiValueLegacyExtendedProperty

複数値のコレクションを含めることができる拡張プロパティ。

型:Microsoft.OutlookServices.MultiValueLegacyExtendedProperty

プロパティ	型	説明	書き込み可能	フィルター処理可能
値	コレクション (文字列)	プロパティ値のコレクション。	はい	いいえ
PropertyId	文字列	プロパティ ID。これは、プロパティの識別に使用されます。	いいえ	いいえ

SingleValueLegacyExtendedProperty

単一値が含まれる拡張プロパティ。

型:Microsoft.OutlookServices.SingleValueLegacyExtendedProperty

プロパティ	型	説明	書き込み可能	フィルター処理可能
値	文字列	プロパティ値。	はい	いいえ
PropertyId	文字列	プロパティ ID。これは、プロパティの識別に使用されます。	いいえ	はい

拡張プロパティを作成する場合、さまざまな方法で PropertyId を指定できます。詳細については、「PropertyId 形式」を参照してください。

使用できる関連操作については、「拡張プロパティ REST API リファレンス」をご覧ください。

FileAttachment

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

型: Microsoft.OutlookServices.FileAttachment

基本型: Microsoft.OutlookServices.Attachment

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

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

注意

V2.0 では、以前は Folder として知られていたエンティティと型が MailFolder という名前に変更されました。

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

型: Microsoft.OutlookServices.MailFolder

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

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

プロパティ	型	説明	書き込み可能	フィルター処理可能
ChildFolderCount	Int32	フォルダー内のフォルダー数。	いいえ	はい
ChildFolders	コレクション (MailFolder)	フォルダー内の子フォルダーのコレクション。ナビゲーションプロパティです。	いいえ	いいえ
DisplayName	文字列	フォルダーの表示名。	はい	はい
ID	文字列	フォルダーの一意の識別子。次の既知の名前を使用して対応するフォルダーにアクセスできます。Inbox、Drafts、SentItems、DeletedItems。	いいえ	いいえ
メッセージ	コレクション (メッセージ)	フォルダー内のメッセージのコレクション。ナビゲーションプロパティです。	いいえ	いいえ
ParentFolderId	文字列	フォルダーの親フォルダーの一意の識別子。	いいえ	いいえ
TotalItemCount	Int32	フォルダーに含まれるアイテムの数。	いいえ	はい
UnreadItemCount	Int32	フォルダー内で未読としてマークされているアイテム数。	いいえ	はい
MultiValueExtendedProperties	1 つのコレクション	MultiValueLegacyExtendedProperty 型の複数値拡張プロパティのコレクション。これはナビゲーションのプロパティです。「拡張プロパティ」の詳細を検索してください。	はい	はい
SingleValueExtendedProperties	1 つのコレクション	SingleValueLegacyExtendedProperty 型の単一値拡張プロパティのコレクション。これはナビゲーションのプロパティです。「拡張プロパティ」の詳細を検索してください。	はい	はい

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

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

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

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

InferenceClassification

ユーザーにとって、より関連性や重要性があるメッセージに注意が向けられるようにするためのユーザーメッセージの分類です。

型: Microsoft.OutlookServices.InferenceClassification

プロパティ	型	説明	書き込み可能
オーバーライド	コレクション (InferenceClassificationOverride)	ユーザーが、InferenceClassificationType でサポートされている特定の方法で特定の差出人からのメッセージを常時分類するための一連のオーバーライド。ナビゲーションプロパティです。	はい

InferenceClassificationOverride

特定の差出人からの着信メッセージを常時分類するためのユーザーのオーバーライドを表します。

型: Microsoft.OutlookServices.InferenceClassificationOverride

プロパティ	型	説明	書き込み可能
ClassifyAs	InferenceClassificationType	特定の差出人からの着信メッセージを常時分類する方法を指定します。優先=0、その他=1。	はい
ID	文字列	オーバーライドの一意識別子。	いいえ
SenderEmailAddress	EmailAddress	オーバーライドを作成する対象の差出人のメールアドレス。	はい

ItemAttachment

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

型: Microsoft.OutlookServices.ItemAttachment

基本型: Microsoft.OutlookServices.Attachment

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

メンション (プレビュー)

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

メッセージ

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

型: Microsoft.OutlookServices.Message

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

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

プロパティ	型	説明	書き込み可能	フィルター処理可能	検索可能かどうか
添付ファイル	コレクション (添付ファイル)	メッセージの FileAttachment 添付ファイルと ItemAttachment 添付ファイル。ナビゲーションプロパティです。	はい	いいえ	はい
BccRecipients	コレクション (受信者)	メッセージの BCC 受信者。	はい	いいえ	はい
本文	ItemBody	メッセージの本文。	はい	いいえ	既定
BodyPreview	文字列	メッセージ本文の内容の最初の 255 文字。	いいえ	いいえ	はい
カテゴリ	コレクション (文字列)	メッセージに関連付けられたカテゴリ。	はい	はい	はい
CcRecipients	コレクション (受信者)	メッセージの CC 受信者。	はい	いいえ	はい
ChangeKey	文字列	メッセージのバージョン。	いいえ	いいえ	いいえ
ConversationId	文字列	電子メールが属している会話の ID。	いいえ	はい	いいえ
CreatedDateTime	datetimeoffset	メッセージが作成された日時です。	いいえ	はい	いいえ
拡張機能	コレクション (拡張機能)	メッセージに対して定義されているオープン型のデータ拡張機能のコレクション。ナビゲーションプロパティです。	いいえ	はい	いいえ
From	宛先	メッセージのメールボックス所有者と送信者。	はい	はい	はい
HasAttachments	ブール値	メッセージに添付ファイルがあるかどうかを示します。	いいえ	はい	はい
ID	文字列	メッセージの一意識別子。	いいえ	いいえ	いいえ
重要度	重要度	次のようなメッセージの重要度があります。低 = 0、標準 = 1、高 = 2。	はい	はい	はい
InferenceClassification	InferenceClassificationType	推定される関連性や重要性、または明示的なオーバーライドに基づく、ユーザーの対象メッセージの分類。	はい	はい	はい
IsDeliveryReceiptRequested	ブール値	メッセージの開封応答が要求されているかどうかを示します。	はい	はい	いいえ
IsDraft	ブール値	メッセージが下書きかどうかを示します。メッセージがまだ送信されていなければ下書きです。	いいえ	はい	いいえ
IsRead	ブール値	メッセージが読み取られたかどうかを示します。	はい	はい	いいえ
IsReadReceiptRequested	ブール値	メッセージの開封応答が要求されているかどうかを示します。	はい	はい	いいえ
LastModifiedDateTime	datetimeoffset	メッセージが最後に変更された日時です。	いいえ	はい	いいえ
MultiValueExtendedProperties	1 つのコレクション	MultiValueLegacyExtendedProperty 型の複数値拡張プロパティのコレクション。これはナビゲーションのプロパティです。「拡張プロパティ」の詳細を検索してください。	はい	はい	いいえ
ParentFolderId	文字列	メッセージの親フォルダーの一意の識別子。	いいえ	いいえ	いいえ
ReceivedDateTime	datetimeoffset	メッセージが受信された日時です。	いいえ	はい	はい
ReplyTo	コレクション (受信者)	返信時に使用される電子メールアドレス。	いいえ	いいえ	いいえ
送り主	宛先	メッセージを生成するために実際に使用されるアカウント。	はい	はい	既定
SingleValueExtendedProperties	1 つのコレクション	SingleValueLegacyExtendedProperty 型の単一値拡張プロパティのコレクション。これはナビゲーションのプロパティです。「拡張プロパティ」の詳細を検索してください。	はい	はい	いいえ
SentDateTime	datetimeoffset	メッセージが送信された日時です。	いいえ	はい	いいえ
件名	文字列	メッセージの件名を指定します。	はい	はい	既定
ToRecipients	コレクション (受信者)	メッセージの宛先。	はい	いいえ	はい
UniqueBody	ItemBody	会話に特有のメッセージの本文。	いいえ	いいえ	いいえ
WebLink	文字列	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 (プレビュー)

OutlookCategory (プレビュー)

写真

型:Microsoft.OutlookServices.Photo

Exchange Online からアクセスされる写真。base 64 でエンコードされていないバイナリデータです。

プロパティ	型	説明	書き込み可能	フィルター処理可能
高さ	int	写真の高さ	いいえ	いいえ
ID	文字列	写真の一意識別子。	いいえ	いいえ
幅	int	写真の幅。	いいえ	いいえ

ReferenceAttachment

型:Microsoft.OutlookServices.ReferenceAttachment

基本型: Microsoft.OutlookServices.Attachment

メッセージ、イベント、またはタスクに添付されているファイルまたはフォルダーへのリンク。ファイルまたはフォルダーの場所として、OneDrive、OneDrive for Business、DropBox が含まれます。Attachment エンティティから派生します。

プロパティ	型	説明	書き込み可能	フィルター処理可能
ContentType	文字列	添付ファイルの MIME タイプ。省略可能。	はい	いいえ
ID	文字列	参照添付ファイルの一意の識別子。	いいえ	いいえ
IsFolder	ブール値	添付ファイルがフォルダーへのリンクであるかどうかを指定します。SourceUrl がフォルダーへのリンクの場合、true に設定する必要があります。省略可能。	はい	いいえ
IsInline	ブール値	`true` 添付ファイルがインライン添付ファイルの場合は `true`、それ以外の場合は `false`。省略可能。	はい	はい
LastModifiedDateTime	DateTimeOffset	添付ファイルが最後に変更された日時です。日時は ISO 8601 形式を使って表され、常に UTC 時間です。たとえば、2014 年 1 月 1 日午前 0 時 (UTC) は、次のようになります。'2014-01-01T00:00:00Z'。省略可能。	いいえ	はい
名前	文字列	添付ファイルの表示名。実際のファイル名である必要はありません。必須。	はい	はい
アクセス許可	ReferenceAttachmentPermissions	ProviderType のプロバイダーの種類によって、添付ファイルに付与されるアクセス許可を指定します。可能な値は、`Other`、`View`、`Edit`、`AnonymousView`、`AnonymousEdit`、`OrganizationView`、`OrganizationEdit` です。省略可能。	はい	いいえ
PreviewUrl	文字列	プレビューイメージを取得するための、イメージの URL の参照添付ファイルのみに適用されます。SourceUrl によってイメージファイルが識別される場合にのみ、ThumbnailUrl と PreviewUrl を使用します。省略可能。	はい	いいえ
ProviderType	ReferenceAttachmentProviders	この ContentType の添付ファイルをサポートするプロバイダーの種類。可能な値は、`Other`、`OneDriveBusiness`、`OneDriveConsumer`、`Dropbox` です。省略可能。	はい	はい
サイズ	Int32	添付ファイルの長さ (バイト単位)。省略可能。	いいえ	いいえ
SourceUrl	文字列	添付ファイルの内容を取得するための URL。フォルダーへの URL の場合、Outlook または Outlook on the web 上でフォルダーが正しく表示されるために、IsFolder を true に設定します。必須。	はい	いいえ
ThumbnailUrl	文字列	サムネイルイメージを取得するための、イメージの URL の参照添付ファイルのみに適用されます。SourceUrl によってイメージファイルが識別される場合にのみ、ThumbnailUrl と PreviewUrl を使用します。省略可能。	はい	いいえ

タスク

型:Microsoft.OutlookServices.Task

作業アイテムを追跡することができる Outlook アイテム。タスクを使用すると、開始日時、期限日時、実際の完了日時、進行状況や状態、定期的かどうか、通知が必要かどうかを追跡できます。

日付に関連する次の各プロパティについて:

CompletedDateTime
CreatedDateTime
DueDateTime
LastModifiedDateTime
ReminderDateTime
StartDateTime

プロパティが設定されている場合、既定で Task REST API の REST 応答では UTC で返されます。詳細については、「StartDateTime と DueDateTime の設定」と「カスタムタイムゾーンの日付関連プロパティを返す」をご覧ください。

プロパティ	型	説明	書き込み可能	フィルター処理可能
AssignedTo	文字列	タスクが割り当てられているユーザーの名前。	いいえ	はい
添付ファイル	コレクション (添付ファイル)	タスクの FileAttachment 添付ファイルと ItemAttachment 添付ファイルのコレクションです。ナビゲーションプロパティです。	いいえ	いいえ
本文	ItemBody	通常はタスクに関する情報を含むタスク本体。HTML 型のみがサポートされていることに注意してください。	はい	いいえ
カテゴリ	コレクション (文字列)	タスクに関連付けられたカテゴリ。	はい	はい
ChangeKey	文字列	タスクのバージョン。	いいえ	いいえ
CompletedDateTime	DateTimeTimeZone	タスクが終了した日付 (指定のタイムゾーン)。	はい	はい
CreatedDateTime	DateTimeOffset	タスクが作成された日時。既定では、UTC 時間です。要求ヘッダーでカスタムタイムゾーンを使用できます。	いいえ	はい
DueDateTime	DateTimeTimeZone	タスクが終了する予定の日時 (指定のタイムゾーン)。	はい	はい
HasAttachments	ブール値	タスクに添付ファイルが含まれている場合、true に設定します。	いいえ	はい
ID	文字列	タスクの一意識別子。	いいえ	いいえ
重要度	重要度	イベントの重要度: `Low`、`Normal`、`High`。	はい	はい
IsReminderOn	ブール値	ユーザーにタスクを通知するアラートを設定する場合は、true に設定します。	はい	いいえ
LastModifiedDateTime	DateTimeOffset	タスクが最後に変更された日時。既定では、UTC 時間です。要求ヘッダーでカスタムタイムゾーンを使用できます。	いいえ	はい
オーナー	文字列	タスクを作成したユーザーの名前。	いいえ	はい
ParentFolderId	文字列	タスクの親フォルダーの一意の識別子。	いいえ	いいえ
繰り返し	PatternedRecurrence	タスクの繰り返しパターン。	はい	いいえ
ReminderDateTime	DateTimeTimeZone	タスクのアラーム通知を行う日時。	はい	いいえ
秘密度	秘密度	イベントのプライバシーのレベルを示します: `Normal`、`Personal`、`Private`、`Confidential`。	はい	はい
StartDateTime	DateTimeTimeZone	タスクを開始する日付 (指定のタイムゾーン)。	はい	はい
現在の設定	TaskStatus	タスクの状態または進行状況を示します: `NotStarted`、`InProgress`、`Completed`、`WaitingOnOthers`、`Deferred`。	はい	はい
件名	文字列	タスクのタイトルまたは簡単な説明。	はい	はい

TaskFolder

型:Microsoft.OutlookServices.TaskFolder

タスクを格納するフォルダー。Outlook では、既定のタスクグループ My Tasks には、ユーザーのメールボックス用の既定のタスクフォルダー Tasks が含まれています。これらの既定のタスクグループとフォルダーの名前を変更したり削除したりすることはできませんが、タスクグループとタスクフォルダーを作成することはできます。

プロパティ	型	説明	書き込み可能	フィルター処理可能
ChangeKey	文字列	タスクフォルダーのバージョン。	いいえ	いいえ
ID	文字列	タスクフォルダーの一意識別子。	いいえ	いいえ
IsDefaultFolder	ブール値	フォルダーが既定のタスクフォルダーである場合は true。	いいえ	はい
名前	文字列	タスクフォルダーの名前。	はい	はい
ParentGroupKey	Edm.Guid	タスクフォルダーの親グループの一意の GUID 識別子。	いいえ	いいえ
タスク	コレクション (タスク)	対象タスクフォルダー内のタスク。ナビゲーションプロパティです。	いいえ	いいえ

TaskGroup

型:Microsoft.OutlookServices.TaskGroup

タスクを格納するフォルダーのグループ。Outlook には、名前を変更または削除することができない既定のタスクグループ My Tasks があります。ただし、タスクグループを作成することはできます。

プロパティ	型	説明	書き込み可能	フィルター処理可能
ChangeKey	文字列	タスクグループのバージョン。	いいえ	いいえ
GroupKey	Edm.Guid	タスクグループの一意の GUID 識別子。	いいえ	いいえ
ID	文字列	タスクグループの一意の識別子。	いいえ	いいえ
IsDefaultGroup	ブール値	タスクグループが既定のタスクグループの場合は true。	いいえ	はい
名前	文字列	タスクグループの名前。	はい	はい
TaskFolders	コレクション (TaskFolder)	対象タスクグループ内のタスクフォルダー。ナビゲーションプロパティです。	いいえ	いいえ

ユーザー

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

型: Microsoft.OutlookServices.User

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

注意

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

プロパティ	型	説明	書き込み可能	フィルター処理可能
エイリアス	文字列	ユーザーのエイリアス。通常は、ユーザーの SMTP アドレスです。	はい	はい
予定表	予定表	ユーザーの標準予定表。ナビゲーションプロパティです。	いいえ	いいえ
CalendarGroups	コレクション (CalendarGroup)	ユーザーの予定表グループ。ナビゲーションプロパティです。	いいえ	いいえ
予定表	コレクション (予定表)	ユーザーの予定表。ナビゲーションプロパティです。	いいえ	いいえ
CalendarView	コレクション (イベント)	予定表のカレンダービュー。ナビゲーションプロパティです。	いいえ	いいえ
ContactFolders	コレクション (ContactFolder)	ユーザーの連絡先フォルダー。ナビゲーションプロパティです。	いいえ	いいえ
連絡先	コレクション (連絡先)	ユーザーの連絡先。ナビゲーションプロパティです。	いいえ	いいえ
DisplayName	文字列	ユーザーの表示名。	はい	はい
イベント	コレクション (イベント)	ユーザーのイベント。既定は、既定の予定表の下にイベントを表示することです。ナビゲーションプロパティです。	いいえ	いいえ
ID	文字列	ユーザーの一意の識別子。	いいえ	いいえ
InferenceClassification	InferenceClassification	明示的な指定に基づく、ユーザーのメッセージの関連性の分類。明示的な指定は、推定される関連性や重要性より優先されます。ナビゲーションプロパティです。	はい	はい
MailboxGuid	GUID 型 (GUID)	ユーザーのメールボックスに割り当てられた GUID です。	いいえ	はい
MailboxSettings	MailboxSettings	サインインユーザーのプライマリメールボックスの設定。	はい	いいえ
MailFolders	コレクション (MailFolder)	メールボックス内のフォルダー。ナビゲーションプロパティです。	いいえ	いいえ
メッセージ	コレクション (メッセージ)	メールボックスまたはフォルダー内のメッセージ。ナビゲーションプロパティです。	いいえ	いいえ
RootFolder	MailFolder	ユーザーのメールボックスのルートフォルダー。ナビゲーションプロパティです。	いいえ	いいえ

複合型

出席者
AttendeeAvailability
AttendeeBase
AutomaticRepliesSetting
DateTimeTimeZone
EmailAddress
GeoCoordinates
ItemBody
LocaleInfo
場所
LocationConstraint
LocationConstraintItem
MailboxSettings
MeetingTimeSuggestion
MeetingTimeSuggestionsResult
PatternedRecurrence
PhysicalAddress
宛先
RecurrencePattern
RecurrenceRange
ResponseStatus
TimeConstraint
TimeSlot

出席者

イベントの参加者です。

型:Microsoft.OutlookServices.Recipient

プロパティ	型	説明
現在の設定	ResponseStatus	応答 (なし、承諾、辞退など) と時刻。
型	AttendeeType	出席者の種類です。使用可能な値: `Required`、`Optional`、`Resource`。

AttendeeAvailability

出席者の種類と空き時間情報。

型:Microsoft.OutlookServices.AttendeeAvailability

プロパティ	型	説明
出席者	AttendeeBase	出席者の種類 (人とリソースのどちらか)。
空き時間	FreeBusyStatus	出席者の空き時間の状態。

AttendeeBase

出席者の種類です。

型:Microsoft.OutlookServices.Recipient

プロパティ	型	説明
型	AttendeeType	出席者の種類です。可能な値は、`Required`、`Optional`、`Resource` です。注: 出席者が 1 人である場合、 FindMeetingTimes では常にその人は `Required` 型と見なされます。

AutomaticRepliesSetting

サインインユーザーからのメッセージを使用して、着信メールの送信者に自動的に通知する構成設定。たとえば、サインインユーザーが電子メールに返信できないことを通知する自動返信などです。

型:Microsoft.OutlookServices.AutomaticRepliesSetting

プロパティ	型	説明
ExternalAudience	ExternalAudienceScope	Status が `AlwaysEnabled` または `Scheduled` の場合に、ExternalReplyMessage を受信する、サインインユーザーの組織外の一連の対象ユーザー。値は、`None` = 0、`ContactsOnly` = 1、または `All` = 2 です。
ExternalReplyMessage	文字列	Status が `AlwaysEnabled` または `Scheduled` の場合、指定の外部対象ユーザーに送信される自動応答。
InternalReplyMessage	文字列	Status が `AlwaysEnabled` または `Scheduled` の場合、サインインユーザーの組織内の対象ユーザーに送信される自動応答。
ScheduledEndDateTime	DateTimeTimeZone	Status が `Scheduled` に設定されている場合に、自動応答を終了する日時。`Prefer: outlook.timezone` HTTP ヘッダーで Get 操作を使用して、タイムゾーンを設定できます。
ScheduledStartDateTime	DateTimeTimeZone	Status が `Scheduled` に設定されている場合に、自動応答を開始する日時。`Prefer: outlook.timezone` HTTP ヘッダーで Get 操作を使用して、タイムゾーンを設定できます。
現在の設定	AutomaticRepliesStatus	自動応答の構成状態。`Disabled` = 0、`AlwaysEnabled` = 1、`Scheduled` = 2 です。

DateTimeTimeZone

特定時点の日付、時刻、およびタイムゾーンを記述します。

プロパティ	型	説明
DateTime	DateTime	ISO 8601 形式に従って、特定時点の日付と時刻を組み合わせた表現 (`<date>T<time>`)。
TimeZone	文字列	次のいずれかのタイムゾーン名。

TimeZone プロパティは、Windows でサポートされている任意のタイムゾーン、および次のタイムゾーン名に設定できます。詳細については、「TimeZone」を参照してください。

Etc/GMT+12

Etc/GMT+11

太平洋/ホノルル

アメリカ/アンカレッジ

アメリカ/サンタイサベル

アメリカ/ロサンゼルス

アメリカ/フェニックス

アメリカ/チワワ

アメリカ/デンバー

アメリカ/グアテマラ

アメリカ/シカゴ

アメリカ/メキシコシティ

アメリカ/リジャイナ

アメリカ/ボゴタ

アメリカ/ニューヨーク

アメリカ/インディアナ/インディアナポリス

アメリカ/カラカス

アメリカ/アスンシオン

アメリカ/ハリファックス

アメリカ/クイアバ

アメリカ/ラパス

アメリカ/サンティアゴ

アメリカ/セントジョンズ

アメリカ/サンパウロ

アメリカ/アルゼンチン/ブエノスアイレス

アメリカ/カイエンヌ

アメリカ/ゴットホープ

アメリカ/モンテビデオ

アメリカ/バイア

Etc/GMT+2

大西洋/アゾレス諸島

大西洋/カーボベルデ

アフリカ/カサブランカ

Etc/GMT

ヨーロッパ/ロンドン

大西洋/レイキャビク

ヨーロッパ/ベルリン

ヨーロッパ/ブダペスト

ヨーロッパ/パリ

ヨーロッパ/ワルシャワ

アフリカ/ラゴス

アフリカ/ウィントフック

ヨーロッパ/ブカレスト

アジア/ベイルート

アフリカ/カイロ

アジア/ダマスカス

アフリカ/ヨハネスブルグ

ヨーロッパ/キエフ

ヨーロッパ/イスタンブール

アジア/エルサレム

アジア/アンマン

アジア/バグダッド

ヨーロッパ/カリーニングラード

アジア/リャド

アフリカ/ナイロビ

アジア/テヘラン

アジア/ドバイ

アジア/バクー

ヨーロッパ/モスクワ

インド/モーリシャス

アジア/トビリシ

アジア/エレバン

アジア/カブール

アジア/カラチ

アジア/タシケント

アジア/コルカタ

アジア/コロンボ

アジア/カトマンズ

アジア/アルマトイ

アジア/ダッカ

アジア/エカテリンブルク

アジア/ヤンゴン

アジア/バンコク

アジア/ノボシビルスク

アジア/上海

アジア/クラスノヤルスク

アジア/シンガポール

オーストラリア/パース

アジア/台北

アジア/ウランバートル

アジア/イルクーツク

アジア/東京

アジア/ソウル

オーストラリア/アデレード

オーストラリア/ダーウィン

オーストラリア/ブリスベン

オーストラリア/シドニー

太平洋/ポートモレスビー

オーストラリア/ホバート

アジア/ヤクーツク

太平洋/ガダルカナル島

アジア/ウラジオストク

太平洋/オークランド

Etc/GMT-12

太平洋/フィジー

アジア/マガダン

太平洋/トンガタプ

太平洋/アピア

太平洋/クリスマス島

EmailAddress

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

型: Microsoft.OutlookServices.EmailAddress

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

GeoCoordinates

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

型:Microsoft.OutlookServices.GeoCoordinates

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

ItemBody

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

型: Microsoft.OutlookServices.ItemBody

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

LocaleInfo

サインインしているユーザーの優先言語および国/地域を含むロケールに関する情報。

型: Microsoft.OutlookServices.LocaleInfo

プロパティ	型	説明
DisplayName	文字列	たとえば "English (United States)" のように、ロケールを自然言語で表す名前。
ロケール	文字列	ロケールを表す。これには優先言語および国/地域が含まれます。たとえば、"en-us"。言語のコンポーネントは ISO 639-1 で定義されている 2 文字のコードに従い、国のコンポーネントは ISO 3166-1 alpha-2 で定義されている 2 文字のコードに従います。

場所

イベントの場所です。

型: Microsoft.OutlookServices.Location

プロパティ	型	説明
DisplayName	文字列	場所に関連付けられた名前。
アドレス	PhysicalAddress	場所の物理アドレス。
座標	GeoCoordinates	場所の地理的座標と標高です。
LocationEmailAddress	文字列	場所の電子メールアドレス (省略可能)。

LocationConstraint

会議の場所に関して、クライアントが表明している条件です。

型: Microsoft.OutlookServices.LocationConstraint

プロパティ	型	説明
IsRequired	ブール値	クライアントは、応答に会議の場所を含めるようにサービスに要求します。
SuggestLocation	ブール値	クライアントは、1 つ以上の会議場所を提案するようサービスに要求します。
場所	コレクション (LocationConstraintItem)	クライアントが会議のために要求する 1 つ以上の場所。

LocationConstraintItem

会議の各場所の可用性、および場所に関するその他の情報を確認するために、クライアントが表明している条件。

型: Microsoft.OutlookServices.Location

プロパティ	型	説明
ResolveAvailability	ブール値	true に設定されているときに指定したリソースがビジー状態である場合は、FindMeetingTimes は空いている別のリソースを検索します。false に設定されているときに指定したリソースがビジー状態である場合は、FindMeetingTimes はリソースが空いているかどうかを確認しないで、ユーザーのキャッシュでトップにランク付けられているリソースを返します。既定値は true です。

MailboxSettings

ユーザーのプライマリメールボックスの設定。

型: Microsoft.OutlookServices.MailboxSettings

プロパティ	型	説明
AutomaticRepliesSetting	AutomaticRepliesSetting	着信メッセージに対する返信を自動的に送信する構成の設定。
TimeZone	文字列	ユーザーのメールボックスの既定のタイムゾーン。
言語	LocaleInfo	優先言語および国/地域を含むユーザーのロケール情報。

MeetingTimeSuggestion

会議時間、出席の可能性、各出席者の空き時間情報、利用可能な会議場所を含む、会議の提案です。

型:Microsoft.OutlookServices.MeetingTimeSuggestion

プロパティ	型	説明
MeetingTimeSlot	TimeSlot	会議の提案されている期間。
自信	ダブル	すべての出席者が出席する見込みを表すパーセンテージ。
OrganizerAvailability	FreeBusyStatus	この提案されている会議の開催者の空き時間情報: `Free`、`Tentative`、`Busy`、`Oof`、`WorkingElsewhere`、`Unknown`。
AttendeeAvailability	コレクション (AttendeeAvailability)	この提案された会議の各出席者の空き時間情報の状態を示す配列。
場所	コレクション (場所)	この提案された会議の各会議場所の名前と地理的な場所を指定する配列。
SuggestionReason	文字列	会議時間を提案する理由について記述します。

会議の確実性

MeetingTimeSuggestion の Confidence プロパティの範囲は 0% から 100% で、各個人の空き時間状態に基づいて会議に出席するすべての出席者の見込みを表します。

各出席者に関する、指定の会議期間の空き状態で、確実に出席する場合は 100%、不明な状態は 49%、忙しい場合には 0% です。
会議時間の候補の確実性は、指定された対象会議のすべての出席者の出席見込みの平均によって算出されます。
FindMeetingTimes の MinimumAttendeePercentage オプションパラメーターを使用して、少なくとも特定の信頼度の会議の時間帯のみが返されるように指定することができます。たとえば、すべての出席者が出席する見込みが 80% 以上ある提案のみを行う場合は、80% の MinimumAttendeePercentage を指定できます。MinimumAttendeePercentage を指定しない場合は、FindMeetingTimes は 50% の値を前提とします。
会議時間候補が複数ある場合、FindMeetingTimes アクションは、算出した確実性が高い方から順番に候補を並べて示します。確実性が同じ候補がある場合には、時系列で候補を並べて示します。

たとえば、会議の時間帯に次の空き時間状態の 3 人の出席者がいるとします。

出席者	空き時間状態	出席見込み (%)
ダナ	フリー	100%
John	不明	49%
ファニー	多忙	0%

この場合、出席の平均見込みである会議の時間帯の信頼度は、(100% + 49% + 0%)/3 = 49.66% です。

FindMeetingTimes で 80% の MinimumAttendeePercentage を指定すると、49.66% < 80% のため、操作では応答でこの時間帯は返されません。

MeetingTimeSuggestionsResult

会議の提案がある場合にはそのコレクションを、ない場合にはその理由を示します。

型:Microsoft.OutlookServices.MeetingTimeSuggestionsResult

プロパティ	型	説明
MeetingTimeSuggestions	コレクション (MeetingTimeSuggestion)	会議提案の配列。
EmptySuggestionsReason	文字列	会議提案が 1 つも返されない理由。可能な値: `AttendeesUnavailable`、`LocationsUnavailable`、`OrganizerUnavailable`、`AttendeesUnavailableOrUnknown`、または `Unknown`。

会議提案が 1 つも返されない理由

EmptySuggestionsReason プロパティは、FindMeetingTimes アクションによって会議提案が 1 つも返されない理由として次のいずれかを示します。FindMeetingTimes が何らかの会議提案を返す場合には、このプロパティは空の文字列になります。

値	理由
AttendeesUnavailable	すべての出席者の空き時間情報を把握していますが、会議の確実性しきい値 (既定では 50%) に達するには出席者が足りません。
AttendeesUnavailableOrUnknown	一部またはすべての出席者の空き時間情報が不明なため、会議の確実性が設定されているしきい値 (既定では 50%) を下回っています。出席者が組織外の場合、または空き時間情報の取得でエラーが生じる場合には、出席者の空き時間情報が不明になることがあります。
LocationsUnavailable	LocationConstraint の IsRequired プロパティが必須に指定されているものの、算出された時間範囲で利用可能な場所がありません。
OrganizerUnavailable	IsOrganizerOptional パラメーターが false で、要求された期間中、主催者が現時点で出席可能ではありません。
不明	会議提案が 1 つも返されない理由が不明です。

PatternedRecurrence

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

型: Microsoft.OutlookServices.PatternedRecurrence

プロパティ	型	説明
パターン	RecurrencePattern	イベントの頻度。
範囲	RecurrenceRange	イベントの期間。

PhysicalAddress

連絡先の住所です。

型: Microsoft.OutlookServices.PhysicalAddress

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

宛先

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

型:Microsoft.OutlookServices.Recipient

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

RecurrencePattern

イベントの頻度。

型: Microsoft.OutlookServices.RecurrencePattern

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

RecurrenceRange

イベントの期間。

型: Microsoft.OutlookServices.RecurrenceRange

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

ResponseStatus

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

型: Microsoft.OutlookServices.ResponseStatus

プロパティ	型	説明
応答	ResponseType	応答タイプ: `None`、`Organizer`、`TentativelyAccepted`、`Accepted`、`Declined`、`NotResponded`。
時刻	datetimeoffset	応答が返された日時。

TimeConstraint

指定したアクティビティの性質と空き時間帯に従って、会議の日時の候補を、特定の時間と曜日に限定します。

型: Microsoft.OutlookServices.TimeConstraint

プロパティ	型	説明
ActivityDomain	ActivityDomain	(省略可能) アクティビティの性質: `Work`、`Personal`、`Unrestricted`、`Unknown`。
タイムスロット	コレクション (TimeSlot)	期間の配列。

TimeSlot

期間。

型: Microsoft.OutlookServices.TimeSlot

プロパティ	型	説明
開始	DateTimeTimeZone	期間の開始時間。
終了	DateTimeTimeZone	期間の終了時間。

ActivityDomain

アクティビティの性質。

サポートされている値:

職場
Personal
Unrestricted
不明

AutomaticRepliesStatus

ユーザーのメールボックスでメッセージを受信すると自動返信するための構成の状態です。

サポートされている値:

AlwaysEnabled
Disabled
Scheduled

DayOfWeek

週の曜日のセット。

サポートされている値:

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

ExternalAudienceScope

ExternalReplyMessage を送信する、外部出席者のセット。

サポートされている値:

すべて
ContactsOnly
なし

FreeBusyStatus

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

サポートされている値:

取り込み中
フリー
Oof
Tentative
不明
WorkingElsewhere

InferenceClassificationType

注目するユーザーのメッセージの推定関連性を表します。

サポートされている値:

専心的
その他

ReferenceAttachmentPermissions

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

サポートされている値:

その他
表示
編集
AnonymousView
AnonymousEdit
OrganizationView
OrganizationEdit

ReferenceAttachmentProviders

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

サポートされている値:

ドロップボックス
OneDriveBusiness
OneDriveConsumer
その他

秘密度

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

サポートされている値:

正常
Personal
非公開
Confidential

TaskStatus

タスクの状態または進行状況を示します。

サポートされている値:

TaskStatus
Deferred
InProgress
NotStarted
WaitingOnOthers

OData クエリパラメーター

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

$search 特定の条件で検索する
$filter 特定の条件でフィルターする
$select 特定のプロパティを要求する
$orderby 結果をソートする
$top $skip からページ結果
$expand メッセージの添付ファイルとイベントの添付ファイルを展開する
$count コレクション内のエンティティの数を取得する |||UNTRANSLATED_CONTENT_START|||This parameter goes in the URL path:|||UNTRANSLATED_CONTENT_END||| .../me/calendars/$count

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

検索要求

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

注意

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

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

    {
      "error":
      {
        "code":"ErrorInvalidUrlQuery",
        "message":"The query parameter 'OrderBy' is invalid."
      }
    }

プロパティ	説明
添付ファイル	指定された添付ファイルをタイトルで検索します。
BCC	[Bcc] フィールドを検索します。
Body または Content	[本文] フィールドを検索します。既定の検索でのみサポートされています。
カテゴリ	[カテゴリ] フィールドを検索します。
CC	[CC] フィールドを検索します。
From	[差出人] フィールドを検索します。
含む	[添付ファイルあり] フィールドを検索します。
出席者	[宛先]、[CC]、[BCC] の各フィールドを検索します。
受信済	MM/DD/YYYY として表現された特定の日付を [受信日時] フィールドで検索します。
送り主	[送信者] フィールドを検索します。
件名	[件名] フィールドを検索します。
宛先	[宛先] フィールドを検索します。

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

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

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

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

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

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

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

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

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

GET https://outlook.office.com/api/v2.0/me/messages?$search=%22pizza%22
GET https://outlook.office.com/api/v2.0/me/messages?$search=%22subject:pizza%22
GET https://outlook.office.com/api/v2.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	より大きい	`ReceivedDateTime gt 2014-09-01T00:00:00Z`
ge	以上	`LastModifiedDateTime ge 2014-09-01T00:00:00Z`
lt	より少ない	`ReceivedDateTime lt 2014-09-01T00:00:00Z`
le	以下	`LastModifiedDateTime le 2014-09-01T00:00:00Z`

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

ユーザーの既定の予定表で、指定した日付以降に開始されるすべてのイベントを取得するには、Start プロパティでフィルター処理できます。

GET https://outlook.office.com/api/v2.0/me/events?$filter=Start/DateTime ge '2016-04-01T08:00'

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

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

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

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

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

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

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

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

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

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

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

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

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

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

注意

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

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

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

結果の並べ替え

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

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

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

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

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

結果のページング

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

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

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

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

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

コレクション内のエンティティの数

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

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

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

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

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

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

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

すべてをまとめる

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

Importance が High に設定されたアイテムのみを返します。
Subject、Sender、および ReceivedDateTime プロパティのみを返します。
最初の 5 つのメッセージのみを返します。

注意

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

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

$filter を指定した場合は、サーバーで結果の並べ替え順序が考慮されます。 $filter と$orderby の両方を使用する場合は、$filter 内のプロパティを他のプロパティよりも先に $orderby 内に配置して、$filter パラメーター内の順序で並べる必要があります。

次の例は、Subject と Importance の両方のプロパティでフィルター処理されてから、Subject、Importance、および Sender の各プロパティで並べ替えられたクエリを示しています。

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

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

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

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

Share via

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

添付ファイル

予定表

CalendarGroup

連絡先

ContactFolder

イベント

EventMessage

EventMessageRequest (プレビュー)

拡張プロパティ

MultiValueLegacyExtendedProperty

SingleValueLegacyExtendedProperty

FileAttachment

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

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

InferenceClassification

InferenceClassificationOverride

ItemAttachment

メンション (プレビュー)

メッセージ

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

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

MessageRule (プレビュー)

OutlookCategory (プレビュー)

写真

ReferenceAttachment

タスク

TaskFolder

TaskGroup

ユーザー

複合型

出席者

AttendeeAvailability

AttendeeBase

AutomaticRepliesSetting

DateTimeTimeZone

EmailAddress

GeoCoordinates

ItemBody

LocaleInfo

場所​

LocationConstraint

LocationConstraintItem

MailboxSettings

MeetingTimeSuggestion

会議の確実性

MeetingTimeSuggestionsResult

会議提案が 1 つも返されない理由

PatternedRecurrence

PhysicalAddress

宛先

RecurrencePattern

RecurrenceRange

ResponseStatus

TimeConstraint

TimeSlot

列挙型

ActivityDomain

AutomaticRepliesStatus

DayOfWeek

ExternalAudienceScope

FreeBusyStatus

InferenceClassificationType

ReferenceAttachmentPermissions

ReferenceAttachmentProviders

秘密度

TaskStatus

OData クエリ パラメーター

検索要求

フィルター処理要求

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

結果の並べ替え

結果のページング

コレクション内のエンティティの数

すべてをまとめる

関連項目

その他のリソース

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

場所

OData クエリパラメーター