Table of contents
TOC
目次を折りたたむ
目次を展開する
最終更新日: 2018/07/10

メール、予定表、連絡先、タスク REST API のリソース リファレンス

このドキュメントでは、"(プレビュー)" とマークされている複数のイベントの場所、予定表の共有、@-メンション、クイック応答、言語とタイム ゾーンの選択の新しいリソースと変更されたリソースについて説明します。プレビュー機能は、最終版までに変更される場合があり、それらの機能を使用するコードが動作しなくなる場合もあります。このため、一般に、運用コードでは運用バージョンの API のみを使用してください。入手可能な場合、現時点ではバージョン 2.0 が優先バージョンです。

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

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

この記事では、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 が不要な場合右上隅のコントロールを使用して、必要なバージョンを選択します。

API v2.0 が不要な場合右上隅のコントロールを使用して、必要なバージョンを選択します。

API v1.0 が不要な場合右上隅のコントロールを使用して、必要なバージョンを選択します。

REST API リソース

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

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

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

Attachment

ファイル、アイテム (連絡先、イベント、メッセージ)、またはファイルあるいはフォルダーへのリンク。イベントメッセージ、またはタスクに添付されるものです。その
対応する fileAttachmentitemAttachmentreferenceAttachment リソースは、いずれも Attachment リソースから派生します。

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

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

型:Microsoft.OutlookServices.Entity

プロパティType説明書き込み可能フィルター処理可能
ContentTypeString添付ファイルの MIME タイプ。はいいいえ
IsInlineBooleantrue 添付ファイルがインライン添付ファイルの場合は true、それ以外の場合は falseはいはい
LastModifiedDateTimeDateTimeOffset添付ファイルが最後に変更された日時です。日時は ISO 8601 形式を使って表され、常に UTC 時間です。たとえば、2014 年 1 月 1 日午前 0 時 (UTC) は、次のようになります。'2014-01-01T00:00:00Z'いいえはい
名前String添付ファイルの表示名。実際のファイル名である必要はありません。はいはい
SizeInt32添付ファイルの長さ (バイト単位)。いいえいいえ

Calendar

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

型:Microsoft.OutlookServices.Calendar

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

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

プロパティType説明書き込み可能フィルター処理可能
CanEditBooleanユーザーが予定表に書き込むことができる場合は true、それ以外の場合は false です。予定表を作成したユーザーの場合は、このプロパティは true です。予定表を共有していて、書き込みアクセスが付与されているユーザーの場合も、このプロパティは true です。いいえはい
CanShareBooleanユーザーに予定表を共有するためのアクセス許可がある場合は true、それ以外の場合は false です。予定表を作成したユーザーのみがその予定表を共有できます。いいえはい
CanViewPrivateItemsBooleanユーザーがプライベートとしてマークされている予定表アイテムを読み取れることができる場合は true、それ以外の場合は false です。いいえはい
ChangeKeyString予定表オブジェクトのバージョンを識別します。予定表を変更するたびに ChangeKey も変更されます。これにより、Exchange は正しいバージョンのオブジェクトに変更を適用できます。いいえいいえ
ColorCalendarColorUI で予定表を他の予定表から区別するための配色テーマを指定します。プロパティ値は次のとおりです。薄い青=0、薄い緑=1、薄いオレンジ=2、薄い灰色=3、薄い黄=4、薄い青緑=5、薄いピンク=6、薄い茶色=7、薄い赤=8、最大色=9、自動=-1はいはい
IdString予定表の一意の識別子。いいえいいえ
IsDefaultCalendarBooleanこの予定表がユーザーの既定の予定表であれば True、そうでなければ False。はいはい
IsSharedBooleanユーザーが他のユーザーと予定表を共有している場合は true、それ以外の場合は false です。予定表を共有できるのはその予定表を作成したユーザーのみであるため、同じユーザーに対して IsSharedIsSharedWithMe を true にすることはできません。いいえはい
IsSharedWithMeBooleanユーザーが予定表を共有している場合は true、それ以外の場合は false です。予定表の所有者の場合は、このプロパティは常に false です。いいえはい
名前String予定表の名前。はいはい
OwnerEmailAddress設定すると、これは予定表を作成または追加したユーザーを表します。ユーザーが作成または追加した予定表の場合、Owner プロパティがユーザーに設定されます。ユーザーと共有されている予定表の場合は、Owner プロパティがその予定表をユーザーと共有した人に設定されます。いいえはい
CalendarViewCollection(Event)予定表のカレンダー ビュー。ナビゲーション プロパティです。いいえいいえ
EventsCollection(Event)予定表内のイベント。ナビゲーション プロパティです。いいえいいえ
MultiValueExtendedPropertiescollectionMultiValueLegacyExtendedProperty 型の複数値拡張プロパティのコレクション。これはナビゲーションのプロパティです。詳細については、「拡張プロパティ」を参照してください。はいはい
SingleValueExtendedPropertiescollectionSingleValueLegacyExtendedProperty 型の単一値拡張プロパティのコレクション。これはナビゲーションのプロパティです。詳細については、「拡張プロパティ」を参照してください。はいはい
プロパティType説明書き込み可能フィルター処理可能
CanEditBooleanユーザーが予定表に書き込むことができる場合は true、それ以外の場合は false です。予定表を作成したユーザーの場合は、このプロパティは true です。予定表を共有していて、書き込みアクセスが付与されているユーザーの場合も、このプロパティは true です。いいえはい
CanShareBooleanユーザーに予定表を共有するためのアクセス許可がある場合は true、それ以外の場合は false です。予定表を作成したユーザーのみがその予定表を共有できます。いいえはい
CanViewPrivateItemsBooleanユーザーがプライベートとしてマークされている予定表アイテムを読み取れることができる場合は true、それ以外の場合は false です。いいえはい
ChangeKeyString予定表オブジェクトのバージョンを識別します。予定表を変更するたびに ChangeKey も変更されます。これにより、Exchange は正しいバージョンのオブジェクトに変更を適用できます。いいえいいえ
ColorCalendarColorUI で予定表を他の予定表から区別するための配色テーマを指定します。プロパティ値は次のとおりです。薄い青=0、薄い緑=1、薄いオレンジ=2、薄い灰色=3、薄い黄=4、薄い青緑=5、薄いピンク=6、薄い茶色=7、薄い赤=8、最大色=9、自動=-1はいはい
IdString予定表の一意の識別子。いいえいいえ
名前String予定表の名前。はいはい
OwnerEmailAddress設定すると、これは予定表を作成または追加したユーザーを表します。ユーザーが作成または追加した予定表の場合、Owner プロパティがユーザーに設定されます。ユーザーと共有されている予定表の場合は、Owner プロパティがその予定表をユーザーと共有した人に設定されます。いいえはい
CalendarViewCollection(Event)予定表のカレンダー ビュー。ナビゲーション プロパティです。いいえいいえ
EventsCollection(Event)予定表内のイベント。ナビゲーション プロパティです。いいえいいえ
MultiValueExtendedPropertiescollectionMultiValueLegacyExtendedProperty 型の複数値拡張プロパティのコレクション。これはナビゲーションのプロパティです。詳細については、「拡張プロパティ」を参照してください。はいはい
SingleValueExtendedPropertiescollectionSingleValueLegacyExtendedProperty 型の単一値拡張プロパティのコレクション。これはナビゲーションのプロパティです。詳細については、「拡張プロパティ」を参照してください。はいはい
プロパティType説明書き込み可能フィルター処理可能
名前String予定表の名前。はいはい
ChangeKeyString予定表オブジェクトのバージョンを識別します。予定表を変更するたびに ChangeKey も変更されます。これにより、Exchange は正しいバージョンのオブジェクトに変更を適用できます。いいえいいえ
ColorCalendarColorUI で予定表を他の予定表から区別するための配色テーマを指定します。プロパティ値は次のとおりです。薄い青=0、薄い緑=1、薄いオレンジ=2、薄い灰色=3、薄い黄=4、薄い青緑=5、薄いピンク=6、薄い茶色=7、薄い赤=8、最大色=9、自動=-1はいはい
IdString予定表の一意の識別子。いいえいいえ
CalendarViewCollection(Event)予定表のカレンダー ビュー。ナビゲーション プロパティです。いいえいいえ
EventsCollection(Event)予定表内のイベント。ナビゲーション プロパティです。いいえいいえ

CalendarGroup

予定表のグループです。

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

型:Microsoft.OutlookServices.CalendarGroup

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

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

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

Contact

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

型:Microsoft.OutlookServices.Contact

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

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

プロパティType説明書き込み可能フィルター処理可能
AssistantNameString連絡先のアシスタントの名前。はいはい
Birthdaydatetimeoffset連絡先の誕生日です。はいはい
CategoriesCollection(String)連絡先に関連付けられたカテゴリ。はいいいえ
ChangeKeyString連絡先のバージョンを識別します。連絡先を変更するたびに ChangeKey も変更されます。これにより、Exchange は正しいバージョンのオブジェクトに変更を適用できます。いいえいいえ
ChildrenCollection(String)連絡先の子供の名前。はいはい
CompanyNameString連絡先の会社の名前。はいはい
CreatedDateTimedatetimeoffset連絡先が作成された時刻です。いいえはい
DepartmentString連絡先の部署。はいはい
DisplayNameString連絡先の表示名。はいはい
EmailAddressesCollection(EmailAddress)連絡先のメール アドレス。はいいいえ
ExtensionsCollection(Extension)連絡先に対して定義されているオープン型のデータ拡張機能のコレクション。ナビゲーション プロパティです。いいえはい
FileAsString連絡先がファイルされる名前。はいはい
FlagFollowupFlag連絡先の任意のフォローアップに関する情報。はいはい
性別String連絡先の性別。はいはい
GenerationString連絡先の世代。はいはい
GivenNameString連絡先の名。はいはい
IdString連絡先の一意の識別子。いいえいいえ
ImAddressesCollection(String)連絡先のインスタント メッセージング (IM) アドレス。はいいいえ
InitialsString連絡先のイニシャル。はいはい
JobTitleString連絡先の役職。はいはい
LastModifiedDateTimedatetimeoffset連絡先が変更された時刻です。いいえはい
ManagerString連絡先の上司の名前。はいはい
MiddleNameString連絡先のミドル ネーム。はいはい
NickNameString連絡先のニックネーム。はいはい
OfficeLocationString連絡先のオフィスの所在地。はいはい
ParentFolderIdString連絡先の親フォルダーの ID。いいえいいえ
PersonalNotesString連絡先に関するユーザーのメモ。はいはい
電話コレクション (電話)自宅電話、携帯電話、勤務先電話など、連絡先に関連付けられた電話番号。はいはい
PostalAddressesPhysicalAddress コレクション自宅住所や勤務先住所など、連絡先に関連付けられた住所。はいいいえ
ProfessionString連絡先の専門的職業。はいはい
SpouseNameString連絡先の配偶者の名前。はいはい
SurnameString連絡先の姓。はいはい
TitleString連絡先の肩書。はいいいえ
Web サイトコレクション (Web サイト)連絡先に関連付けられた Web サイト。はいいいえ
WeddingAnniversary日付連絡先の結婚記念日。はいはい
YomiCompanyNameString連絡先の会社名の読み仮名。このプロパティは省略可能です。はいいいえ
YomiGivenNameString連絡先の名 (ファースト ネーム) の読み仮名。このプロパティは省略可能です。はいいいえ
YomiSurnameString連絡先の姓 (ラスト ネーム) の読み仮名。このプロパティは省略可能です。はいいいえ

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

プロパティType説明書き込み可能フィルター処理可能
AssistantNameString連絡先のアシスタントの名前。はいはい
Birthdaydatetimeoffset連絡先の誕生日です。はいはい
BusinessAddressPhysicalAddress連絡先の勤務先の住所。はいはい
BusinessHomePageString連絡先の勤務先のホーム ページ。はいはい
BusinessPhonesCollection(String)連絡先の勤務先の電話番号。はいいいえ
CategoriesCollection(String)連絡先に関連付けられたカテゴリ。はいいいえ
ChangeKeyString連絡先のバージョンを識別します。連絡先を変更するたびに ChangeKey も変更されます。これにより、Exchange は正しいバージョンのオブジェクトに変更を適用できます。いいえいいえ
ChildrenCollection(String)連絡先の子供の名前。はいはい
CompanyNameString連絡先の会社の名前。はいはい
DepartmentString連絡先の部署。はいはい
CreatedDateTimedatetimeoffset連絡先が作成された時刻です。いいえはい
LastModifiedDateTimedatetimeoffset連絡先が変更された時刻です。いいえはい
DisplayNameString連絡先の表示名。はいはい
EmailAddressesCollection(EmailAddress)連絡先のメール アドレス。はいいいえ
ExtensionsCollection(Extension)連絡先に対して定義されているオープン型のデータ拡張機能のコレクション。ナビゲーション プロパティです。いいえはい
FileAsString連絡先がファイルされる名前。はいはい
GenerationString連絡先の世代。はいはい
GivenNameString連絡先の名。はいはい
HomeAddressPhysicalAddress連絡先の自宅住所。はいはい
HomePhonesCollection(String)連絡先の自宅の電話番号。はいいいえ
IdString連絡先の一意の識別子。いいえいいえ
ImAddressesCollection(String)連絡先のインスタント メッセージング (IM) アドレス。はいいいえ
InitialsString連絡先のイニシャル。はいはい
JobTitleString連絡先の役職。はいはい
ManagerString連絡先の上司の名前。はいはい
MiddleNameString連絡先のミドル ネーム。はいはい
MobilePhone1String連絡先の携帯電話番号。はいはい
NickNameString連絡先のニックネーム。はいはい
OfficeLocationString連絡先のオフィスの所在地。はいはい
OtherAddressPhysicalAddress連絡先の別の住所。はいはい
ParentFolderIdString連絡先の親フォルダーの ID。いいえいいえ
PersonalNotesString連絡先に関するユーザーのメモ。はいはい
ProfessionString連絡先の専門的職業。はいはい
SpouseNameString連絡先の配偶者の名前。はいはい
SurnameString連絡先の姓。はいはい
TitleString連絡先の肩書。はいいいえ
YomiCompanyNameString連絡先の会社名の読み仮名。はいいいえ
YomiGivenNameString連絡先の名 (ファースト ネーム) の読み仮名。はいいいえ
YomiSurnameString連絡先の姓 (ラスト ネーム) の読み仮名。はいいいえ

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

