次の方法で共有


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

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

注意

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

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

ヒント

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

添付ファイル

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

型:Microsoft.OutlookServices.Entity

プロパティ Type 説明 書き込み可能 フィルター処理可能
ContentType String 添付ファイルの MIME タイプ。 はい いいえ
IsInline Boolean true 添付ファイルがインライン添付ファイルの場合は true、それ以外の場合は false はい はい
LastModifiedDateTime DateTimeOffset 添付ファイルが最後に変更された日時です。 日付と時間は ISO 8601 書式を使用し、常に UTC 時間です。

たとえば、2014 年 1 月 1 日午前 0 時 (UTC) は、「2014-01-01T00:00:00Z」となります。
いいえ はい
Name String 添付ファイルの表示名。実際のファイル名である必要はありません。 はい はい
Size Int32 添付ファイルの長さ (バイト単位)。 いいえ いいえ

Calendar

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

型: Microsoft.OutlookServices.Calendar

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

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

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

詳細については、「拡張プロパティ」を参照してください。
はい はい
SingleValueExtendedProperties collection SingleValueLegacyExtendedProperty 型の単一値拡張プロパティのコレクション。 これはナビゲーション プロパティです。

詳細については、「拡張プロパティ」を参照してください。
はい はい

CalendarGroup

予定表のグループです。

注意

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

型: Microsoft.OutlookServices.CalendarGroup

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

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

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

Contact

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

型: Microsoft.OutlookServices.Contact

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

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

プロパティ Type 説明 書き込み可能 フィルター処理可能
AssistantName String 連絡先のアシスタントの名前。 はい はい
Birthday datetimeoffset 連絡先の誕生日です。 はい はい
Categories Collection(String) 連絡先に関連付けられたカテゴリ。 はい いいえ
ChangeKey String 連絡先のバージョンを識別します。連絡先を変更するたびに ChangeKey も変更されます。これにより、Exchange は正しいバージョンのオブジェクトに変更を適用できます。 いいえ いいえ
Children Collection(String) 連絡先の子供の名前。 はい はい
CompanyName String 連絡先の会社の名前。 はい はい
CreatedDateTime datetimeoffset 連絡先が作成された時刻です。 いいえ はい
Department String 連絡先の部署。 はい はい
DisplayName String 連絡先の表示名。 はい はい
EmailAddresses Collection(EmailAddress) 連絡先のメール アドレス。 はい いいえ
Extensions Collection(Extension) 連絡先に対して定義されているオープン型のデータ拡張機能のコレクション。ナビゲーション プロパティです。 いいえ はい
FileAs String 連絡先がファイルされる名前。 はい はい
Flag FollowupFlag 連絡先の任意のフォローアップに関する情報。 はい はい
性別 String 連絡先の性別。 はい はい
Generation String 連絡先の世代。 はい はい
GivenName String 連絡先の名。 はい はい
Id String 連絡先の一意の識別子。 いいえ いいえ
ImAddresses Collection(String) 連絡先のインスタント メッセージング (IM) アドレス。 はい いいえ
Initials String 連絡先のイニシャル。 はい はい
JobTitle String 連絡先の役職。 はい はい
LastModifiedDateTime datetimeoffset 連絡先が変更された時刻です。 いいえ はい
Manager String 連絡先の上司の名前。 はい はい
MiddleName String 連絡先のミドル ネーム。 はい はい
NickName String 連絡先のニックネーム。 はい はい
OfficeLocation String 連絡先のオフィスの所在地。 はい はい
ParentFolderId String 連絡先の親フォルダーの ID。 いいえ いいえ
PersonalNotes String 連絡先に関するユーザーのメモ。 はい はい
電話 コレクション (電話) 自宅電話、携帯電話、勤務先電話など、連絡先に関連付けられた電話番号。 はい はい
PostalAddresses PhysicalAddress コレクション 自宅住所や勤務先住所など、連絡先に関連付けられた住所。 はい いいえ
Profession String 連絡先の専門的職業。 はい はい
SpouseName String 連絡先の配偶者の名前。 はい はい
Surname String 連絡先の姓。 はい はい
Title String 連絡先の肩書。 はい いいえ
Web サイト コレクション (Web サイト) 連絡先に関連付けられた Web サイト。 はい いいえ
WeddingAnniversary 日付 連絡先の結婚記念日。 はい はい
YomiCompanyName String 連絡先の会社名の読み仮名。このプロパティは省略可能です。 はい いいえ
YomiGivenName String 連絡先の名 (ファースト ネーム) の読み仮名。このプロパティは省略可能です。 はい いいえ
YomiSurname String 連絡先の姓 (ラスト ネーム) の読み仮名。このプロパティは省略可能です。 はい いいえ

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

ContactFolder

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

型: Microsoft.OutlookServices.ContactFolder

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

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

プロパティ Type 説明 書き込み可能 フィルター処理可能
ChildFolders Collection(ContactFolder) フォルダー内の子フォルダーのコレクション。ナビゲーション プロパティです。 いいえ いいえ
Contacts Collection(Contact) フォルダー内の連絡先。ナビゲーション プロパティです。 いいえ いいえ
DisplayName String フォルダーの表示名。 はい はい
Id String 連絡先フォルダーの一意の識別子。 いいえ いいえ
ParentFolderId String フォルダーの親フォルダーの ID。 いいえ いいえ
WellKnownName String フォルダーが認識されているフォルダーである場合、フォルダーの名前。現在、認識されている連絡先フォルダーは contacts のみです。 いいえ いいえ
MultiValueExtendedProperties collection MultiValueLegacyExtendedProperty 型の複数値拡張プロパティのコレクション。 これはナビゲーション プロパティです。

詳細については、「拡張プロパティ」を参照してください。
はい はい
SingleValueExtendedProperties collection SingleValueLegacyExtendedProperty 型の単一値拡張プロパティのコレクション。 これはナビゲーション プロパティです。

詳細については、「拡張プロパティ」を参照してください。
はい はい

Event

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

型: Microsoft.OutlookServices.Event

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

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

プロパティ Type 説明 書き込み可能 フィルター処理可能
Attachment Collection(Attachment) イベントの FileAttachmentItemAttachmentReferenceAttachment の各添付ファイルのコレクション。ナビゲーション プロパティです。 いいえ いいえ
Attendees Collection(Attendee) イベントの参加者のコレクション。 はい いいえ
Body ItemBody イベントに関連付けられたメッセージの本文。 はい いいえ
BodyPreview String イベントに関連付けられたメッセージのプレビュー。 いいえ いいえ
Calendar Calendar イベントを含む予定表。ナビゲーション プロパティです。 いいえ いいえ
Categories Collection(String) イベントに関連付けられたカテゴリ。 はい いいえ
ChangeKey String イベント オブジェクトのバージョンを識別します。イベントを変更するたびに ChangeKey も変更されます。これにより、Exchange は正しいバージョンのオブジェクトに変更を適用できます。 いいえ いいえ
CreatedDateTime datetimeoffset イベントが作成された日時です。 いいえ はい
End DateTimeTimeZone イベントが終了する日時。 はい はい
Extensions Collection(Extension) イベントに対して定義されているオープン型のデータ拡張機能のコレクション。ナビゲーション プロパティです。 いいえ はい
HasAttachments boolean イベントに添付ファイルが含まれている場合に、true に設定します。 いいえ はい
Id String イベントの一意識別子。 いいえ いいえ
Importance Importance イベントの重要度: LowNormalHigh はい はい
Instances Collection(Event) イベントのインスタンス。ナビゲーション プロパティです。 いいえ いいえ
iCalUID String 複数の予定表を通して 1 つのイベントのすべてのインスタンスで共有される一意の識別子。 いいえ はい
IsAllDay boolean イベントが一日中続く場合に、true に設定します。このプロパティを調整するには、イベントの Start および End プロパティの調整も必要になります。 はい はい
IsCancelled boolean イベントがキャンセルされた場合に、true に設定します。 はい はい
IsOrganizer boolean メッセージの送信者が主催者でもある場合に、true に設定します。 はい はい
IsReminderOn Boolean ユーザーにイベントを通知するアラートを設定する場合は、true に設定します。 はい はい
LastModifiedDateTime datetimeoffset イベントが最後に変更された日時です。 いいえ はい
Location​ Location​ イベントの場所の情報です。 はい はい
Locations Collection(Location) イベントを開催する場所、または参加者がいる場所。 はい はい
OnlineMeetingUrl String オンライン会議の URL。 はい いいえ
Organizer Recipient イベントの主催者。 はい はい
OriginalEndTimeZone String イベントが作成されたときに設定された終了タイム ゾーン。有効なタイム ゾーンの一覧については、「DateTimeTimeZone」を参照してください。 いいえ はい
OriginalStartTimeZone String イベントが作成されたときに設定された開始タイム ゾーン。有効なタイム ゾーンの一覧については、「DateTimeTimeZone」を参照してください。 いいえ はい
Recurrence PatternedRecurrence イベントの繰り返しパターン。 はい いいえ
ReminderMinutesBeforeStart Int32 アラーム通知を行う、イベント開始時間前の分数。 はい いいえ
ResponseRequested boolean イベントが承諾または辞退されたときに、送信者が応答を要求する場合に、true に設定します。 はい はい
ResponseStatus ResponseStatus イベント メッセージへの応答で送信される応答のタイプを識別します。 いいえ はい
Sensitivity Sensitivity イベントのプライバシーのレベルを示します: NormalPersonalPrivateConfidential はい はい
SeriesMasterId String アイテムに割り当てられたカテゴリ。 はい いいえ
ShowAs FreeBusyStatus 表示するステータス: FreeTentativeBusyOofWorkingElsewhereUnknown はい はい
Start DateTimeTimeZone イベントの開始時刻です。 はい はい
Subject String イベントの件名行のテキスト。 はい はい
Type EventType イベントの種類: SingleInstanceOccurrenceExceptionSeriesMaster はい はい
WebLink String Outlook Web App でイベントを開く URL。

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

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

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