プロパティType説明書き込み可能フィルター処理可能
AssistantNameString連絡先のアシスタントの名前。はいはい
Birthdaydatetimeoffset連絡先の誕生日です。はいはい
BusinessAddressPhysicalAddress連絡先の勤務先の住所。はいはい
BusinessHomePageString連絡先の勤務先のホーム ページ。はいはい
BusinessPhonesCollection(String)連絡先の勤務先の電話番号。はいいいえ
CategoriesCollection(String)連絡先に関連付けられたカテゴリ。はいいいえ
ChangeKeyString連絡先のバージョンを識別します。連絡先を変更するたびに ChangeKey も変更されます。これにより、Exchange は正しいバージョンのオブジェクトに変更を適用できます。いいえいいえ
ChildrenCollection(String)連絡先の子供の名前。はいはい
CompanyNameString連絡先の会社の名前。はいはい
DepartmentString連絡先の部署。はいはい
DateTimeCreateddatetimeoffset連絡先が作成された時刻です。いいえはい
DateTimeLastModifieddatetimeoffset連絡先が変更された時刻です。いいえはい
DisplayNameString連絡先の表示名。はいはい
EmailAddressesCollection(EmailAddress)連絡先のメール アドレス。はいいいえ
FileAsString連絡先がファイルされる名前。はいはい
GenerationString連絡先の世代。はいはい
GivenNameString連絡先の名。はいはい
HomeAddressPhysicalAddress連絡先の自宅住所。はいはい
HomePhonesCollection(String)連絡先の自宅の電話番号。はいいいえ
IdString連絡先の一意の識別子。いいえいいえ
ImAddressesCollection(String)連絡先のインスタント メッセージング (IM) アドレス。はいいいえ
InitialsString連絡先のイニシャル。はいはい
JobTitleString連絡先の役職。はいはい
ManagerString連絡先の上司の名前。はいはい
MiddleNameString連絡先のミドル ネーム。はいはい
MobilePhone1String連絡先の携帯電話番号。はいはい
NickNameString連絡先のニックネーム。はいはい
OfficeLocationString連絡先のオフィスの所在地。はいはい
OtherAddressPhysicalAddress連絡先の別の住所。はいはい
ParentFolderIdString連絡先の親フォルダーの ID。いいえいいえ
PersonalNotesString連絡先に関するユーザーのメモ。はいはい
ProfessionString連絡先の専門的職業。はいはい
SpouseNameString連絡先の配偶者の名前。はいはい
SurnameString連絡先の姓。はいはい
TitleString連絡先の肩書。はいいいえ
YomiCompanyNameString連絡先の会社名の読み仮名。このプロパティは省略可能です。はいいいえ
YomiGivenNameString連絡先の名 (ファースト ネーム) の読み仮名。このプロパティは省略可能です。はいいいえ
YomiSurnameString連絡先の姓 (ラスト ネーム) の読み仮名。このプロパティは省略可能です。はいいいえ

ContactFolder

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

型:Microsoft.OutlookServices.ContactFolder

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

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

プロパティType説明書き込み可能フィルター処理可能
ChildFoldersCollection(ContactFolder)フォルダー内の子フォルダーのコレクション。ナビゲーション プロパティです。いいえいいえ
ContactsCollection(Contact)フォルダー内の連絡先。ナビゲーション プロパティです。いいえいいえ
DisplayNameStringフォルダーの表示名。はいはい
IdString連絡先フォルダーの一意の識別子。いいえいいえ
ParentFolderIdStringフォルダーの親フォルダーの ID。いいえいいえ
WellKnownNameStringフォルダーが認識されているフォルダーである場合、フォルダーの名前。現在、認識されている連絡先フォルダーは contacts のみです。いいえいいえ
MultiValueExtendedPropertiescollectionMultiValueLegacyExtendedProperty 型の複数値拡張プロパティのコレクション。これはナビゲーションのプロパティです。詳細については、「拡張プロパティ」を参照してください。はいはい
SingleValueExtendedPropertiescollectionSingleValueLegacyExtendedProperty 型の単一値拡張プロパティのコレクション。これはナビゲーションのプロパティです。詳細については、「拡張プロパティ」を参照してください。はいはい
プロパティType説明書き込み可能フィルター処理可能
ChildFoldersCollection(ContactFolder)フォルダー内の子フォルダーのコレクション。ナビゲーション プロパティです。いいえいいえ
ContactsCollection(Contact)フォルダー内の連絡先。ナビゲーション プロパティです。いいえいいえ
DisplayNameStringフォルダーの表示名。はいはい
IdString連絡先フォルダーの一意の識別子。いいえいいえ
ParentFolderIdStringフォルダーの親フォルダーの ID。いいえいいえ
MultiValueExtendedPropertiescollectionMultiValueLegacyExtendedProperty 型の複数値拡張プロパティのコレクション。これはナビゲーションのプロパティです。詳細については、「拡張プロパティ」を参照してください。はいはい
SingleValueExtendedPropertiescollectionSingleValueLegacyExtendedProperty 型の単一値拡張プロパティのコレクション。これはナビゲーションのプロパティです。詳細については、「拡張プロパティ」を参照してください。はいはい
プロパティType説明書き込み可能フィルター処理可能
ChildFoldersCollection(ContactFolder)フォルダー内の子フォルダーのコレクション。ナビゲーション プロパティです。いいえいいえ
ContactsCollection(Contact)フォルダー内の連絡先。ナビゲーション プロパティです。いいえいいえ
DisplayNameStringフォルダーの表示名。はいはい
IdString連絡先フォルダーの一意の識別子。いいえいいえ
ParentFolderIdStringフォルダーの親フォルダーの ID。いいえいいえ

Event

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

型:Microsoft.OutlookServices.Event

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

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

プロパティType説明書き込み可能フィルター処理可能
AttachmentsCollection(Attachment)イベントの FileAttachmentItemAttachmentReferenceAttachment の各添付ファイルのコレクション。ナビゲーション プロパティです。いいえいいえ
AttendeesCollection(Attendee)イベントの参加者のコレクション。はいいいえ
BodyItemBodyイベントに関連付けられたメッセージの本文。はいいいえ
BodyPreviewStringイベントに関連付けられたメッセージのプレビュー。いいえいいえ
CalendarCalendarイベントを含む予定表。ナビゲーション プロパティです。いいえいいえ
CategoriesCollection(String)イベントに関連付けられたカテゴリ。はいいいえ
ChangeKeyStringイベント オブジェクトのバージョンを識別します。イベントを変更するたびに ChangeKey も変更されます。これにより、Exchange は正しいバージョンのオブジェクトに変更を適用できます。いいえいいえ
CreatedDateTimedatetimeoffsetイベントが作成された日時です。いいえはい
EndDateTimeTimeZoneイベントが終了する日時。はいはい
ExtensionsCollection(Extension)イベントに対して定義されているオープン型のデータ拡張機能のコレクション。ナビゲーション プロパティです。いいえはい
HasAttachmentsbooleanイベントに添付ファイルが含まれている場合に、true に設定します。いいえはい
IdStringイベントの一意識別子。いいえいいえ
ImportanceImportanceイベントの重要度: LowNormalHighはいはい
InstancesCollection(Event)イベントのインスタンス。ナビゲーション プロパティです。いいえいいえ
iCalUIDString複数の予定表を通して 1 つのイベントのすべてのインスタンスで共有される一意の識別子。いいえはい
IsAllDaybooleanイベントが一日中続く場合に、true に設定します。このプロパティを調整するには、イベントの Start および End プロパティの調整も必要になります。はいはい
IsCancelledbooleanイベントがキャンセルされた場合に、true に設定します。はいはい
IsOrganizerbooleanメッセージの送信者が主催者でもある場合に、true に設定します。はいはい
IsReminderOnBooleanユーザーにイベントを通知するアラートを設定する場合は、true に設定します。はいはい
LastModifiedDateTimedatetimeoffsetイベントが最後に変更された日時です。いいえはい
LocationLocationイベントの場所の情報です。はいはい
LocationsCollection(Location)イベントを開催する場所、または参加者がいる場所。はいはい
OnlineMeetingUrlStringオンライン会議の URL。はいいいえ
OrganizerRecipientイベントの主催者。はいはい
OriginalEndTimeZoneStringイベントが作成されたときに設定された終了タイム ゾーン。有効なタイム ゾーンの一覧については、「DateTimeTimeZone」を参照してください。いいえはい
OriginalStartTimeZoneStringイベントが作成されたときに設定された開始タイム ゾーン。有効なタイム ゾーンの一覧については、「DateTimeTimeZone」を参照してください。いいえはい
RecurrencePatternedRecurrenceイベントの繰り返しパターン。はいいいえ
ReminderMinutesBeforeStartInt32アラーム通知を行う、イベント開始時間前の分数。はいいいえ
ResponseRequestedbooleanイベントが承諾または辞退されたときに、送信者が応答を要求する場合に、true に設定します。はいはい
ResponseStatusResponseStatusイベント メッセージへの応答で送信される応答のタイプを識別します。いいえはい
SensitivitySensitivityイベントのプライバシーのレベルを示します: NormalPersonalPrivateConfidentialはいはい
SeriesMasterIdStringアイテムに割り当てられたカテゴリ。はいいいえ
ShowAsFreeBusyStatus表示するステータス: FreeTentativeBusyOofWorkingElsewhereUnknownはい可能
StartDateTimeTimeZoneイベントの開始時刻です。はいはい
SubjectStringイベントの件名行のテキスト。はいはい
TypeEventTypeイベントの種類: SingleInstanceOccurrenceExceptionSeriesMasterはいはい
WebLinkStringOutlook Web App でイベントを開く URL。

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

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

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

プロパティType説明書き込み可能フィルター処理可能
AttachmentsCollection(Attachment)イベントの FileAttachmentItemAttachmentReferenceAttachment の各添付ファイルのコレクション。ナビゲーション プロパティです。いいえいいえ
AttendeesCollection(Attendee)イベントの参加者のコレクション。はいいいえ
BodyItemBodyイベントに関連付けられたメッセージの本文。はいいいえ
BodyPreviewStringイベントに関連付けられたメッセージのプレビュー。いいえいいえ
CalendarCalendarイベントを含む予定表。ナビゲーション プロパティです。いいえいいえ
CategoriesCollection(String)イベントに関連付けられたカテゴリ。はいいいえ
ChangeKeyStringイベント オブジェクトのバージョンを識別します。イベントを変更するたびに ChangeKey も変更されます。これにより、Exchange は正しいバージョンのオブジェクトに変更を適用できます。いいえいいえ
CreatedDateTimedatetimeoffsetイベントが作成された日時です。いいえはい
LastModifiedDateTimedatetimeoffsetイベントが最後に変更された日時です。いいえはい
EndDateTimeTimeZoneイベントの終了時刻。はいはい
ExtensionsCollection(Extension)イベントに対して定義されているオープン型のデータ拡張機能のコレクション。ナビゲーション プロパティです。いいえはい
HasAttachmentsbooleanイベントに添付ファイルが含まれている場合に、true に設定します。いいえはい
IdStringイベントの一意識別子。いいえいいえ
ImportanceImportanceイベントの重要度: LowNormalHighはいはい
InstancesCollection(Event)イベントのインスタンス。ナビゲーション プロパティです。いいえいいえ
iCalUIDString複数の予定表を通して 1 つのイベントのすべてのインスタンスで共有される一意の識別子。いいえはい
IsAllDaybooleanイベントが一日中続く場合に、true に設定します。このプロパティを調整するには、イベントの Start および End プロパティの調整も必要になります。はいはい
IsCancelledbooleanイベントがキャンセルされた場合に、true に設定します。はいはい
IsOrganizerbooleanメッセージの送信者が主催者でもある場合に、true に設定します。はいはい
IsReminderOnBooleanユーザーにイベントを通知するアラートを設定する場合は、true に設定します。はいはい
LocationLocationイベントの場所。はいはい
OnlineMeetingUrlStringオンライン会議の URL。はいいいえ
OrganizerRecipientイベントの主催者。はいはい
OriginalEndTimeZoneStringイベントが作成されたときに設定された終了タイム ゾーン。有効なタイム ゾーンの一覧については、「DateTimeTimeZone」を参照してください。いいえはい
OriginalStartTimeZoneStringイベントが作成されたときに設定された開始タイム ゾーン。有効なタイム ゾーンの一覧については、「DateTimeTimeZone」を参照してください。いいえはい
RecurrencePatternedRecurrenceイベントの繰り返しパターン。はいいいえ
ReminderMinutesBeforeStartInt32アラーム通知を行う、イベント開始時間前の分数。はいいいえ
ResponseRequestedbooleanイベントが承諾または辞退されたときに、送信者が応答を要求する場合に、true に設定します。はいはい
ResponseStatusResponseStatusイベント メッセージへの応答で送信される応答のタイプを識別します。いいえはい
SensitivitySensitivityイベントのプライバシーのレベルを示します。標準 = 0、個人 = 1、非公開 = 2、社外秘 = 3 です。はいはい
SeriesMasterIdStringアイテムに割り当てられたカテゴリ。はいいいえ
ShowAsFreeBusyStatus次のようなステータスを示します。予定なし = 0、仮の予定 = 1、予定あり = 2、休暇 = 3、離席 = 4、不明 = -1。はい可能
StartDateTimeTimeZoneイベントの開始時刻です。はいはい
TypeEventType次のようなイベント タイプがあります。単一インスタンス = 0、発生 = 1、例外 = 2、連続マスター = 3。はいはい
WebLinkStringOutlook Web App でイベントを開く URL。

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

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

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

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

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

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

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

詳細については、「TimeZone」を参照してください。
はいいいえ
HasAttachmentsbooleanイベントに添付ファイルが含まれている場合に、true に設定します。いいえはい
IdStringイベントの一意識別子。いいえいいえ
ImportanceImportanceイベントの重要度: LowNormalHighはいはい
InstancesCollection(Event)イベントのインスタンス。ナビゲーション プロパティです。いいえいいえ
iCalUIDString複数の予定表を通して 1 つのイベントのすべてのインスタンスで共有される一意の識別子。いいえはい
IsAllDaybooleanイベントが一日中続く場合に、true に設定します。このプロパティを調整するには、イベントの Start および End プロパティの調整も必要になります。はいはい
IsCancelledbooleanイベントがキャンセルされた場合に、true に設定します。はいはい
IsOrganizerbooleanメッセージの送信者が主催者でもある場合に、true に設定します。はいはい
LocationLocationイベントの場所。はいはい
OrganizerRecipientイベントの主催者。はいはい
RecurrencePatternedRecurrenceイベントの繰り返しパターン。はいいいえ
ResponseRequestedbooleanイベントが承諾または辞退されたときに、送信者が応答を要求する場合に、true に設定します。はいはい
ResponseStatusResponseStatusイベント メッセージへの応答で送信される応答のタイプを識別します。いいえはい
SensitivitySensitivityイベントのプライバシーのレベルを示します。標準 = 0、個人 = 1、非公開 = 2、社外秘 = 3 です。はいはい
SeriesMasterIdStringアイテムに割り当てられたカテゴリ。はいいいえ
ShowAsFreeBusyStatus次のようなステータスを示します。予定なし = 0、仮の予定 = 1、予定あり = 2、休暇 = 3、離席 = 4、不明 = -1。はい可能
Startdatetimeoffsetイベントの開始時刻です。

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

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

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

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

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

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

EventMessage

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

基本型: Message

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

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

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

プロパティType説明書き込み可能フィルター処理可能
EndDateTimeDateTimeTimeZone関連するイベントが終了する日時。はいはい
EventEventイベント メッセージに関連付けられたイベント。参加者または部屋リソースの前提は、会議出席依頼イベント メッセージが届いたときにイベントを含む予定表を自動的に更新するようにカレンダー アテンダントが設定されていることです。ナビゲーション プロパティです。いいえいいえ
IsAllDayBooleanイベントが 1 日中続くかどうかを示します。このプロパティを調整するには、イベントの StartDateTime および EndDateTime プロパティの調整も必要になります。はいはい
IsOutOfDateBooleanこの会議出席要求がより新しい要求によって古くなっているかどうかを示します。いいえいいえ
LocationLocation関連するイベントの場所。はいはい
MeetingMessageTypeMeetingMessageTypeイベント メッセージのタイプ。なし = 0、会議開催依頼 = 1、会議の中止 = 2、会議の承諾 = 3、会議の一時承諾 = 4、会議の辞退 = 5。いいえはい
RecurrencePatternedRecurrence関連するイベントの繰り返しパターン。はいいいえ
StartDateTimeDateTimeTimeZone関連するイベントの開始時刻。はいはい
TypeEventType関連するイベントの種類。単一インスタンス = 0、発生 = 1、例外 = 2、連続マスター = 3。はいはい
プロパティType説明書き込み可能フィルター処理可能
EventEventイベント メッセージに関連付けられたイベント。参加者または部屋リソースの前提は、会議出席依頼イベント メッセージが届いたときにイベントを含む予定表を自動的に更新するようにカレンダー アテンダントが設定されていることです。ナビゲーション プロパティです。いいえいいえ
MeetingMessageTypeMeetingMessageTypeイベント メッセージのタイプ。なし = 0、会議開催依頼 = 1、会議の中止 = 2、会議の承諾 = 3、会議の一時承諾 = 4、会議の辞退 = 5。いいえはい
プロパティType説明書き込み可能フィルター処理可能
EventEventイベント メッセージに関連付けられたイベント。参加者または部屋リソースの前提は、会議出席依頼イベント メッセージが届いたときにイベントを含む予定表を自動的に更新するようにカレンダー アテンダントが設定されていることです。ナビゲーション プロパティです。いいえいいえ
MeetingMessageTypeMeetingMessageTypeイベント メッセージのタイプ。なし = 0、会議開催依頼 = 1、会議の中止 = 2、会議の承諾 = 3、会議の一時承諾 = 4、会議の辞退 = 5。いいえはい

EventMessageRequest (プレビュー)

会議出席依頼を表すメッセージ。

基本型: EventMessage

プロパティType説明書き込み可能フィルター処理可能
PreviousEndDateTimeDateTimeTimeZone会議出席依頼の以前の終了日時。いいえはい
PreviousLocationLocation会議出席依頼の以前の場所。いいえはい
PreviousStartDateTimeDateTimeTimeZone会議出席依頼の以前の開始日時。いいえはい

この機能は現在ベータ版として利用できます。詳細については、記事の右上隅にコントロールを使用して、[ベータ版] を選択します。

この機能は現在ベータ版として利用できます。詳細については、記事の右上隅にコントロールを使用して、[ベータ版] を選択します。

拡張プロパティ

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

MultiValueLegacyExtendedProperty

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

型:Microsoft.OutlookServices.MultiValueLegacyExtendedProperty

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

SingleValueLegacyExtendedProperty

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

型:Microsoft.OutlookServices.SingleValueLegacyExtendedProperty

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

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

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

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

MultiValueLegacyExtendedProperty

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

型:Microsoft.OutlookServices.MultiValueLegacyExtendedProperty

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

SingleValueLegacyExtendedProperty

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

型:Microsoft.OutlookServices.SingleValueLegacyExtendedProperty

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

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

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

この機能は現在ベータ版および v2.0 で利用できます。詳細については、記事の右上隅のコントロールを使用して、バージョンを選びます。

FileAttachment

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

型:Microsoft.OutlookServices.FileAttachment

基本型: Microsoft.OutlookServices.Attachment

プロパティType説明書き込み可能
ContentBytesbinaryファイルのバイナリ コンテンツです。いいえ
ContentIdStringExchange ストア内の添付ファイルの ID。いいえ
ContentLocationString添付ファイルのコンテンツの場所に対応する Uniform Resource Identifier (URI)。いいえ
ContentTypeString添付ファイルのコンテンツ タイプ。はい
LastModifiedDateTimedatetimeoffset添付ファイルが最後に変更された日時です。いいえ
IdString添付ファイル ID。いいえ
IsInlinebooleanインライン添付ファイルの場合、true に設定します。はい
名前String埋め込み添付ファイルを表すアイコンの下に表示されるテキストを表す名前。これは、実際のファイル名にする必要はありません。はい
SizeInt32添付ファイルのバイト単位のサイズ。いいえ

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

型:Microsoft.OutlookServices.FileAttachment

基本型: Microsoft.OutlookServices.Attachment

プロパティType説明書き込み可能
ContentBytesbinaryファイルのバイナリ コンテンツです。いいえ
ContentIdStringExchange ストア内の添付ファイルの ID。いいえ
ContentLocationString添付ファイルのコンテンツの場所に対応する Uniform Resource Identifier (URI)。いいえ
ContentTypeString添付ファイルのコンテンツ タイプ。はい
LastModifiedDateTimedatetimeoffset添付ファイルが最後に変更された日時です。いいえ
IdString添付ファイル ID。いいえ
IsInlinebooleanインライン添付ファイルの場合、true に設定します。はい
名前String埋め込み添付ファイルを表すアイコンの下に表示されるテキストを表す名前。これは、実際のファイル名にする必要はありません。はい
SizeInt32添付ファイルのバイト単位のサイズ。いいえ

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

型:Microsoft.OutlookServices.FileAttachment

基本型: Microsoft.OutlookServices.Attachment

プロパティType説明書き込み可能
ContentBytesbinaryファイルのバイナリ コンテンツです。いいえ
ContentIdStringExchange ストア内の添付ファイルの ID。いいえ
ContentLocationString添付ファイルのコンテンツの場所に対応する Uniform Resource Identifier (URI)。いいえ
ContentTypeString添付ファイルのコンテンツ タイプ。はい
DateTimeLastModifieddatetimeoffset添付ファイルが最後に変更された日時です。いいえ
IdString添付ファイル ID。いいえ
IsContactPhotoboolean現在は使用されていません。はい
IsInlinebooleanインライン添付ファイルの場合、true に設定します。はい
名前String埋め込み添付ファイルを表すアイコンの下に表示されるテキストを表す名前。これは、実際のファイル名にする必要はありません。はい
SizeInt32添付ファイルのバイト単位のサイズ。いいえ

Folder / MailFolder

ベータ版では、以前は Folder という名前のエンティティと型が MailFolder という名前に変更されました。

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

型:Microsoft.OutlookServices.MailFolder

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

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

プロパティType説明書き込み可能フィルター処理可能
ChildFolderCountInt32フォルダー内のフォルダー数。いいえはい
ChildFoldersCollection(MailFolder)フォルダー内の子フォルダーのコレクション。ナビゲーション プロパティです。いいえいいえ
DisplayNameStringフォルダーの表示名。はいはい
IdStringフォルダーの一意の識別子。次の既知の名前を使用して対応するフォルダーにアクセスできます。InboxDraftsSentItemsDeletedItemsいいえいいえ
MessageRulesCollection(MessageRule)受信トレイ フォルダーに適用されるルールのコレクションです。ナビゲーション プロパティです。いいえいいえ
MessagesCollection(Message)フォルダー内のメッセージのコレクション。ナビゲーション プロパティです。いいえいいえ
ParentFolderIdStringフォルダーの親フォルダーの一意の識別子。いいえいいえ
TotalItemCountInt32フォルダーに含まれるアイテムの数。いいえはい
UnreadItemCountInt32フォルダー内で未読としてマークされているアイテム数。いいえはい
WellKnownNameStringdeleteditemsdraftsinboxjunkemailoutboxsentitems などの、フォルダーの既知の名前。clutterいいえはい
MultiValueExtendedPropertiescollectionMultiValueLegacyExtendedProperty 型の複数値拡張プロパティのコレクション。これはナビゲーションのプロパティです。詳細については、「拡張プロパティ」を参照してください。はいはい
SingleValueExtendedPropertiescollectionSingleValueLegacyExtendedProperty 型の単一値拡張プロパティのコレクション。これはナビゲーションのプロパティです。詳細については、「拡張プロパティ」を参照してください。はいはい

アイテム数を効率的に取得する

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

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

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

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

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

型:Microsoft.OutlookServices.MailFolder

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

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

プロパティType説明書き込み可能フィルター処理可能
ChildFolderCountInt32フォルダー内のフォルダー数。いいえはい
ChildFoldersCollection(MailFolder)フォルダー内の子フォルダーのコレクション。ナビゲーション プロパティです。いいえいいえ
DisplayNameStringフォルダーの表示名。はいはい
IdStringフォルダーの一意の識別子。次の既知の名前を使用して対応するフォルダーにアクセスできます。InboxDraftsSentItemsDeletedItemsいいえいいえ
MessagesCollection(Message)フォルダー内のメッセージのコレクション。ナビゲーション プロパティです。いいえいいえ
ParentFolderIdStringフォルダーの親フォルダーの一意の識別子。いいえいいえ
TotalItemCountInt32フォルダーに含まれるアイテムの数。いいえはい
UnreadItemCountInt32フォルダー内で未読としてマークされているアイテム数。いいえはい
MultiValueExtendedPropertiescollectionMultiValueLegacyExtendedProperty 型の複数値拡張プロパティのコレクション。これはナビゲーションのプロパティです。詳細については、「拡張プロパティ」を参照してください。はいはい
SingleValueExtendedPropertiescollectionSingleValueLegacyExtendedProperty 型の単一値拡張プロパティのコレクション。これはナビゲーションのプロパティです。詳細については、「拡張プロパティ」を参照してください。はいはい

アイテム数を効率的に取得する

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

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

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

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

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

型:Microsoft.OutlookServices.Folder

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

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

プロパティType説明書き込み可能フィルター処理可能
ChildFolderCountInt32フォルダー内のフォルダー数。いいえはい
ChildFoldersCollection(Folder)フォルダー内の子フォルダーのコレクション。ナビゲーション プロパティです。いいえいいえ
DisplayNameStringフォルダーの表示名。はいはい
IdStringフォルダーの一意の識別子。次の既知の名前を使用して対応するフォルダーにアクセスできます。InboxDraftsSentItemsDeletedItemsいいえいいえ
MessagesCollection(Message)フォルダー内のメッセージのコレクション。ナビゲーション プロパティです。いいえいいえ
ParentFolderIdStringフォルダーの親フォルダーの一意の識別子。いいえいいえ
TotalItemCountInt32フォルダーに含まれるアイテムの数。いいえはい
UnreadItemCountInt32フォルダー内で未読としてマークされているアイテム数。いいえはい

アイテム数を効率的に取得する

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

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

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

InferenceClassification

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

型:Microsoft.OutlookServices.InferenceClassification

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

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

型:Microsoft.OutlookServices.InferenceClassification

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

この機能は現在 v2.0 とベータ版で利用できます。詳細については、記事の右上隅にコントロールを使用して、どちらかのバージョンを選択します。

InferenceClassificationOverride

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

型:Microsoft.OutlookServices.InferenceClassificationOverride

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

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

型:Microsoft.OutlookServices.InferenceClassificationOverride

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

この機能は現在 v2.0 とベータ版で利用できます。詳細については、記事の右上隅にコントロールを使用して、どちらかのバージョンを選択します。

ItemAttachment

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

型:Microsoft.OutlookServices.ItemAttachment

基本型: Microsoft.OutlookServices.Attachment

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

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

型:Microsoft.OutlookServices.ItemAttachment

基本型: Microsoft.OutlookServices.Attachment

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

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

型:Microsoft.OutlookServices.ItemAttachment

基本型: Microsoft.OutlookServices.Attachment

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

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

メール アドレスに基づく人物への通知を表します。この種類の通知は、@-mention とも呼ばれています。

Message リソースは Mention をサポートしています。サインインしているユーザーがそのインスタンスでメンションされているかどうかを示す MentionsPreview と、そのインスタンスでのすべてのメンションに関する詳細の取得をサポートする Mentions ナビゲーション プロパティが含まれています。

メッセージを作成すると、アプリは、Mentions プロパティにメンションを含むことで、同じ POST 要求にメンションを作成できます。$filter クエリ パラメーターを含む GET 要求を使用して、アプリは、サインインしているユーザーのメールボックス内にある、ユーザーをメンションするすべてのメッセージを返すことができます。$expand クエリ パラメーターを含む GET 要求によって、アプリは特定のメッセージのすべてのメンションを展開できるようになります。

アプリがメッセージ内のメンションを設定して取得できるようにするこのメカニズムによって、簡易的な通知が可能になり、アプリが基になる Mentions プロパティを設定すると同時に、メンションを行うユーザーは既存のコンテキスト内に留まることができます (メッセージ本文の作成など)。メンションされたユーザーは、$filter または $expand クエリ パラメーターを含む GET 要求を介して、ユーザーがメンションされたかどうかとメンションされた場所を簡単に検索することができます。

メンション API の使用例は、メール クライアントの Outlook にあります。メッセージの作成中にユーザーが @ と入力すると、Outlook では、ユーザーは名前を選択するか入力するだけで @-mention を完了できます。注意を促すためにコンテキストからステップ アウトする必要はありません。カバーの下で、Outlook はメッセージを送受信する前に、Mentions プロパティを設定します。Outlook は、$filter$expandGET 操作も使用して、メッセージがユーザーをメンションしたかどうかとどのメッセージがユーザーをメンションしたかをサインインしているユーザーが簡単に検索できるようにして、迅速な応答のためにユーザーに実施項目またはディスカッションを警告します。