EventMessage

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

基本型: Message

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

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

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

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

EventMessageRequest (プレビュー)

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

基本型: EventMessage

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

拡張プロパティ

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

MultiValueLegacyExtendedProperty

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

型:Microsoft.OutlookServices.MultiValueLegacyExtendedProperty

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

SingleValueLegacyExtendedProperty

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

型:Microsoft.OutlookServices.SingleValueLegacyExtendedProperty

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

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

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

FileAttachment

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

型: Microsoft.OutlookServices.FileAttachment

基本型: Microsoft.OutlookServices.Attachment

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

Folder / MailFolder

注意

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

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

型: Microsoft.OutlookServices.MailFolder

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

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

プロパティ Type 説明 書き込み可能 フィルター処理可能
ChildFolderCount Int32 フォルダー内のフォルダー数。 いいえ はい
ChildFolders Collection(MailFolder) フォルダー内の子フォルダーのコレクション。ナビゲーション プロパティです。 いいえ いいえ
DisplayName String フォルダーの表示名。 はい はい
Id String フォルダーの一意の識別子。 以下の既知の名前を使用して、対応するフォルダーにアクセスできます。InboxDraftsSentItemsDeletedItems いいえ いいえ
MessageRules Collection(MessageRule) 受信トレイ フォルダーに適用されるルールのコレクションです。ナビゲーション プロパティです。 いいえ いいえ
Message Collection(Message) フォルダー内のメッセージのコレクション。ナビゲーション プロパティです。 いいえ いいえ
ParentFolderId String フォルダーの親フォルダーの一意の識別子。 いいえ いいえ
TotalItemCount Int32 フォルダーに含まれるアイテムの数。 いいえ はい
UnreadItemCount Int32 フォルダー内で未読としてマークされているアイテム数。 いいえ はい
WellKnownName String deleteditemsdraftsinboxjunkemailoutboxsentitems などの、フォルダーの既知の名前。clutter いいえ はい
MultiValueExtendedProperties collection MultiValueLegacyExtendedProperty 型の複数値拡張プロパティのコレクション。 これはナビゲーション プロパティです。

詳細については、「拡張プロパティ」を参照してください。
はい はい
SingleValueExtendedProperties collection SingleValueLegacyExtendedProperty 型の単一値拡張プロパティのコレクション。 これはナビゲーション プロパティです。

詳細については、「拡張プロパティ」を参照してください。
はい はい

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

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

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

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

InferenceClassification

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

型: Microsoft.OutlookServices.InferenceClassification

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

InferenceClassificationOverride

特定の差出人からのメッセージを常にどのように分類するかについてのユーザーの上書きを表します。

型: Microsoft.OutlookServices.InferenceClassificationOverride

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

ItemAttachment

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

型: Microsoft.OutlookServices.ItemAttachment

基本型: Microsoft.OutlookServices.Attachment

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

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

ユーザーの電子メール アドレスに基づいたユーザーへの通知を表します。 この種類の通知は、@-メンション とも呼ばれます。

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 説明 書き込み可能 フィルター処理可能
Application String メンションが作成されるアプリケーションの名前。省略可能。Message の場合は使用されず、null として既定値に設定されます。 はい いいえ
ClientReference String リソース インスタンスの親を表す一意の識別子。省略可能。Message の場合は使用されず、null として既定値に設定されます。 はい はい
CreatedBy EmailAddress メンションしたユーザーの電子メール情報。必須です。 はい いいえ
CreatedDateTime DateTimeOffset クライアントでメンションが作成された日時。 いいえ いいえ
DeepLink String リソース インスタンス内のメンションのコンテキストへの深い Web リンク。省略可能。Message の場合は使用されず、null として既定値に設定されます。 はい いいえ
Id String リソース インスタンス内のメンションの一意の識別子。 いいえ いいえ
Mentioned EmailAddress メンションした人の電子メール情報。必須です。 はい いいえ
MentionText String メンションの内容。省略可能。Message の場合は使用されず、null として既定値に設定されます。 はい いいえ
ServerCreatedDateTime DateTimeOffset サーバーでメンションが作成された日時。省略可能。Message の場合は使用されず、null として既定値に設定されます。 いいえ いいえ