型:Microsoft.OutlookServices.Mention

プロパティType説明書き込み可能フィルター処理可能
ApplicationStringメンションが作成されるアプリケーションの名前。省略可能。Message の場合は使用されず、null として既定値に設定されます。はいいいえ
ClientReferenceStringリソース インスタンスの親を表す一意の識別子。省略可能。Message の場合は使用されず、null として既定値に設定されます。はいはい
CreatedByEmailAddressメンションしたユーザーの電子メール情報。必須です。はいいいえ
CreatedDateTimeDateTimeOffsetクライアントでメンションが作成された日時。いいえいいえ
DeepLinkStringリソース インスタンス内のメンションのコンテキストへの深い Web リンク。省略可能。Message の場合は使用されず、null として既定値に設定されます。はいいいえ
IdStringリソース インスタンス内のメンションの一意の識別子。いいえいいえ
MentionedEmailAddressメンションした人の電子メール情報。必須です。はいいいえ
MentionTextStringメンションの内容。省略可能。Message の場合は使用されず、null として既定値に設定されます。はいいいえ
ServerCreatedDateTimeDateTimeOffsetサーバーでメンションが作成された日時。省略可能。Message の場合は使用されず、null として既定値に設定されます。いいえなし

この機能は現在ベータ版のみで利用できます。詳細については、記事の右上隅にコントロールを使用して、[ベータ版] を選択します。

この機能は現在ベータ版のみで利用できます。詳細については、記事の右上隅にコントロールを使用して、[ベータ版] を選択します。

Message

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

型:Microsoft.OutlookServices.Message

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

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

プロパティType説明書き込み可能かどうかフィルター処理可能検索可能かどうか
AttachmentsCollection(Attachment)メッセージの FileAttachment 添付ファイルと ItemAttachment 添付ファイル。ナビゲーション プロパティです。はいいいえはい
BccRecipientsCollection (Recipient)メッセージの BCC 受信者。はいいいえはい
BodyItemBodyメッセージの本文。はいいいえ既定
BodyPreviewStringメッセージ本文の内容の最初の 255 文字。いいえいいえはい
CategoriesCollection (String)メッセージに関連付けられたカテゴリ。はいはいはい
CcRecipientsCollection (Recipient)メッセージの CC 受信者。はいいいえはい
ChangeKeyStringメッセージのバージョン。いいえいいえいいえ
ConversationIdString電子メールが属している会話の ID。いいえはいいいえ
ConversationIndexBinary電子メールが属している会話内の項目の相対位置を示します。いいえいいえいいえ
CreatedDateTimedatetimeoffsetメッセージが作成された日時です。いいえはいいいえ
ExtensionsCollection(Extension)メッセージに対して定義されているオープン型のデータ拡張機能のコレクション。ナビゲーション プロパティです。いいえはいいいえ
FlagFollowupFlagメッセージの任意のフォローアップに関する情報。はいはいはい
FromRecipientメッセージのメールボックス所有者と送信者。はいはいはい
HasAttachmentsbooleanメッセージに添付ファイルがあるかどうかを示します。いいえはいはい
IdStringメッセージの一意識別子。いいえいいえいいえ
ImportanceImportance次のようなメッセージの重要度があります。低 = 0、標準 = 1、高 = 2。はいはいはい
InferenceClassificationInferenceClassificationType推定される関連性や重要性、または明示的なオーバーライドに基づく、ユーザーの対象メッセージの分類。はいはいいいえ
InternetMessageIdStringRFC2822 によって指定された形式のメッセージ ID。いいえいいえなし
InternetMessageHeadersCollection(InternetMessageHeader)RFC2822 によって指定された形式のインターネット メッセージ ヘッダーのコレクション。いいえいいえいいえ
IsDeliveryReceiptRequestedbooleanメッセージの開封応答が要求されているかどうかを示します。はいはいいいえ
IsDraftbooleanメッセージが下書きかどうかを示します。メッセージがまだ送信されていなければ下書きです。いいえはいいいえ
IsReadbooleanメッセージが読み取られたかどうかを示します。はいはいいいえ
IsReadReceiptRequestedbooleanメッセージの開封応答が要求されているかどうかを示します。はいはいいいえ
LastModifiedDateTimedatetimeoffsetメッセージが最後に変更された日時です。いいえはいいいえ
MentionsCollection (Mention)メッセージのメンションのコレクション。CreatedDateTime で最新の日付順になっています。既定では、プロパティで $expand を適用しない限り、GET メッセージはこのプロパティを返しません。ナビゲーション プロパティです。はいいいえいいえ
MentionsPreviewMentionsPreviewメッセージのメンションに関する情報。GET /messages 要求を処理するときに、サーバーはこのプロパティを設定して、既定で応答に含めます。メッセージにメンションがない場合は、サーバーは null を返します。省略可能。なしいいえいいえ
MultiValueExtendedPropertiescollectionMultiValueLegacyExtendedProperty 型の複数値拡張プロパティのコレクション。これはナビゲーションのプロパティです。詳細については、「拡張プロパティ」を参照してください。はいはいいいえ
ParentFolderIdStringメッセージの親フォルダーの一意の識別子。いいえいいえいいえ
ReceivedDateTimedatetimeoffsetメッセージが受信された日時です。いいえはいはい
ReplyToCollection (Recipient)返信時に使用される電子メール アドレス。いいえいいえいいえ
SenderRecipientメッセージを生成するために実際に使用されるアカウント。はいはい既定
SentDateTimedatetimeoffsetメッセージが送信された日時です。いいえはいいいえ
SingleValueExtendedPropertiescollectionSingleValueLegacyExtendedProperty 型の単一値拡張プロパティのコレクション。これはナビゲーションのプロパティです。詳細については、「拡張プロパティ」を参照してください。はいはいいいえ
SubjectStringメッセージの件名を指定します。はいはい既定
ToRecipientsCollection (Recipient)メッセージの宛先はいいいえはい
UniqueBodyItemBody会話に特有のメッセージの本文。いいえいいえいいえ
UnsubscribeDataCollection (String)ヘッダーに基づいて解析された有効なエントリが含まれます。UnsubscribeEnabled プロパティが true の場合、List-Unsubscribe ヘッダーの mailto: コマンドのデータが含まれます。このデータは、RFC-2369 に準拠している必要があります。対応する配布リストにメッセージがそれ以上送信されないようにするには、購読取り消しアクションを使用します。List-Unsubscribeいいえいいえいいえ
UnsubscribeEnabledboolean対象メッセージで受信者が購読取り消しを行い、電子メール配布リストに基づいて今後メッセージが送信されないようにできるかどうかを示します。List-Unsubscribe ヘッダーが RFC-2369 に準拠している場合には、True です。いいえいいえいいえ
WebLinkStringOutlook Web App でメッセージを開く URL。

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

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

この URL には、iFrame 内からアクセスできます。
いいえはいいいえ
プロパティType説明書き込み可能フィルター処理可能検索可能かどうか
AttachmentsCollection(Attachment)メッセージの FileAttachment 添付ファイルと ItemAttachment 添付ファイル。ナビゲーション プロパティです。はいいいえはい
BccRecipientsCollection (Recipient)メッセージの BCC 受信者。はいいいえはい
BodyItemBodyメッセージの本文。はいいいえ既定
BodyPreviewStringメッセージ本文の内容の最初の 255 文字。いいえいいえはい
CategoriesCollection (String)メッセージに関連付けられたカテゴリ。はいはいはい
CcRecipientsCollection (Recipient)メッセージの CC 受信者。はいいいえはい
ChangeKeyStringメッセージのバージョン。いいえいいえいいえ
ConversationIdString電子メールが属している会話の ID。いいえはいいいえ
CreatedDateTimedatetimeoffsetメッセージが作成された日時です。いいえはいいいえ
ExtensionsCollection(Extension)メッセージに対して定義されているオープン型のデータ拡張機能のコレクション。ナビゲーション プロパティです。いいえはいいいえ
FromRecipientメッセージのメールボックス所有者と送信者。はいはいはい
HasAttachmentsbooleanメッセージに添付ファイルがあるかどうかを示します。いいえはいはい
IdStringメッセージの一意識別子。いいえいいえいいえ
ImportanceImportance次のようなメッセージの重要度があります。低 = 0、標準 = 1、高 = 2。はいはいはい
InferenceClassificationInferenceClassificationType推定される関連性や重要性、または明示的なオーバーライドに基づく、ユーザーの対象メッセージの分類。はいはいはい
IsDeliveryReceiptRequestedbooleanメッセージの開封応答が要求されているかどうかを示します。はいはいいいえ
IsDraftbooleanメッセージが下書きかどうかを示します。メッセージがまだ送信されていなければ下書きです。いいえはいいいえ
IsReadbooleanメッセージが読み取られたかどうかを示します。はいはいいいえ
IsReadReceiptRequestedbooleanメッセージの開封応答が要求されているかどうかを示します。はいはいいいえ
LastModifiedDateTimedatetimeoffsetメッセージが最後に変更された日時です。いいえはいいいえ
MultiValueExtendedPropertiescollectionMultiValueLegacyExtendedProperty 型の複数値拡張プロパティのコレクション。これはナビゲーションのプロパティです。詳細については、「拡張プロパティ」を参照してください。はいはいいいえ
ParentFolderIdStringメッセージの親フォルダーの一意の識別子。いいえいいえいいえ
ReceivedDateTimedatetimeoffsetメッセージが受信された日時です。いいえはいはい
ReplyToCollection (Recipient)返信時に使用される電子メール アドレス。いいえいいえいいえ
SenderRecipientメッセージを生成するために実際に使用されるアカウント。はいはい既定
SingleValueExtendedPropertiescollectionSingleValueLegacyExtendedProperty 型の単一値拡張プロパティのコレクション。これはナビゲーションのプロパティです。詳細については、「拡張プロパティ」を参照してください。はいはいいいえ
SentDateTimedatetimeoffsetメッセージが送信された日時です。いいえはいいいえ
SubjectStringメッセージの件名を指定します。はいはい既定
ToRecipientsCollection (Recipient)メッセージの宛先はいいいえはい
UniqueBodyItemBody会話に特有のメッセージの本文。いいえいいえいいえ
WebLinkStringOutlook Web App でメッセージを開く URL。

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

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

この URL には、iFrame 内からアクセスできます。
いいえはいいいえ
プロパティType説明書き込み可能フィルター処理可能検索可能かどうか
AttachmentsCollection(Attachment)メッセージの FileAttachment 添付ファイルと ItemAttachment 添付ファイル。ナビゲーション プロパティです。はいいいえはい
BccRecipientsCollection (Recipient)メッセージの BCC 受信者。はいいいえはい
BodyItemBodyメッセージの本文。はいいいえ既定
BodyPreviewStringメッセージ本文の内容の最初の 255 文字。いいえいいえはい
CategoriesCollection (String)メッセージに関連付けられたカテゴリ。はいはいはい
CcRecipientsCollection (Recipient)メッセージの CC 受信者。はいいいえはい
ChangeKeyStringメッセージのバージョン。いいえいいえいいえ
ConversationIdString電子メールが属している会話の ID。いいえはいいいえ
DateTimeCreateddatetimeoffsetメッセージが作成された日時です。いいえはいいいえ
DateTimeLastModifieddatetimeoffsetメッセージが最後に変更された日時です。いいえはいいいえ
DateTimeReceiveddatetimeoffsetメッセージが受信された日時です。いいえはいはい
DateTimeSentdatetimeoffsetメッセージが送信された日時です。いいえはいいいえ
FromRecipientメッセージのメールボックス所有者と送信者。はいはいはい
HasAttachmentsbooleanメッセージに添付ファイルがあるかどうかを示します。はいはいはい
IdStringメッセージの一意識別子。いいえいいえいいえ
ImportanceImportance次のようなメッセージの重要度があります。低 = 0、標準 = 1、高 = 2。はいはいはい
IsDeliveryReceiptRequestedbooleanメッセージの開封応答が要求されているかどうかを示します。はいはいいいえ
IsDraftbooleanメッセージが下書きかどうかを示します。メッセージがまだ送信されていなければ下書きです。いいえはいいいえ
IsReadbooleanメッセージが読み取られたかどうかを示します。はいはいいいえ
IsReadReceiptRequestedbooleanメッセージの開封応答が要求されているかどうかを示します。はいはいいいえ
ParentFolderIdStringメッセージの親フォルダーの一意の識別子。いいえいいえいいえ
ReplyToCollection (Recipient)返信時に使用される電子メール アドレス。はいいいえいいえ
SenderRecipientメッセージを生成するために実際に使用されるアカウント。はいはい既定
SubjectStringメッセージの件名を指定します。はいはい既定
ToRecipientsCollection (Recipient)メッセージの宛先はいいいえはい
UniqueBodyItemBody会話に特有のメッセージの本文。いいえいいえいいえ
WebLinkStringOutlook 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 (プレビュー)

ユーザーの受信トレイ内のメッセージに適用されるルールです。

型:Microsoft.OutlookServices.MessageRule

プロパティType説明書き込み可能
アクションMessageRuleActions該当する条件が満たされた場合にメッセージに対して実行されるアクションです。はい
条件MessageRulePredicates満たされた場合に、そのルールに該当するアクションをトリガーする条件です。はい
DisplayNameStringルールの表示名はい
例外MessageRulePredicatesルールの例外条件を表します。はい
HasErrorBooleanルールがエラー状態かどうかを示します。いいえ
IsEnabledBooleanルールのメッセージへの適用が有効になっているかどうかを示します。はい
IsReadOnlyBooleanルールが読み取り専用のため、ルールの REST API による変更や削除ができないことを示します。はい
SequenceInt32他のルールもある中で、そのルールが実行される順序を示します。はい

この機能は現在ベータ版として利用できます。詳細については、記事の右上隅にコントロールを使用して、[ベータ版] を選択します。

この機能は現在ベータ版として利用できます。詳細については、記事の右上隅にコントロールを使用して、[ベータ版] を選択します。

OutlookCategory (プレビュー)

型: Microsoft.OutlookServices.OutlookCategory

ユーザーがメールボックス内の Outlook アイテム (メッセージやイベントなど) をグループ化するために使用できるカテゴリ。

プロパティType説明書き込み可能フィルター処理可能
DisplayNameStringユーザーのメールボックス内での、このカテゴリの一意の名前。いいえはい
ColorCategoryColorこのカテゴリにマッピングされた色を表す、あらかじめ設定された定数。はいはい

この機能は現在ベータ版として利用できます。詳細については、記事の右上隅にコントロールを使用して、[ベータ版] を選択します。

この機能は現在ベータ版として利用できます。詳細については、記事の右上隅にコントロールを使用して、[ベータ版] を選択します。

Photo

型:Microsoft.OutlookServices.Photo

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

プロパティType説明書き込み可能フィルター処理可能
Heightint写真の高さいいえいいえ
IdString写真の一意識別子。いいえいいえ
Widthint写真の幅。いいえいいえ

型:Microsoft.OutlookServices.Photo

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

プロパティType説明書き込み可能フィルター処理可能
Heightint写真の高さいいえいいえ
IdString写真の一意識別子。いいえいいえ
Widthint写真の幅。いいえいいえ

この機能は現在 v2.0 とベータ版で利用できます。詳細については、記事の右上隅にコントロールを使用して、どちらかのバージョンを選択します。

ReferenceAttachment

型:Microsoft.OutlookServices.ReferenceAttachment

基本型: Microsoft.OutlookServices.Attachment

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

プロパティType説明書き込み可能フィルター処理可能
ContentTypeString添付ファイルの MIME タイプ。省略可能。はいいいえ
IdString参照添付ファイルの一意の識別子。いいえいいえ
IsFolderBoolean添付ファイルがフォルダーへのリンクであるかどうかを指定します。SourceUrl がフォルダーへのリンクの場合、true に設定する必要があります。省略可能。はいいいえ
IsInlineBooleantrue 添付ファイルがインライン添付ファイルの場合は true、それ以外の場合は false。省略可能。はいはい
LastModifiedDateTimeDateTimeOffset添付ファイルが最後に変更された日時です。日時は ISO 8601 形式を使って表され、常に UTC 時間です。たとえば、2014 年 1 月 1 日午前 0 時 (UTC) は、次のようになります。'2014-01-01T00:00:00Z'。省略可能。いいえはい
名前String添付ファイルの表示名。実際のファイル名である必要はありません。必須。はいはい
PermissionReferenceAttachmentPermissionsProviderType のプロバイダーの種類によって、添付ファイルに付与されるアクセス許可を指定します。可能な値は、OtherViewEditAnonymousViewAnonymousEditOrganizationViewOrganizationEdit です。省略可能。はいいいえ
PreviewUrlStringプレビュー イメージを取得するための、イメージの URL の参照添付ファイルのみに適用されます。SourceUrl によってイメージ ファイルが識別される場合にのみ、ThumbnailUrlPreviewUrl を使用します。省略可能。はいいいえ
ProviderTypeReferenceAttachmentProvidersこの ContentType の添付ファイルをサポートするプロバイダーの種類。可能な値は、OtherOneDriveBusinessOneDriveConsumerDropbox です。省略可能。はいはい
SizeInt32添付ファイルの長さ (バイト単位)。省略可能。いいえいいえ
SourceUrlString添付ファイルの内容を取得するための URL。フォルダーへの URL の場合、Outlook または Outlook on the web 上でフォルダーが正しく表示されるために、IsFolder を true に設定します。必須。はいいいえ
ThumbnailUrlStringサムネイル イメージを取得するための、イメージの URL の参照添付ファイルのみに適用されます。SourceUrl によってイメージ ファイルが識別される場合にのみ、ThumbnailUrlPreviewUrl を使用します。省略可能。はいいいえ

型:Microsoft.OutlookServices.ReferenceAttachment

基本型: Microsoft.OutlookServices.Attachment

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

プロパティType説明書き込み可能フィルター処理可能
ContentTypeString添付ファイルの MIME タイプ。省略可能。はいいいえ
IdString参照添付ファイルの一意の識別子。いいえいいえ
IsFolderBoolean添付ファイルがフォルダーへのリンクであるかどうかを指定します。SourceUrl がフォルダーへのリンクの場合、true に設定する必要があります。省略可能。はいいいえ
IsInlineBooleantrue 添付ファイルがインライン添付ファイルの場合は true、それ以外の場合は false。省略可能。はいはい
LastModifiedDateTimeDateTimeOffset添付ファイルが最後に変更された日時です。日時は ISO 8601 形式を使って表され、常に UTC 時間です。たとえば、2014 年 1 月 1 日午前 0 時 (UTC) は、次のようになります。'2014-01-01T00:00:00Z'。省略可能。いいえはい
名前String添付ファイルの表示名。実際のファイル名である必要はありません。必須。はいはい
PermissionReferenceAttachmentPermissionsProviderType のプロバイダーの種類によって、添付ファイルに付与されるアクセス許可を指定します。可能な値は、OtherViewEditAnonymousViewAnonymousEditOrganizationViewOrganizationEdit です。省略可能。はいいいえ
PreviewUrlStringプレビュー イメージを取得するための、イメージの URL の参照添付ファイルのみに適用されます。SourceUrl によってイメージ ファイルが識別される場合にのみ、ThumbnailUrlPreviewUrl を使用します。省略可能。はいいいえ
ProviderTypeReferenceAttachmentProvidersこの ContentType の添付ファイルをサポートするプロバイダーの種類。可能な値は、OtherOneDriveBusinessOneDriveConsumerDropbox です。省略可能。はいはい
SizeInt32添付ファイルの長さ (バイト単位)。省略可能。いいえいいえ
SourceUrlString添付ファイルの内容を取得するための URL。フォルダーへの URL の場合、Outlook または Outlook on the web 上でフォルダーが正しく表示されるために、IsFolder を true に設定します。必須。はいいいえ
ThumbnailUrlStringサムネイル イメージを取得するための、イメージの URL の参照添付ファイルのみに適用されます。SourceUrl によってイメージ ファイルが識別される場合にのみ、ThumbnailUrlPreviewUrl を使用します。省略可能。はいいいえ

この機能は現在ベータ版として利用できます。詳細については、記事の右上隅にコントロールを使用して、[ベータ版] を選択します。

Task

型:Microsoft.OutlookServices.Task

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

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

  • CompletedDateTime
  • CreatedDateTime
  • DueDateTime
  • LastModifiedDateTime
  • ReminderDateTime
  • StartDateTime

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

プロパティType説明書き込み可能フィルター処理可能
AssignedToStringタスクが割り当てられているユーザーの名前。いいえはい
AttachmentsCollection(Attachment)タスクの FileAttachmentItemAttachmentReferenceAttachment の各添付ファイルのコレクション。ナビゲーション プロパティです。いいえいいえ
BodyItemBody通常はタスクに関する情報を含むタスク本体。HTML 型のみがサポートされていることに注意してください。はいいいえ
CategoriesCollection(String)タスクに関連付けられたカテゴリ。はいはい
ChangeKeyStringタスクのバージョン。いいえいいえ
CompletedDateTimeDateTimeTimeZoneタスクが終了した日付 (指定のタイム ゾーン)。はいはい
CreatedDateTimeDateTimeOffsetタスクが作成された日時。既定では、UTC 時間です。要求ヘッダーでカスタム タイム ゾーンを使用できます。いいえはい
DueDateTimeDateTimeTimeZoneタスクが終了する予定の日時 (指定のタイム ゾーン)。はいはい
HasAttachmentsbooleanタスクに添付ファイルが含まれている場合、true に設定します。いいえはい
IdStringタスクの一意識別子。いいえいいえ
ImportanceImportanceイベントの重要度: LowNormalHighはいはい
IsReminderOnbooleanユーザーにタスクを通知するアラートを設定する場合は、true に設定します。はいいいえ
LastModifiedDateTimeDateTimeOffsetタスクが最後に変更された日時。既定では、UTC 時間です。要求ヘッダーでカスタム タイム ゾーンを使用できます。いいえはい
OwnerStringタスクを作成したユーザーの名前。いいえはい
ParentFolderIdStringタスクの親フォルダーの一意の識別子。いいえいいえ
RecurrencePatternedRecurrenceタスクの繰り返しパターン。はいいいえ
ReminderDateTimeDateTimeTimeZoneタスクのアラーム通知を行う日時。はいいいえ
SensitivitySensitivityイベントのプライバシーのレベルを示します: NormalPersonalPrivateConfidentialはいはい
StartDateTimeDateTimeTimeZoneタスクを開始する日付 (指定のタイム ゾーン)。はいはい
StatusTaskStatusタスクの状態または進行状況を示します: NotStartedInProgressCompletedWaitingOnOthersDeferredはいはい
SubjectStringタスクのタイトルまたは簡単な説明。はいはい

型:Microsoft.OutlookServices.Task

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

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

  • CompletedDateTime
  • CreatedDateTime
  • DueDateTime
  • LastModifiedDateTime
  • ReminderDateTime
  • StartDateTime

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

プロパティType説明書き込み可能フィルター処理可能
AssignedToStringタスクが割り当てられているユーザーの名前。いいえはい
AttachmentsCollection(Attachment)タスクの FileAttachment 添付ファイルと ItemAttachment 添付ファイルのコレクションです。ナビゲーション プロパティです。いいえいいえ
BodyItemBody通常はタスクに関する情報を含むタスク本体。HTML 型のみがサポートされていることに注意してください。はいいいえ
CategoriesCollection(String)タスクに関連付けられたカテゴリ。はいはい
ChangeKeyStringタスクのバージョン。いいえいいえ
CompletedDateTimeDateTimeTimeZoneタスクが終了した日付 (指定のタイム ゾーン)。はいはい
CreatedDateTimeDateTimeOffsetタスクが作成された日時。既定では、UTC 時間です。要求ヘッダーでカスタム タイム ゾーンを使用できます。いいえはい
DueDateTimeDateTimeTimeZoneタスクが終了する予定の日時 (指定のタイム ゾーン)。はいはい
HasAttachmentsbooleanタスクに添付ファイルが含まれている場合、true に設定します。いいえはい
IdStringタスクの一意識別子。いいえいいえ
ImportanceImportanceイベントの重要度: LowNormalHighはいはい
IsReminderOnbooleanユーザーにタスクを通知するアラートを設定する場合は、true に設定します。はいいいえ
LastModifiedDateTimeDateTimeOffsetタスクが最後に変更された日時。既定では、UTC 時間です。要求ヘッダーでカスタム タイム ゾーンを使用できます。いいえはい
OwnerStringタスクを作成したユーザーの名前。いいえはい
ParentFolderIdStringタスクの親フォルダーの一意の識別子。いいえいいえ
RecurrencePatternedRecurrenceタスクの繰り返しパターン。はいいいえ
ReminderDateTimeDateTimeTimeZoneタスクのアラーム通知を行う日時。はいいいえ
SensitivitySensitivityイベントのプライバシーのレベルを示します: NormalPersonalPrivateConfidentialはいはい
StartDateTimeDateTimeTimeZoneタスクを開始する日付 (指定のタイム ゾーン)。はいはい
StatusTaskStatusタスクの状態または進行状況を示します: NotStartedInProgressCompletedWaitingOnOthersDeferredはいはい
SubjectStringタスクのタイトルまたは簡単な説明。はいはい

この機能は現在ベータ版および v2.0 で利用できます。詳細については、記事の右上隅にコントロールを使用して、どちらかのバージョンを選択します。

TaskFolder

型:Microsoft.OutlookServices.TaskFolder

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

プロパティType説明書き込み可能フィルター処理可能
ChangeKeyStringタスク フォルダーのバージョン。いいえいいえ
IdStringタスク フォルダーの一意識別子。いいえいいえ
IsDefaultFolderBooleanフォルダーが既定のタスク フォルダーである場合は true。いいえはい
名前Stringタスク フォルダーの名前。はいはい
ParentGroupKeyEdm.Guidタスク フォルダーの親グループの一意の GUID 識別子。いいえいいえ
TasksCollection(Task)対象タスク フォルダー内のタスク。ナビゲーション プロパティです。いいえいいえ

型:Microsoft.OutlookServices.TaskFolder

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

プロパティType説明書き込み可能フィルター処理可能
ChangeKeyStringタスク フォルダーのバージョン。いいえいいえ
IdStringタスク フォルダーの一意識別子。いいえいいえ
IsDefaultFolderBooleanフォルダーが既定のタスク フォルダーである場合は true。いいえはい
名前Stringタスク フォルダーの名前。はいはい
ParentGroupKeyEdm.Guidタスク フォルダーの親グループの一意の GUID 識別子。いいえいいえ
TasksCollection(Task)対象タスク フォルダー内のタスク。ナビゲーション プロパティです。いいえいいえ

この機能は現在ベータ版および v2.0 で利用できます。詳細については、記事の右上隅にコントロールを使用して、どちらかのバージョンを選択します。

TaskGroup

型:Microsoft.OutlookServices.TaskGroup

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

プロパティType説明書き込み可能フィルター処理可能
ChangeKeyStringタスク グループのバージョン。いいえいいえ
GroupKeyEdm.Guidタスク グループの一意の GUID 識別子。いいえいいえ
IdStringタスク グループの一意の識別子。いいえいいえ
IsDefaultGroupBooleanタスク グループが既定のタスク グループの場合は true。いいえはい
名前Stringタスク グループの名前。はいはい
TaskFoldersCollection(TaskFolder)対象タスク グループ内のタスク フォルダー。ナビゲーション プロパティです。いいえいいえ

型:Microsoft.OutlookServices.TaskGroup

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

プロパティType説明書き込み可能フィルター処理可能
ChangeKeyStringタスク グループのバージョン。いいえいいえ
GroupKeyEdm.Guidタスク グループの一意の GUID 識別子。いいえいいえ
IdStringタスク グループの一意の識別子。いいえいいえ
IsDefaultGroupBooleanタスク グループが既定のタスク グループの場合は true。いいえはい
名前Stringタスク グループの名前。はいはい
TaskFoldersCollection(TaskFolder)対象タスク グループ内のタスク フォルダー。ナビゲーション プロパティです。いいえいいえ

この機能は現在ベータ版および v2.0 で利用できます。詳細については、記事の右上隅にコントロールを使用して、どちらかのバージョンを選択します。

User

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

型:Microsoft.OutlookServices.User

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

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