Message

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

型: Microsoft.OutlookServices.Message

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

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

プロパティ Type 説明 書き込み可能かどうか フィルター処理可能 検索可能かどうか
Attachment Collection(Attachment) メッセージの FileAttachment 添付ファイルと ItemAttachment 添付ファイル。ナビゲーション プロパティです。 はい いいえ はい
BccRecipients Collection (Recipient) メッセージの BCC 受信者。 はい いいえ はい
Body ItemBody メッセージの本文。 はい いいえ 既定
BodyPreview String メッセージ本文の内容の最初の 255 文字。 いいえ いいえ はい
Categories Collection (String) メッセージに関連付けられたカテゴリ。 はい はい はい
CcRecipients Collection (Recipient) メッセージの CC 受信者。 はい いいえ はい
ChangeKey String メッセージのバージョン。 いいえ いいえ いいえ
ConversationId String 電子メールが属している会話の ID。 いいえ はい いいえ
ConversationIndex Binary 電子メールが属している会話内の項目の相対位置を示します。 いいえ いいえ いいえ
CreatedDateTime datetimeoffset メッセージが作成された日時です。 いいえ はい いいえ
Extensions Collection(Extension) メッセージに対して定義されているオープン型のデータ拡張機能のコレクション。ナビゲーション プロパティです。 いいえ はい いいえ
Flag FollowupFlag メッセージの任意のフォローアップに関する情報。 はい はい はい
From Recipient メッセージのメールボックス所有者と送信者。 はい はい はい
HasAttachments boolean メッセージに添付ファイルがあるかどうかを示します。 いいえ はい はい
Id String メッセージの一意識別子。 いいえ いいえ いいえ
Importance Importance 次のようなメッセージの重要度があります。低 = 0、標準 = 1、高 = 2。 はい はい はい
InferenceClassification InferenceClassificationType 推定される関連性や重要性、または明示的なオーバーライドに基づく、ユーザーの対象メッセージの分類。 はい はい いいえ
InternetMessageId String RFC2822 によって指定された形式のメッセージ ID。 いいえ いいえ いいえ
InternetMessageHeaders Collection(InternetMessageHeader) RFC2822 によって指定された形式のインターネット メッセージ ヘッダーのコレクション。 いいえ いいえ いいえ
IsDeliveryReceiptRequested boolean メッセージの開封応答が要求されているかどうかを示します。 はい はい いいえ
IsDraft boolean メッセージが下書きかどうかを示します。メッセージがまだ送信されていなければ下書きです。 いいえ はい いいえ
IsRead boolean メッセージが読み取られたかどうかを示します。 はい はい いいえ
IsReadReceiptRequested boolean メッセージの開封応答が要求されているかどうかを示します。 はい はい いいえ
LastModifiedDateTime datetimeoffset メッセージが最後に変更された日時です。 いいえ はい いいえ
Mentions Collection (Mention) メッセージのメンションのコレクション。CreatedDateTime で最新の日付順になっています。既定では、プロパティで $expand を適用しない限り、GET メッセージはこのプロパティを返しません。ナビゲーション プロパティです。 はい いいえ いいえ
MentionsPreview MentionsPreview メッセージのメンションに関する情報。GET /messages 要求を処理するときに、サーバーはこのプロパティを設定して、既定で応答に含めます。メッセージにメンションがない場合は、サーバーは null を返します。省略可能。 いいえ いいえ いいえ
MultiValueExtendedProperties collection MultiValueLegacyExtendedProperty 型の複数値拡張プロパティのコレクション。 これはナビゲーション プロパティです。

詳細については、「拡張プロパティ」を参照してください。
はい はい いいえ
ParentFolderId String メッセージの親フォルダーの一意の識別子。 いいえ いいえ いいえ
ReceivedDateTime datetimeoffset メッセージが受信された日時です。 いいえ はい はい
ReplyTo Collection (Recipient) 返信時に使用される電子メール アドレス。 いいえ いいえ いいえ
Sender Recipient メッセージを生成するために実際に使用されるアカウント。 はい はい 既定
SentDateTime datetimeoffset メッセージが送信された日時です。 いいえ はい いいえ
SingleValueExtendedProperties collection SingleValueLegacyExtendedProperty 型の単一値拡張プロパティのコレクション。 これはナビゲーション プロパティです。

詳細については、「拡張プロパティ」を参照してください。
はい はい いいえ
Subject String メッセージの件名を指定します。 はい はい 既定
ToRecipients Collection (Recipient) メッセージの宛先 はい いいえ はい
UniqueBody ItemBody 会話に特有のメッセージの本文。 いいえ いいえ いいえ
UnsubscribeData Collection (String) ヘッダーに基づいて解析された有効なエントリが含まれます。UnsubscribeEnabled プロパティが true の場合、List-Unsubscribe ヘッダーの mailto: コマンドのデータが含まれます。このデータは、RFC-2369 に準拠している必要があります。対応する配布リストにメッセージがそれ以上送信されないようにするには、購読取り消しアクションを使用します。List-Unsubscribe いいえ いいえ いいえ
UnsubscribeEnabled boolean 対象メッセージで受信者が購読取り消しを行い、電子メール配布リストに基づいて今後メッセージが送信されないようにできるかどうかを示します。List-Unsubscribe ヘッダーが RFC-2369 に準拠している場合には、True です。 いいえ いいえ いいえ
WebLink String Outlook Web App でメッセージを開く URL。

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

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

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

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

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

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

Prefer: outlook.allow-unsafe-html

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

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

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

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

MessageRule (プレビュー)

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

型:Microsoft.OutlookServices.MessageRule

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

OutlookCategory (プレビュー)

型: Microsoft.OutlookServices.OutlookCategory

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

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

Photo

型:Microsoft.OutlookServices.Photo

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

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

ReferenceAttachment

型:Microsoft.OutlookServices.ReferenceAttachment

基本型: Microsoft.OutlookServices.Attachment

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

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

Task

型:Microsoft.OutlookServices.Task

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

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

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

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

プロパティ Type 説明 書き込み可能 フィルター処理可能
AssignedTo String タスクが割り当てられているユーザーの名前。 いいえ はい
Attachment Collection(Attachment) タスクの FileAttachmentItemAttachmentReferenceAttachment の各添付ファイルのコレクション。ナビゲーション プロパティです。 いいえ いいえ
Body ItemBody 通常はタスクに関する情報を含むタスク本体。HTML 型のみがサポートされていることに注意してください。 はい いいえ
Categories Collection(String) タスクに関連付けられたカテゴリ。 はい はい
ChangeKey String タスクのバージョン。 いいえ いいえ
CompletedDateTime DateTimeTimeZone タスクが終了した日付 (指定のタイム ゾーン)。 はい はい
CreatedDateTime DateTimeOffset タスクが作成された日時。既定では、UTC 時間です。要求ヘッダーでカスタム タイム ゾーンを使用できます。 いいえ はい
DueDateTime DateTimeTimeZone タスクが終了する予定の日時 (指定のタイム ゾーン)。 はい はい
HasAttachments boolean タスクに添付ファイルが含まれている場合、true に設定します。 いいえ はい
Id String タスクの一意識別子。 いいえ いいえ
Importance Importance イベントの重要度: LowNormalHigh はい はい
IsReminderOn boolean ユーザーにタスクを通知するアラートを設定する場合は、true に設定します。 はい いいえ
LastModifiedDateTime DateTimeOffset タスクが最後に変更された日時。既定では、UTC 時間です。要求ヘッダーでカスタム タイム ゾーンを使用できます。 いいえ はい
Owner String タスクを作成したユーザーの名前。 いいえ はい
ParentFolderId String タスクの親フォルダーの一意の識別子。 いいえ いいえ
Recurrence PatternedRecurrence タスクの繰り返しパターン。 はい いいえ
ReminderDateTime DateTimeTimeZone タスクのアラーム通知を行う日時。 はい いいえ
Sensitivity Sensitivity イベントのプライバシーのレベルを示します: NormalPersonalPrivateConfidential はい はい
StartDateTime DateTimeTimeZone タスクを開始する日付 (指定のタイム ゾーン)。 はい はい
Status TaskStatus タスクの状態または進行状況を示します: NotStartedInProgressCompletedWaitingOnOthersDeferred はい はい
Subject String タスクのタイトルまたは簡単な説明。 はい はい

TaskFolder

型:Microsoft.OutlookServices.TaskFolder

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

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

TaskGroup

型:Microsoft.OutlookServices.TaskGroup

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

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

User

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

型: Microsoft.OutlookServices.User

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

注意

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

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

複合型

Attendee

イベントの参加者。

型:Microsoft.OutlookServices.AttendeeBase

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

AttendeeAvailability

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

型:Microsoft.OutlookServices.AttendeeAvailability

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

AttendeeBase

出席者の種類。

型:Microsoft.OutlookServices.Recipient

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

AutomaticRepliesMailTips (プレビュー)

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

型:Microsoft.OutlookServices.AutomaticRepliesMailTips

プロパティ Type 説明
Message String 自動応答メッセージ。
MessageLanguage LocaleInfo 自動応答メッセージの言語。
ScheduledStartTime DateTimeTimeZone 自動応答を開始する日時。
ScheduledEndTime DateTimeTimeZone 自動応答を終了する日時。