プロパティType説明書き込み可能フィルター処理可能
AliasStringユーザーのエイリアス。通常は、ユーザーの SMTP アドレスです。はいはい
CalendarCalendarユーザーの標準予定表。ナビゲーション プロパティです。いいえいいえ
CalendarGroupsCollection(CalendarGroup)ユーザーの予定表グループ。ナビゲーション プロパティです。いいえいいえ
CalendarsCollection(Calendar)ユーザーの予定表。ナビゲーション プロパティです。いいえいいえ
CalendarViewCollection(Event)予定表のカレンダー ビュー。ナビゲーション プロパティです。いいえいいえ
ContactFoldersCollection(ContactFolder)ユーザーの連絡先フォルダー。ナビゲーション プロパティです。いいえいいえ
ContactsCollection(Contact)ユーザーの連絡先。ナビゲーション プロパティです。いいえいいえ
DisplayNameStringユーザーの表示名。はいはい
EventsCollection(Event)ユーザーのイベント。既定は、既定の予定表の下にイベントを表示することです。ナビゲーション プロパティです。いいえいいえ
IdStringユーザーの一意の識別子。いいえいいえ
InferenceClassificationInferenceClassification明示的な指定に基づく、ユーザーのメッセージの関連性の分類。明示的な指定は、推定される関連性や重要性より優先されます。ナビゲーション プロパティです。はいはい
MailboxGuidguidユーザーのメールボックスに割り当てられた GUID です。いいえはい
MailboxSettingsMailboxSettingsサインイン ユーザーのプライマリ メールボックスの設定。はいいいえ
MailFoldersCollection(MailFolder)メールボックス内のフォルダー。ナビゲーション プロパティです。いいえいいえ
MasterCategoriesCollection(OutlookCategory)ユーザーのマスター カテゴリ リスト。 ナビゲーション プロパティ。はいはい
MessagesCollection(Message)メールボックスまたはフォルダー内のメッセージ。ナビゲーション プロパティです。いいえいいえ
RootFolderMailFolderユーザーのメールボックスのルート フォルダー。ナビゲーション プロパティです。いいえいいえ
プロパティType説明書き込み可能フィルター処理可能
AliasStringユーザーのエイリアス。通常は、ユーザーの SMTP アドレスです。はいはい
CalendarCalendarユーザーの標準予定表。ナビゲーション プロパティです。いいえいいえ
CalendarGroupsCollection(CalendarGroup)ユーザーの予定表グループ。ナビゲーション プロパティです。いいえいいえ
CalendarsCollection(Calendar)ユーザーの予定表。ナビゲーション プロパティです。いいえいいえ
CalendarViewCollection(Event)予定表のカレンダー ビュー。ナビゲーション プロパティです。いいえいいえ
ContactFoldersCollection(ContactFolder)ユーザーの連絡先フォルダー。ナビゲーション プロパティです。いいえいいえ
ContactsCollection(Contact)ユーザーの連絡先。ナビゲーション プロパティです。いいえいいえ
DisplayNameStringユーザーの表示名。はいはい
EventsCollection(Event)ユーザーのイベント。既定は、既定の予定表の下にイベントを表示することです。ナビゲーション プロパティです。いいえいいえ
IdStringユーザーの一意の識別子。いいえいいえ
InferenceClassificationInferenceClassification明示的な指定に基づく、ユーザーのメッセージの関連性の分類。明示的な指定は、推定される関連性や重要性より優先されます。ナビゲーション プロパティです。はいはい
MailboxGuidguidユーザーのメールボックスに割り当てられた GUID です。いいえはい
MailboxSettingsMailboxSettingsサインイン ユーザーのプライマリ メールボックスの設定。はいいいえ
MailFoldersCollection(MailFolder)メールボックス内のフォルダー。ナビゲーション プロパティです。いいえいいえ
MessagesCollection(Message)メールボックスまたはフォルダー内のメッセージ。ナビゲーション プロパティです。いいえいいえ
RootFolderMailFolderユーザーのメールボックスのルート フォルダー。ナビゲーション プロパティです。いいえいいえ
プロパティType説明書き込み可能フィルター処理可能
AliasStringユーザーのエイリアス。通常は、ユーザーの SMTP アドレスです。はいはい
CalendarCalendarユーザーの標準予定表。ナビゲーション プロパティです。いいえいいえ
CalendarGroupsCollection(CalendarGroup)ユーザーの予定表グループ。ナビゲーション プロパティです。いいえいいえ
CalendarsCollection(Calendar)ユーザーの予定表。ナビゲーション プロパティです。いいえいいえ
CalendarViewCollection(Event)予定表のカレンダー ビュー。ナビゲーション プロパティです。いいえいいえ
ContactFoldersCollection(ContactFolder)ユーザーの連絡先フォルダー。ナビゲーション プロパティです。いいえいいえ
ContactsCollection(Contact)ユーザーの連絡先。ナビゲーション プロパティです。いいえいいえ
DisplayNameStringユーザーの表示名。はいはい
EventsCollection(Event)ユーザーのイベント。既定は、既定の予定表の下にイベントを表示することです。ナビゲーション プロパティです。いいえいいえ
FoldersCollection(Folder)メールボックスまたはフォルダー内のフォルダー。ナビゲーション プロパティです。いいえいいえ
IdStringユーザーの一意の識別子。いいえいいえ
MailboxGuidguidユーザーのメールボックスに割り当てられた GUID です。いいえはい
MessagesCollection(Message)メールボックスまたはフォルダー内のメッセージ。ナビゲーション プロパティです。いいえいいえ
RootFolderFolderユーザーのメールボックスのルート フォルダー。ナビゲーション プロパティです。いいえいいえ

複合型

Attendee | AttendeeAvailability | AttendeeBase | AutomaticRepliesMailTips (プレビュー) | AutomaticRepliesSetting | DateTimeTimeZone | EmailAddress | Error (プレビュー) | FollowUpFlag (プレビュー) | GeoCoordinates | InternetMessageHeader (プレビュー) | ItemBody | LocaleInfo | Location | LocationConstraint | LocationConstraintItem | MailboxSettings | MailTips (プレビュー) | MeetingTimeSuggestion | MeetingTimeSuggestionsResult | MentionsPreview (プレビュー) | MessageRuleActions (プレビュー) | MessageRulePredicates (プレビュー) | PatternedRecurrence | Phone (プレビュー) | PhysicalAddress | Recipient | RecurrencePattern | RecurrenceRange | ResponseStatus | SizeRange (プレビュー) | TimeConstraint | TimeSlot | TimeZoneInformation (プレビュー) | Website (プレビュー) | WorkingHours (プレビュー) |

Attendee

イベントの参加者です。

型:Microsoft.OutlookServices.AttendeeBase

プロパティType説明
StatusResponseStatus応答 (なし、承諾、辞退など) と時刻。

AttendeeAvailability

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

型:Microsoft.OutlookServices.AttendeeAvailability

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

AttendeeBase

出席者の種類です。

型:Microsoft.OutlookServices.Recipient

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

AutomaticRepliesMailTips (プレビュー)

メールボックスでセットアップされる自動応答に関するメール ヒント。

型:Microsoft.OutlookServices.AutomaticRepliesMailTips

プロパティType説明
MessageString自動応答メッセージ。
MessageLanguageLocaleInfo自動応答メッセージの言語。
ScheduledStartTimeDateTimeTimeZone自動応答を開始する日時。
ScheduledEndTimeDateTimeTimeZone自動応答を終了する日時。

AutomaticRepliesSetting

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

型:Microsoft.OutlookServices.AutomaticRepliesSetting

プロパティType説明
ExternalAudienceExternalAudienceScopeStatusAlwaysEnabled または Scheduled の場合に、ExternalReplyMessage を受信する、サインイン ユーザーの組織外の一連の対象ユーザー。値は、None = 0、ContactsOnly = 1、または All = 2 です。
ExternalReplyMessageStringStatusAlwaysEnabled または Scheduled の場合、指定の外部対象ユーザーに送信される自動応答。
InternalReplyMessageStringStatusAlwaysEnabled または Scheduled の場合、サインイン ユーザーの組織内の対象ユーザーに送信される自動応答。
ScheduledEndDateTimeDateTimeTimeZoneStatusScheduled に設定されている場合に、自動応答を終了する日時。Prefer: outlook.timezone HTTP ヘッダーで Get 操作を使用して、タイム ゾーンを設定できます。
ScheduledStartDateTimeDateTimeTimeZoneStatusScheduled に設定されている場合に、自動応答を開始する日時。Prefer: outlook.timezone HTTP ヘッダーで Get 操作を使用して、タイム ゾーンを設定できます。
StatusAutomaticRepliesStatus自動応答の構成状態。Disabled = 0、AlwaysEnabled = 1、Scheduled = 2 です。

Attendee | AttendeeAvailability | AttendeeBase | AutomaticRepliesSetting | DateTimeTimeZone| EmailAddress | GeoCoordinates | ItemBody | LocaleInfo | Location | LocationConstraint | LocationConstraintItem | MailboxSettings | MeetingTimeSuggestion | MeetingTimeSuggestionsResult | PatternedRecurrence | PhysicalAddress | Recipient | RecurrencePattern | RecurrenceRange | ResponseStatus | TimeConstraint | TimeSlot |

Attendee

イベントの参加者です。

型:Microsoft.OutlookServices.Recipient

プロパティType説明
StatusResponseStatus応答 (なし、承諾、辞退など) と時刻。
TypeAttendeeType出席者の種類です。使用可能な値: RequiredOptionalResource

AttendeeAvailability

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

型:Microsoft.OutlookServices.AttendeeAvailability

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

AttendeeBase

出席者の種類です。

型:Microsoft.OutlookServices.Recipient

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

AutomaticRepliesSetting

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

型:Microsoft.OutlookServices.AutomaticRepliesSetting

プロパティType説明
ExternalAudienceExternalAudienceScopeStatusAlwaysEnabled または Scheduled の場合に、ExternalReplyMessage を受信する、サインイン ユーザーの組織外の一連の対象ユーザー。値は、None = 0、ContactsOnly = 1、または All = 2 です。
ExternalReplyMessageStringStatusAlwaysEnabled または Scheduled の場合、指定の外部対象ユーザーに送信される自動応答。
InternalReplyMessageStringStatusAlwaysEnabled または Scheduled の場合、サインイン ユーザーの組織内の対象ユーザーに送信される自動応答。
ScheduledEndDateTimeDateTimeTimeZoneStatusScheduled に設定されている場合に、自動応答を終了する日時。Prefer: outlook.timezone HTTP ヘッダーで Get 操作を使用して、タイム ゾーンを設定できます。
ScheduledStartDateTimeDateTimeTimeZoneStatusScheduled に設定されている場合に、自動応答を開始する日時。Prefer: outlook.timezone HTTP ヘッダーで Get 操作を使用して、タイム ゾーンを設定できます。
StatusAutomaticRepliesStatus自動応答の構成状態。Disabled = 0、AlwaysEnabled = 1、Scheduled = 2 です。

Attendee | EmailAddress | GeoCoordinates | ItemBody | Location | PatternedRecurrence | PhysicalAddress | Recipient | RecurrencePattern | RecurrenceRange | ResponseStatus

Attendee

イベントの参加者です。

型:Microsoft.OutlookServices.Recipient

プロパティType説明
StatusResponseStatus応答 (なし、承諾、辞退など) と時刻。
TypeAttendeeType出席者の種類です: RequiredOptionalResource

DateTimeTimeZone

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

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

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

Etc/GMT+12

Etc/GMT+11

太平洋/ホノルル

アメリカ/アンカレッジ

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

アメリカ/ロサンゼルス

アメリカ/フェニックス

アメリカ/チワワ

アメリカ/デンバー

アメリカ/グアテマラ

アメリカ/シカゴ

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

アメリカ/リジャイナ

アメリカ/ボゴタ

アメリカ/ニューヨーク

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

アメリカ/カラカス

アメリカ/アスンシオン

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

アメリカ/クイアバ

アメリカ/ラパス

アメリカ/サンティアゴ

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

アメリカ/サンパウロ

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

アメリカ/カイエンヌ

アメリカ/ゴットホープ

アメリカ/モンテビデオ

アメリカ/バイア

Etc/GMT+2

大西洋/アゾレス諸島

大西洋/カーボベルデ

アフリカ/カサブランカ

Etc/GMT

ヨーロッパ/ロンドン

大西洋/レイキャビク

ヨーロッパ/ベルリン

ヨーロッパ/ブダペスト

ヨーロッパ/パリ

ヨーロッパ/ワルシャワ

アフリカ/ラゴス

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

ヨーロッパ/ブカレスト

アジア/ベイルート

アフリカ/カイロ

アジア/ダマスカス

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

ヨーロッパ/キエフ

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

アジア/エルサレム

アジア/アンマン

アジア/バグダッド

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

アジア/リャド

アフリカ/ナイロビ

アジア/テヘラン

アジア/ドバイ

アジア/バクー

ヨーロッパ/モスクワ

インド/モーリシャス

アジア/トビリシ

アジア/エレバン

アジア/カブール

アジア/カラチ

アジア/タシケント

アジア/コルカタ

アジア/コロンボ

アジア/カトマンズ

アジア/アルマトイ

アジア/ダッカ

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

アジア/ヤンゴン

アジア/バンコク

アジア/ノボシビルスク

アジア/上海

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

アジア/シンガポール

オーストラリア/パース

アジア/台北

アジア/ウランバートル

アジア/イルクーツク

アジア/東京

アジア/ソウル

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

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

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

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

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

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

アジア/ヤクーツク

太平洋/ガダルカナル島

アジア/ウラジオストク

太平洋/オークランド

Etc/GMT-12

太平洋/フィジー

アジア/マガダン

太平洋/トンガタプ

太平洋/アピア

太平洋/クリスマス島

DateTimeTimeZone

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

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

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

Etc/GMT+12

Etc/GMT+11

太平洋/ホノルル

アメリカ/アンカレッジ

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

アメリカ/ロサンゼルス

アメリカ/フェニックス

アメリカ/チワワ

アメリカ/デンバー

アメリカ/グアテマラ

アメリカ/シカゴ

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

アメリカ/リジャイナ

アメリカ/ボゴタ

アメリカ/ニューヨーク

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

アメリカ/カラカス

アメリカ/アスンシオン

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

アメリカ/クイアバ

アメリカ/ラパス

アメリカ/サンティアゴ

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

アメリカ/サンパウロ

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

アメリカ/カイエンヌ

アメリカ/ゴットホープ

アメリカ/モンテビデオ

アメリカ/バイア

Etc/GMT+2

大西洋/アゾレス諸島

大西洋/カーボベルデ

アフリカ/カサブランカ

Etc/GMT

ヨーロッパ/ロンドン

大西洋/レイキャビク

ヨーロッパ/ベルリン

ヨーロッパ/ブダペスト

ヨーロッパ/パリ

ヨーロッパ/ワルシャワ

アフリカ/ラゴス

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

ヨーロッパ/ブカレスト

アジア/ベイルート

アフリカ/カイロ

アジア/ダマスカス

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

ヨーロッパ/キエフ

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

アジア/エルサレム

アジア/アンマン