AutomaticRepliesSetting

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

型:Microsoft.OutlookServices.AutomaticRepliesSetting

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

DateTimeTimeZone

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

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

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

Etc/GMT+12

Etc/GMT+11

太平洋/ホノルル

アメリカ/アンカレッジ

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

アメリカ/ロサンゼルス

アメリカ/フェニックス

アメリカ/チワワ

アメリカ/デンバー

アメリカ/グアテマラ

アメリカ/シカゴ

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

アメリカ/リジャイナ

アメリカ/ボゴタ

アメリカ/ニューヨーク

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

アメリカ/カラカス

アメリカ/アスンシオン

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

アメリカ/クイアバ

アメリカ/ラパス

アメリカ/サンティアゴ

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

アメリカ/サンパウロ

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

アメリカ/カイエンヌ

アメリカ/ゴットホープ

アメリカ/モンテビデオ

アメリカ/バイア

Etc/GMT+2

大西洋/アゾレス諸島

大西洋/カーボベルデ

アフリカ/カサブランカ

Etc/GMT

ヨーロッパ/ロンドン

大西洋/レイキャビク

ヨーロッパ/ベルリン

ヨーロッパ/ブダペスト

ヨーロッパ/パリ

ヨーロッパ/ワルシャワ

アフリカ/ラゴス

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

ヨーロッパ/ブカレスト

アジア/ベイルート

アフリカ/カイロ

アジア/ダマスカス

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

ヨーロッパ/キエフ

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

アジア/エルサレム

アジア/アンマン

アジア/バグダッド

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

アジア/リャド

アフリカ/ナイロビ

アジア/テヘラン

アジア/ドバイ

アジア/バクー

ヨーロッパ/モスクワ

インド/モーリシャス

アジア/トビリシ

アジア/エレバン

アジア/カブール

アジア/カラチ

アジア/タシケント

アジア/コルカタ

アジア/コロンボ

アジア/カトマンズ

アジア/アルマトイ

アジア/ダッカ

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

アジア/ヤンゴン

アジア/バンコク

アジア/ノボシビルスク

アジア/上海

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

アジア/シンガポール

オーストラリア/パース

アジア/台北

アジア/ウランバートル

アジア/イルクーツク

アジア/東京

アジア/ソウル

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

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

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

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

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

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

アジア/ヤクーツク

太平洋/ガダルカナル島

アジア/ウラジオストク

太平洋/オークランド

Etc/GMT-12

太平洋/フィジー

アジア/マガダン

太平洋/トンガタプ

太平洋/アピア

太平洋/クリスマス島

EmailAddress

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

型: Microsoft.OutlookServices.EmailAddress

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

Error (プレビュー)

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

型:Microsoft.OutlookServices.Error

プロパティ Type 説明
Message String エラー メッセージ。
Code String エラー コード。

FollowUpFlag (プレビュー)

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

型:Microsoft.OutlookServices.FollowupFlag

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

GeoCoordinates

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

型:Microsoft.OutlookServices.GeoCoordinates

プロパティ Type 説明
Altitude double 場所の標高です。
Latitude double 場所の緯度です。
Longitude double 場所の経度です。
Accuracy double 緯度と経度を提供するセンサーの精度です。
AltitudeAccuracy double 標高を検知するセンサーの精度。

InternetMessageHeader (プレビュー)

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

型: Microsoft.OutlookServices.InternetMessageHeader

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

ItemBody

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

型: Microsoft.OutlookServices.ItemBody

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

LocaleInfo

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

型: Microsoft.OutlookServices.LocaleInfo

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

Location (プレビュー)

イベントの場所。

型: Microsoft.OutlookServices.Location

プロパティ Type 説明
Address PhysicalAddress 場所の物理アドレス。
Coodinates GeoCoordinates 場所の地理的座標と標高です。
DisplayName String 場所に関連付けられた名前。
LocationEmailAddress String 場所の電子メール アドレス (省略可能)。
LocationUri String 場所を表す URI (省略可能)。
LocationType LocationType 場所の種類は、 DefaultConferenceRoomHomeAddressBusinessAddressGeoCoordinatesStreetAddressHotelRestaurantLocalBusinessPostalAddress です。

LocationConstraint

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

型: Microsoft.OutlookServices.LocationConstraint

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

LocationConstraintItem

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

型: Microsoft.OutlookServices.Location

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

MailTips (プレビュー)

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

型:Microsoft.OutlookServices.MailTips

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

MailboxSettings

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

型: Microsoft.OutlookServices.MailboxSettings

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

MeetingTimeSuggestion

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

型:Microsoft.OutlookServices.MeetingTimeSuggestion