アジア/バグダッド

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

アジア/リャド

アフリカ/ナイロビ

アジア/テヘラン

アジア/ドバイ

アジア/バクー

ヨーロッパ/モスクワ

インド/モーリシャス

アジア/トビリシ

アジア/エレバン

アジア/カブール

アジア/カラチ

アジア/タシケント

アジア/コルカタ

アジア/コロンボ

アジア/カトマンズ

アジア/アルマトイ

アジア/ダッカ

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

アジア/ヤンゴン

アジア/バンコク

アジア/ノボシビルスク

アジア/上海

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

アジア/シンガポール

オーストラリア/パース

アジア/台北

アジア/ウランバートル

アジア/イルクーツク

アジア/東京

アジア/ソウル

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

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

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

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

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

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

アジア/ヤクーツク

太平洋/ガダルカナル島

アジア/ウラジオストク

太平洋/オークランド

Etc/GMT-12

太平洋/フィジー

アジア/マガダン

太平洋/トンガタプ

太平洋/アピア

太平洋/クリスマス島

EmailAddress

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

型:Microsoft.OutlookServices.EmailAddress

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

Error (プレビュー)

操作中に発生するエラーです。

型:Microsoft.OutlookServices.Error

プロパティType説明
MessageStringエラー メッセージ。
CodeStringエラー コード。

FollowUpFlag (プレビュー)

リソース インスタンスに関するフォローアップ情報です。

型:Microsoft.OutlookServices.FollowupFlag

プロパティType説明
CompletedDateTimeDateTimeTimeZoneフォローアップが終了した日時。
DueDateTimeDateTimeTimeZoneフォローアップが終了する予定の日時。
StartDateTimeDateTimeTimeZoneフォローアップを開始する日時。
FlagStatusFollowupFlagStatus親リソース インスタンスにフォローアップのフラグを設定するか、またはフォローアップが終了したかどうかを表します。

GeoCoordinates

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

型:Microsoft.OutlookServices.GeoCoordinates

プロパティType説明
Altitudedouble場所の標高です。
Latitudedouble場所の緯度です。
Longitudedouble場所の経度です。
Accuracydouble緯度と経度を提供するセンサーの精度です。
AltitudeAccuracydouble標高を提供するセンサーの精度。

InternetMessageHeader (プレビュー)

RFC2822 によって指定された形式のインターネット メッセージ ヘッダーを表すキーと値のペア。メッセージが送信者から受信者に到達するまでに辿ったネットワーク パスの詳細を提供します。

型: Microsoft.OutlookServices.InternetMessageHeader

プロパティType説明
名前Stringインターネット メッセージ ヘッダーを表すキーと値のペアのキーの部分。
ValueStringインターネット メッセージ ヘッダーを表すキーと値のペアの値の部分。

ItemBody

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

型:Microsoft.OutlookServices.ItemBody

プロパティType説明
ContentTypeBodyType次のようなコンテンツ タイプがあります。テキスト = 0、HTML = 1。
コンテンツStringテキストまたは HTML コンテンツ。

LocaleInfo

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

型:Microsoft.OutlookServices.LocaleInfo

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

Location (プレビュー)

イベントの場所です。

型:Microsoft.OutlookServices.Location

プロパティType説明
AddressPhysicalAddress場所の物理アドレス。
CoordinatesGeoCoordinates場所の地理的座標と標高です。
DisplayNameString場所に関連付けられた名前。
LocationEmailAddressString場所の電子メール アドレス (省略可能)。
LocationUriString場所を表す URI (省略可能)。
LocationTypeLocationType場所の種類: DefaultConferenceRoomHomeAddressBusinessAddressGeoCoordinatesStreetAddressHotelRestaurantLocalBusinessPostalAddress

LocationConstraint

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

型:Microsoft.OutlookServices.LocationConstraint

プロパティType説明
IsRequiredbooleanクライアントは、応答に会議の場所を含めるようにサービスに要求します。
SuggestLocationbooleanクライアントは、1 つ以上の会議場所を提案するようサービスに要求します。
LocationsCollection(LocationConstraintItem)クライアントが会議のために要求する 1 つ以上の場所。

LocationConstraintItem

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

型:Microsoft.OutlookServices.Location

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

MailTips (プレビュー)

メッセージを作成中のユーザーに対して表示される情報メッセージ。たとえば、メッセージの受信者に対する自動応答としての不在メッセージなど。

型:Microsoft.OutlookServices.MailTips

プロパティType説明
EmailAddressEmailAddressメールヒントを取得する受信者の電子メール アドレス。
AutomaticRepliesAutomaticRepliesMailTips受信者によって設定されている場合の自動応答に関するメールのヒント。
MailboxFullBoolean受信者のメールボックスのフル状態。
CustomMailTipString受信者のメールボックスに設定可能なカスタム メールのヒント。
ExternalMemberCountInt32受信者が配布リストの場合は外部メンバーの数です。
TotalMemberCountInt32受信者が配布リストの場合はメンバー数です。
DeliveryRestrictedBoolean受信者のメールボックスが制限されているかどうか。たとえば、送信者の定義済みリストからのメッセージのみを受け付ける、送信者の定義済みリストからのメッセージを拒否する、または認証された送信者からのメッセージのみを受信するなどです。
IsModeratedBoolean受信者へのメッセージ送信に承認が必要かどうか。たとえば、受信者が大規模な配布リストであり、モデレーターが配布リストに送信されたメッセージを承認するようにセットアップされている場合、または受信者へのメッセージの送信に受信者の上司の承認を必要とする場合などです。
RecipientScopeRecipientScopeType内部、外部、パートナーなど、受信者の範囲。たとえば、管理者は別の組織をその "パートナー" になるように設定できます。スコープは、管理者が特定のメールヒントが特定のスコープにアクセスできるようにする場合に、便利です。組織から外部に送信される可能性があることを送信者に通知し、送信者がメッセージの表現の仕方、文章の調子、内容が適切であるかどうかを判断するのにも役立ちします。
RecipientSuggestionsCollection(Recipient)同じメッセージに表示される前のコンテキストに基づいて提案される受信者。
MaxMessageSizeInt32受信者の組織またはメールボックスに対して構成されているメッセージの最大サイズ。
ErrorErrorGetMailTips アクション中に発生するエラー。

MailboxSettings

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

型:Microsoft.OutlookServices.MailboxSettings

プロパティType説明
AutomaticRepliesSettingAutomaticRepliesSetting着信メッセージに対する返信を自動的に送信する構成の設定。
TimeZoneStringユーザーのメールボックスの既定のタイム ゾーン。
LanguageLocaleInfo優先言語および国/地域を含むユーザーのロケール情報。
WorkingHoursWorkingHoursユーザーが働く曜日と、特定のタイムゾーンの時間。

MeetingTimeSuggestion

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

型:Microsoft.OutlookServices.MeetingTimeSuggestion

プロパティType説明
MeetingTimeSlotTimeSlot会議の提案されている期間。
Confidencedoubleすべての出席者が出席する見込みを表すパーセンテージ。
OrganizerAvailabilityFreeBusyStatusこの提案されている会議の開催者の空き時間情報: FreeTentativeBusyOofWorkingElsewhereUnknown
AttendeeAvailabilityCollection(AttendeeAvailability)この提案された会議の各出席者の空き時間情報の状態を示す配列。
LocationsCollection(Location)この提案された会議の各会議場所の名前と地理的な場所を指定する配列。
SuggestionReasonString会議時間を提案する理由について記述します。

会議の確実性

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

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

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

出席者空き時間状態出席見込み (%)
DanaFree100%
JohnUnknown49%
Fanny多忙0%

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

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

MeetingTimeSuggestionsResult

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

型:Microsoft.OutlookServices.MeetingTimeSuggestionsResult

プロパティType説明
MeetingTimeSuggestionsCollection(MeetingTimeSuggestion)会議提案の配列。
EmptySuggestionsReasonString会議提案が 1 つも返されない理由。可能な値: AttendeesUnavailableLocationsUnavailableOrganizerUnavailableAttendeesUnavailableOrUnknown、または Unknown

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

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

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

MentionsPreview (プレビュー)

リソース インスタンスのメンションに関する情報を表します。

型:Microsoft.OutlookServices.MentionsPreview

プロパティType説明
IsMentionedBooleanログインしているユーザーが親リソース インスタンスでメンションされている場合は true です。読み取り専用。フィルターがサポートされています。

MessageRuleActions (プレビュー)

ルールに使用可能なアクションのセットを表します。

型:Microsoft.OutlookServices.MessageRuleActions

プロパティType説明
AssignCategoriesCollection (String)メッセージに割り当てられるカテゴリの一覧です。
CopyToFolderStringメッセージのコピー先のフォルダーの ID です。
DeleteBoolean削除済みアイテム フォルダーにメッセージを移動する必要があるかどうかを示します。
ForwardAsAttachmentToCollection (Recipient)添付ファイルとしてメッセージを転送する受信者の電子メール アドレスです。
ForwardToCollection (Recipient)メッセージを転送する受信者の電子メール アドレスです。
MarkAsReadBooleanメッセージを開封済みにする必要があるかどうかを示します。
MarkImportanceImportanceメッセージの重要度: LowNormalHigh を設定します。
MoveToFolderStringメッセージ移動先のフォルダーの ID です。
PermanentDeleteBooleanメッセージを完全に削除し、削除済みアイテム フォルダーにメッセージを保存しないようにするかどうかを示します。
RedirectToRecipientメッセージのリダイレクト先の電子メール アドレスです。
StopProcessingRulesBoolean後続のルールを評価する必要があるかどうかを示します。

MessageRulePredicates (プレビュー)

ルールで使用可能な条件および例外のセットを表します。

型:Microsoft.OutlookServices.MessageRulePredicates

プロパティType説明
BodyContainsCollection (String)条件または例外を適用するために、受信メッセージの本文に表示される文字列を表します。
BodyOrSubjectContainsCollection (String)条件または例外を適用するために、受信メッセージの本文または件名に表示される文字列を表します。
CategoriesCollection (String)条件または例外を適用するために、受信メッセージにラベルを付けるカテゴリを表します。
FromAddressesCollection (Recipient)条件または例外を適用するために、受信メッセージの特定の送信者のメール アドレスを表します。
HasAttachmentsBoolean条件または例外を適用するために、受信メッセージに添付ファイルがあるかどうかを示します。
HeaderContainsCollection (String)条件または例外を適用するために、受信メッセージのヘッダーに表示される文字列を表します。
ImportanceImportance条件または例外を適用するために、受信メッセージに記録される重要性: LowNormalHigh
IsApprovalRequestBoolean条件または例外を適用するために、受信メッセージが承認要求であるかどうかを示します。
IsAutomaticForwardBoolean条件または例外を適用するために、受信メッセージが自動的に転送されるかどうかを示します。
IsAutomaticReplyBoolean条件または例外を適用するために、受信メッセージが自動返信であるかどうかを示します。
IsEncryptedBoolean条件または例外を適用するために、受信メッセージが暗号化されるかどうかを示します。
IsMeetingRequestBoolean条件または例外を適用するために、受信メッセージが会議出席依頼であるかどうかを示します。
IsMeetingResponseBoolean条件または例外を適用するために、受信メッセージが会議出席依頼の返信であるかどうかを示します。
IsNonDeliveryReportBoolean条件または例外を適用するために、受信メッセージが配信不能レポートであるかどうかを示します。
IsPermissionControlledBoolean条件または例外を適用するために、受信メッセージがアクセス許可制御 (RMS 保護) されるかどうかを示します。
IsReadReceiptBoolean条件または例外を適用するために、受信メッセージが開封確認メッセージであるかどうかを示します。
IsSignedBoolean条件または例外を適用するために、受信メッセージが S/MIME 署名されているかどうかを示します。
IsVoicemailBoolean条件または例外を適用するために、受信メッセージがボイス メールかどうかを示します。
MessageActionFlagMessageActionFlag条件または例外を適用するために、受信メッセージに表示されるアクション フラグの値を表します。
NotSentToMeBoolean条件または例外を適用するために、メールボックスの所有者が受信メッセージの受信者でないことを示します。
ReceipentContainsCollection (String)条件または例外を適用するために、受信メッセージの ToRecipients または CcRecipients プロパティに表示される文字列を表します。
SenderContainsCollection (String)条件または例外を適用するために、受信メッセージの From プロパティに表示される文字列を表します。
SensitivitySensitivity条件または例外を適用するために、受信メッセージに記録される秘密度レベルを表します。使用可能な値: NormalPersonalPrivateConfidential
SentCcMeBoolean条件または例外を適用するために、メールボックスの所有者が受信メッセージの CcRecipients プロパティにあるかどうかを示します。
SentOnlyToMeBoolean条件または例外を適用するために、メールボックスの所有者が受信メッセージの唯一の受信者かどうかを示します。
SentToAddressesCollection (Recipient)条件または例外を適用するために、受信メッセージが送信されたメール アドレスを表します。
SentToMeBoolean条件または例外を適用するために、メールボックスの所有者が受信メッセージの ToRecipients プロパティにあるかどうかを示します。
SentToOrCcMeBoolean条件または例外を適用するために、メールボックスの所有者が受信メッセージの ToRecipients または CcRecipients プロパティにあるかどうかを示します。
SubjectContainsCollection (String)条件または例外を適用するために、受信メッセージの件名に表示される文字列を表します。
WithinSizeRangeSizeRange条件または例外を適用するために、受信メッセージに想定される最小サイズと最大サイズ (単位: キロバイト) を表します。

LocaleInfo

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

型:Microsoft.OutlookServices.LocaleInfo

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

Location

イベントの場所です。

型:Microsoft.OutlookServices.Location

プロパティType説明
DisplayNameString場所に関連付けられた名前。
AddressPhysicalAddress場所の物理アドレス。
CoordinatesGeoCoordinates場所の地理的座標と標高です。
LocationEmailAddressString場所の電子メール アドレス (省略可能)。

LocationConstraint

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

型:Microsoft.OutlookServices.LocationConstraint

プロパティType説明
IsRequiredbooleanクライアントは、応答に会議の場所を含めるようにサービスに要求します。
SuggestLocationbooleanクライアントは、1 つ以上の会議場所を提案するようサービスに要求します。
LocationsCollection(LocationConstraintItem)クライアントが会議のために要求する 1 つ以上の場所。

LocationConstraintItem

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

型:Microsoft.OutlookServices.Location

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

MailboxSettings

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

型:Microsoft.OutlookServices.MailboxSettings

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

MeetingTimeSuggestion

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

型:Microsoft.OutlookServices.MeetingTimeSuggestion