プロパティ Type 説明
MeetingTimeSlot TimeSlot 会議の提案されている期間。
Confidence double すべての出席者が出席する見込みを表すパーセンテージ。
OrganizerAvailability FreeBusyStatus この提案されている会議の開催者の空き時間情報: FreeTentativeBusyOofWorkingElsewhereUnknown
AttendeeAvailability コレクション (AttendeeAvailability) この提案された会議の各出席者の空き時間情報の状態を示す配列。
Locations Collection(Location) この提案された会議の各会議場所の名前と地理的な場所を指定する配列。
SuggestionReason String 会議時間を提案する理由について記述します。

会議の確実性

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

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

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

Attendee 空き状況 出席見込み (%)
Dana フリー 100%
John Unknown 49%
Fanny Busy 0%

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

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

MeetingTimeSuggestionsResult

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

型:Microsoft.OutlookServices.MeetingTimeSuggestionsResult

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

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

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

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

MentionsPreview (プレビュー)

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

型:Microsoft.OutlookServices.MentionsPreview

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

MessageRuleActions (プレビュー)

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

型:Microsoft.OutlookServices.MessageRuleActions

プロパティ Type 説明
AssignCategories Collection (String) メッセージに割り当てられるカテゴリの一覧です。
CopyToFolder String メッセージのコピー先のフォルダーの ID です。
Delete Boolean 削除済みアイテム フォルダーにメッセージを移動する必要があるかどうかを示します。
ForwardAsAttachmentTo Collection (Recipient) 添付ファイルとしてメッセージを転送する受信者の電子メール アドレスです。
ForwardTo Collection (Recipient) メッセージを転送する受信者の電子メール アドレスです。
MarkAsRead Boolean メッセージを開封済みにする必要があるかどうかを示します。
MarkImportance Importance メッセージの重要度: LowNormalHigh を設定します。
MoveToFolder String メッセージ移動先のフォルダーの ID です。
PermanentDelete Boolean メッセージを完全に削除し、削除済みアイテム フォルダーにメッセージを保存しないようにするかどうかを示します。
RedirectTo Recipient メッセージのリダイレクト先の電子メール アドレスです。
StopProcessingRules Boolean 後続のルールを評価する必要があるかどうかを示します。

MessageRulePredicates (プレビュー)

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

型:Microsoft.OutlookServices.MessageRulePredicates

プロパティ Type 説明
BodyContains Collection (String) 条件または例外を適用するために、受信メッセージの本文に表示される文字列を表します。
BodyOrSubjectContains Collection (String) 条件または例外を適用するために、受信メッセージの本文または件名に表示される文字列を表します。
Categories Collection (String) 条件または例外を適用するために、受信メッセージにラベルを付けるカテゴリを表します。
FromAddresses Collection (Recipient) 条件または例外を適用するために、受信メッセージの特定の送信者のメール アドレスを表します。
HasAttachments Boolean 条件または例外を適用するために、受信メッセージに添付ファイルがあるかどうかを示します。
HeaderContains Collection (String) 条件または例外を適用するために、受信メッセージのヘッダーに表示される文字列を表します。
Importance Importance 条件または例外を適用するために、受信メッセージに記録される重要性: LowNormalHigh
IsApprovalRequest Boolean 条件または例外を適用するために、受信メッセージが承認要求であるかどうかを示します。
IsAutomaticForward Boolean 条件または例外を適用するために、受信メッセージが自動的に転送されるかどうかを示します。
IsAutomaticReply Boolean 条件または例外を適用するために、受信メッセージが自動返信であるかどうかを示します。
IsEncrypted Boolean 条件または例外を適用するために、受信メッセージが暗号化されるかどうかを示します。
IsMeetingRequest Boolean 条件または例外を適用するために、受信メッセージが会議出席依頼であるかどうかを示します。
IsMeetingResponse Boolean 条件または例外を適用するために、受信メッセージが会議出席依頼の返信であるかどうかを示します。
IsNonDeliveryReport Boolean 条件または例外を適用するために、受信メッセージが配信不能レポートであるかどうかを示します。
IsPermissionControlled Boolean 条件または例外を適用するために、受信メッセージがアクセス許可制御 (RMS 保護) されるかどうかを示します。
IsReadReceipt Boolean 条件または例外を適用するために、受信メッセージが開封確認メッセージであるかどうかを示します。
IsSigned Boolean 条件または例外を適用するために、受信メッセージが S/MIME 署名されているかどうかを示します。
IsVoicemail Boolean 条件または例外を適用するために、受信メッセージがボイス メールかどうかを示します。
MessageActionFlag MessageActionFlag 条件または例外を適用するために、受信メッセージに表示されるアクション フラグの値を表します。
NotSentToMe Boolean 条件または例外を適用するために、メールボックスの所有者が受信メッセージの受信者でないことを示します。
ReceipentContains Collection (String) 条件または例外を適用するために、受信メッセージの ToRecipients または CcRecipients プロパティに表示される文字列を表します。
SenderContains Collection (String) 条件または例外を適用するために、受信メッセージの From プロパティに表示される文字列を表します。
Sensitivity Sensitivity 条件または例外を適用するために、受信メッセージに記録される秘密度レベルを表します。使用可能な値: NormalPersonalPrivateConfidential
SentCcMe Boolean 条件または例外を適用するために、メールボックスの所有者が受信メッセージの CcRecipients プロパティにあるかどうかを示します。
SentOnlyToMe Boolean 条件または例外を適用するために、メールボックスの所有者が受信メッセージの唯一の受信者かどうかを示します。
SentToAddresses Collection (Recipient) 条件または例外を適用するために、受信メッセージが送信されたメール アドレスを表します。
SentToMe Boolean 条件または例外を適用するために、メールボックスの所有者が受信メッセージの ToRecipients プロパティにあるかどうかを示します。
SentToOrCcMe Boolean 条件または例外を適用するために、メールボックスの所有者が受信メッセージの ToRecipients または CcRecipients プロパティにあるかどうかを示します。
SubjectContains Collection (String) 条件または例外を適用するために、受信メッセージの件名に表示される文字列を表します。
WithinSizeRange SizeRange 条件または例外を適用するために、受信メッセージに想定される最小サイズと最大サイズ (単位: キロバイト) を表します。