プロパティType説明
MeetingTimeSlotTimeSlot会議の提案されている期間。
Confidencedoubleすべての出席者が出席する見込みを表すパーセンテージ。
OrganizerAvailabilityFreeBusyStatusこの提案されている会議の開催者の空き時間情報: FreeTentativeBusyOofWorkingElsewhereUnknown
AttendeeAvailabilityCollection(AttendeeAvailability)この提案された会議の各出席者の空き時間情報の状態を示す配列。
LocationsCollection(Location)この提案された会議の各会議場所の名前と地理的な場所を指定する配列。
SuggestionReasonString会議時間を提案する理由について記述します。

会議の確実性

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

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

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

出席者空き時間状態出席見込み (%)
DanaFree100%
JohnUnknown49%
Fanny多忙0%

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

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

MeetingTimeSuggestionsResult

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

型:Microsoft.OutlookServices.MeetingTimeSuggestionsResult

プロパティType説明
MeetingTimeSuggestionsCollection(MeetingTimeSuggestion)会議提案の配列。
EmptySuggestionsReasonString会議提案が 1 つも返されない理由。可能な値: AttendeesUnavailableLocationsUnavailableOrganizerUnavailableAttendeesUnavailableOrUnknown、または Unknown

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

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

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

Location

イベントの場所です。

型:Microsoft.OutlookServices.Location

プロパティType説明
DisplayNameString場所に関連付けられた名前。
AddressPhysicalAddress場所の物理アドレス。
CoordinatesGeoCoordinates場所の地理的座標と標高です。

PatternedRecurrence

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

型:Microsoft.OutlookServices.PatternedRecurrence

プロパティType説明
PatternRecurrencePatternイベントの頻度。
RecurrenceTimeZoneString開始時刻と終了時刻のタイム ゾーン。サポートされているタイム ゾーンの一覧については DateTimeTimeZone 複合型をご覧ください。
RangeRecurrenceRangeイベントの期間。
プロパティType説明
PatternRecurrencePatternイベントの頻度。
RangeRecurrenceRangeイベントの期間。
プロパティType説明
PatternRecurrencePatternイベントの頻度。
RangeRecurrenceRangeイベントの期間。

Phone

電話番号を表します。

型:Microsoft.OutlookServices.Phone

プロパティType説明
NumberString電話番号。
TypeString電話番号の種類。可能な値は、HomeBusinessMobileOtherAssistantHomeFaxBusinessFaxOtherFaxPagerRadio です。

PhysicalAddress

連絡先の住所です。

型:Microsoft.OutlookServices.PhysicalAddress

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

Recipient

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

型:Microsoft.OutlookServices.Recipient

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

RecurrencePattern

イベントの頻度。

型:Microsoft.OutlookServices.RecurrencePattern

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

RecurrenceRange

イベントの期間。

型:Microsoft.OutlookServices.RecurrenceRange

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

ResponseStatus

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

型:Microsoft.OutlookServices.ResponseStatus

プロパティType説明
ResponseResponseType応答タイプ: NoneOrganizerTentativelyAcceptedAcceptedDeclinedNotResponded
Timedatetimeoffset応答が返された日時。

SizeRange (プレビュー)

条件または例外を適用するために、受信メッセージに想定される最小サイズと最大サイズ (単位: キロバイト) を指定します。

型:Microsoft.OutlookServices.SizeRange

プロパティType説明
MaximumSizeInt32条件または例外を適用するために、受信メッセージに想定される最大サイズ (単位: キロバイト)。
MinimumSizeInt32条件または例外を適用するために、受信メッセージに想定される最小サイズ (単位: キロバイト)。

TimeConstraint

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

型:Microsoft.OutlookServices.TimeConstraint

プロパティType説明
ActivityDomainActivityDomain(省略可能) アクティビティの性質: WorkPersonalUnrestrictedUnknown
TimeslotsCollection(TimeSlot)期間の配列。

TimeSlot

期間。

型:Microsoft.OutlookServices.TimeSlot

プロパティType説明
StartDateTimeTimeZone期間の開始時間。
EndDateTimeTimeZone期間の終了時間。

TimeZoneInformation (プレビュー)

タイム ゾーンを表します。サポートされる形式は、Windows および Internet Assigned Numbers Authority (IANA) タイム ゾーン (Olson タイム ゾーンとも呼ばれる)。

型:Microsoft.OutlookServices.TimeZoneInformation

プロパティType説明
AliasStringタイム ゾーンの識別子。
DisplayNameStringタイム ゾーンを表す表示文字列。

Website (プレビュー)

Web サイトを表します。

型:Microsoft.OutlookServices.Website

プロパティType説明
AddressStringWeb サイトの URL。
DisplayNameStringWeb サイトの表示名。
TypeWebsiteType連絡先に通常関連付けられる Web サイトの種類。可能な値: BlogHomeOtherProfileWork

WorkingHours (プレビュー)

ユーザーが働く曜日と、特定のタイムゾーンの時間を表します。

型: Microsoft.OutlookServices.WorkingHours

プロパティType説明
DaysOfWeekCollection(DayOfWeek)ユーザーが働く次のような曜日のコレクションです。日曜日 = 0、月曜日 = 1、火曜日 = 2、水曜日 = 3、木曜日 = 4、金曜日 = 5、土曜日 = 6。
StartTimeEdm.TimeOfDayユーザーが仕事を始める時間。
EndTimeEdm.TimeOfDayユーザーが仕事を終了する時間。
TimeZoneString就業時間が適用されるタイム ゾーン。 有効なタイム ゾーンの一覧については、「DateTimeTimeZone」を参照してください。

TimeConstraint

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

型:Microsoft.OutlookServices.TimeConstraint

プロパティType説明
ActivityDomainActivityDomain(省略可能) アクティビティの性質: WorkPersonalUnrestrictedUnknown
TimeslotsCollection(TimeSlot)期間の配列。

TimeSlot

期間。

型:Microsoft.OutlookServices.TimeSlot

プロパティType説明
StartDateTimeTimeZone期間の開始時間。
EndDateTimeTimeZone期間の終了時間。

列挙型

ActivityDomain | AutomaticRepliesStatus | CategoryColor (preview) | DayOfWeek | ExternalAudienceScope |
FollowupFlagStatus (プレビュー) | FreeBusyStatus | InferenceClassificationType | LocationType (プレビュー) | MailTipsType (プレビュー) | MessageActionFlag (プレビュー) | PhoneType (プレビュー) | RecipientScopeType (プレビュー) | ReferenceAttachmentPermissions | ReferenceAttachmentProviders | TaskStatus | TimeZoneStandard | WebsiteType

ActivityDomain | AutomaticRepliesStatus | DayOfWeek | ExternalAudienceScope |
FreeBusyStatus | InferenceClassificationType | TaskStatus

ActivityDomain

アクティビティの性質。

サポートされている値:

  • Work
  • Personal
  • Unrestricted
  • Unknown

AutomaticRepliesStatus

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

サポートされている値:

  • AlwaysEnabled
  • Disabled
  • Scheduled

DayOfWeek

週の曜日のセット。

サポートされている値:

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

ExternalAudienceScope

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

サポートされている値:

  • All
  • ContactsOnly
  • なし

FreeBusyStatus

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

サポートされている値:

  • Busy
  • Free
  • Oof
  • Tentative
  • Unknown
  • WorkingElsewhere

InferenceClassificationType

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

サポートされている値:

  • Focused
  • Other

ActivityDomain

アクティビティの性質。

サポートされている値:

  • Work
  • Personal
  • Unrestricted
  • Unknown

AutomaticRepliesStatus

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

サポートされている値:

  • AlwaysEnabled
  • Disabled
  • Scheduled

CategoryColor (プレビュー)

ユーザーのメールボックス内でカテゴリを特徴付ける色。 あらかじめ設定された各定数が表す実際の色は、カテゴリを表示するために使用されている Outlook クライアントに依存します。

サポートされている値Outlook デスクトップ クライアントでマッピングされている色
Preset0
Preset1オレンジ
Preset2
Preset3
Preset4
Preset5青緑
Preset6オリーブ
Preset7
Preset8
Preset9深紅
Preset10鋼色
Preset11ダーク・スチール
Preset12灰色
Preset13ダーク・グレー
Preset14
Preset15えんじ色
Preset16ダーク・オレンジ
Preset17暗褐色
Preset18黄褐色
Preset19深緑色
Preset20ダーク・ティール
Preset21ダーク・オリーブ
Preset22紺青色
Preset23暗紫色
Preset24暗い深紅
なしマッピングされている色なし

ExternalAudienceScope

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

サポートされている値:

  • All
  • ContactsOnly
  • なし

FollowupFlagStatus (プレビュー)

リソース インスタンスのフローアップ フラグの状態を表します。

サポートされている値:

  • Complete
  • Flagged
  • NotFlagged

InferenceClassificationType

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

サポートされている値:

  • Focused
  • Other

LocationType (プレビュー)

使用できる場所の種類です。

サポートされている値:

  • Default
  • ConferenceRoom
  • HomeAddress
  • BusinessAddress
  • GeoCoordinates
  • StreetAddress
  • Hotel
  • Restaurant
  • LocalBusiness
  • PostalAddress

MailTipsType (プレビュー)

要求されたメールヒントを表すフラグの列挙型。

サポートされている値:

  • AutomaticReplies
  • CustomMailTip
  • DeliveryRestriction
  • ExternalMemberCount
  • MailboxFullStatus
  • MaxMessageSize
  • ModerationStatus
  • RecipientScope
  • RecipientSuggestions
  • TotalMemberCount

MessageActionFlag (プレビュー)

メッセージに対して実行するアクションを指定します。

サポートされている値:

  • Any
  • Call
  • DoNotForward
  • FollowUp
  • FYI
  • Forward
  • NoResponseNecessary
  • Read
  • Reply
  • ReplyToAll
  • Review

PhoneType (プレビュー)

連絡先に通常関連付けられる電話番号の種類。

サポートされている値:

  • Assistant
  • Business
  • BusinessFax
  • Home
  • HomeFax
  • Mobile
  • Other
  • OtherFax
  • Pager
  • Radio

RecipientScopeType (プレビュー)

受信者スコープの種類を表すフラグの列挙型。管理者は受信者スコープを使用して、特定のメールヒントが特定のスコープのみにアクセスできるように指定できます。

サポートされている値:

  • なし
  • Internal
  • External
  • ExternalPartner
  • ExternalNonPartner

ReferenceAttachmentPermissions

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

サポートされている値:

  • Other
  • 表示
  • Edit
  • AnonymousView
  • AnonymousEdit
  • OrganizationView
  • OrganizationEdit

ReferenceAttachmentProviders

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

サポートされている値:

  • Dropbox
  • OneDriveBusiness
  • OneDriveConsumer
  • Other

Sensitivity

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

サポートされている値:

  • Normal
  • Personal
  • Private
  • Confidential

TaskStatus

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

サポートされている値:

  • TaskStatus
  • Deferred
  • InProgress
  • NotStarted
  • WaitingOnOthers

TimeZoneStandard (プレビュー)

タイム ゾーンを表す形式。

サポートされている値:

  • Windows
  • Iana

WebsiteType (プレビュー)

連絡先に通常関連付けられる Web サイトの種類を指定します。

サポートされている値:

  • Blog
  • Home
  • Other
  • Profile
  • Work

TaskStatus

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

サポートされている値:

  • TaskStatus
  • Deferred
  • InProgress
  • NotStarted
  • WaitingOnOthers

OData クエリ パラメーターの使用

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

  • $search: 特定の条件で検索します。

  • $filter: 特定の条件でフィルター処理します。

  • $select: 特定のプロパティを要求します。

  • $orderby: 結果を並び替えます。

  • $top および $skip: 結果をページングします。

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

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

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

検索要求

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

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

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

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

共通フィールドは、プロパティを指定せずに $search クエリ パラメーターを使用して検索します。既定の検索では、BodySender、および Subject プロパティが検索されます。次の検索は、3 つの既定のプロパティのいずれかに「pizza」が含まれる受信トレイ内のすべてのメッセージを返します。

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

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

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

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

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

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

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

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

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

FromSubject、または 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

FromSubject、または 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."
  }
}
演算子Type
and論理積 (複数の条件を結合するために使用する)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 を使用します。文字列自体では大文字と小文字の区別はありません。

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

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

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

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

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

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

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

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

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

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

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

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

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

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

GET https://outlook.office.com/api/beta/me/events?$filter=Start/DateTime%20ge%20%272016-04-01T08:00%27
GET https://outlook.office.com/api/beta/me/events?$filter=Subject%20eq%20%27Mega%20Charity%20Bash%27
GET https://outlook.office.com/api/beta/me/messages?$filter=IsRead%20eq%20false
GET https://outlook.office.com/api/beta/me/messages?$filter=HasAttachments%20eq%20true
GET https://outlook.office.com/api/beta/me/messages?$filter=ReceivedDateTime%20ge%202014-09-01
GET https://outlook.office.com/api/beta/me/messages?$filter=From/EmailAddress/Address%20eq%20%27hr@contoso.com%27
演算子Type
and論理積 (複数の条件を結合するために使用する)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 を使用します。文字列自体では大文字と小文字の区別はありません。

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

ユーザーの既定の予定表で、指定した日付以降に開始されるすべてのイベントを取得するには、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
演算子Type
and論理積 (複数の条件を結合するために使用する)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 パラメーターを省略した場合は、アイテムのすべてのプロパティが返されます。

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

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

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

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

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

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

結果の並べ替え

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

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

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

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

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

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

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

結果のページング

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

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

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

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

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

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

受信トレイ内に 6 つ以上のメッセージが存在していた場合は、応答に 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/beta/me/messages/$count

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

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

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

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

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

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

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

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 に設定されたアイテムのみを返す。

  • SubjectSender、および ReceivedDateTime プロパティのみを返す。

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

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

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

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

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

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

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

https://outlook.office.com/api/beta/me/messages?$filter=Subject%20eq%20%27Good%20Times%27%20AND%20Importance%20eq%20%27High%27&$orderby=Subject,Importance,Sender
  • Importance が High に設定されたアイテムのみを返す。

  • SubjectSender、および 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 パラメーター内の順序で並べる必要があります。次の例は、SubjectImportance の両方のプロパティでフィルター処理されてから、SubjectImportance、および 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
  • Importance が High に設定されたアイテムのみを返す。

  • SubjectSender、および 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 パラメーター内の順序で並べる必要があります。次の例は、SubjectImportance の両方のプロパティでフィルター処理されてから、SubjectImportance、および 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
© 2018 Microsoft