PatternedRecurrence

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

型: Microsoft.OutlookServices.PatternedRecurrence

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

Phone

電話番号を表します。

型:Microsoft.OutlookServices.Phone

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

PhysicalAddress

連絡先の住所です。

型: Microsoft.OutlookServices.PhysicalAddress

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

Recipient

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

型:Microsoft.OutlookServices.Recipient

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

RecurrencePattern

イベントの頻度。

型: Microsoft.OutlookServices.RecurrencePattern

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

RecurrenceRange

イベントの期間。

型: Microsoft.OutlookServices.RecurrenceRange

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

ResponseStatus

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

型: Microsoft.OutlookServices.ResponseStatus

プロパティ Type 説明
Response ResponseType 応答タイプ: NoneOrganizerTentativelyAcceptedAcceptedDeclinedNotResponded
Time datetimeoffset 応答が返された日時。

SizeRange (プレビュー)

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

型:Microsoft.OutlookServices.SizeRange

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

TimeConstraint

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

型: Microsoft.OutlookServices.TimeConstraint

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

TimeSlot

期間。

型: Microsoft.OutlookServices.TimeSlot

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

TimeZoneInformation (プレビュー)

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

型:Microsoft.OutlookServices.TimeZoneInformation

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

Website (プレビュー)

Web サイトを表します。

型:Microsoft.OutlookServices.Website

プロパティ Type 説明
Address String Web サイトの URL。
DisplayName String Web サイトの表示名。
Type WebsiteType 連絡先に通常関連付けられる Web サイトの種類。可能な値は、BlogHomeOtherProfileWork です。

WorkingHours (プレビュー)

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

型: Microsoft.OutlookServices.WorkingHours

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

列挙型

DayOfWeek

週の曜日のセット。

サポートされている値:

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

FreeBusyStatus

会議の出席者の空き状況を示します。

サポートされている値:

  • Busy
  • フリー
  • Oof
  • Tentative
  • Unknown
  • WorkingElsewhere

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
  • None

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

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

サポートされている値:

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

Sensitivity

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

サポートされている値:

  • Normal
  • Personal
  • Private
  • Confidential

TaskStatus

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

サポートされている値:

  • TaskStatus
  • Deferred
  • InProgress
  • NotStarted
  • WaitingOnOthers

TimeZoneStandard (プレビュー)

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

サポートされている値:

  • Windows
  • Iana

WebsiteType (プレビュー)

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

サポートされている値:

  • Blog
  • Home
  • Other
  • Profile
  • Work

OData クエリ パラメーター

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

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

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

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

  • $orderby : 結果をソートします。

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

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

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

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

検索要求

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

注意

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

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

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

プロパティを指定せずに $search クエリ パラメーターを使用して共通フィールドを検索します。 既定の検索では BodySenderSubject プロパティを検索します。 次の検索は、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

フィルター処理要求

$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

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

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

注意

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

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

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

結果の並べ替え

$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

結果のページング

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

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

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

GET https://outlook.office.com/api/beta/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

すべてをまとめる

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

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

  • SubjectSenderReceivedDateTime プロパティのみを返す。

  • 最初の 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

関連項目