Exchange の EWS でのプロパティ セットと応答の図形

  • [アーティクル]

EWS マネージ API および Exchange の EWS から返される応答の図形とプロパティ セットを管理する方法について説明します。

Exchange のデータ保存には、連絡先や予定表のエントリなど、さまざまなアイテムを同じフォルダーに格納できる柔軟なストレージ ソリューションが採用されています。しかしそのために、EWS 操作や EWS マネージ API メソッドへの呼び出しから返されるデータを管理するのが困難になることがあります。

Exchange Online、Office 365 の一部である Exchange Online、または Exchange 2013 以降の Excahange バージョンから返されるデータの管理を容易にするために、EWS マネージ API はプロパティ セットを使用し、EWS は応答の図形を使用します。 これらは、ストア アイテムの最も一般的なプロパティを提供する事前定義されたコレクションです。 返されるプロパティのセットは、アイテムの種類によって決まります。 つまり、Exchange マネージ API の Item.Bind メソッドを使用してアイテムをバインドすると、バインドするアイテムの種類によって異なるプロパティのセットを取得します。 予定表アイテムへのバインドでは、連絡先アイテムへのバインドとは異なるプロパティのセットが返されます。 同様に、EWS を使用している場合、GetItem 操作は返されるアイテムの種類に応じて異なるプロパティ セットを返します。

Folder.Bind メソッドでフォルダーをバインドしたり、GetFolder 操作 を使用したりしても、要求したフォルダーに応じて異なるプロパティ セットが返されます。

表 1. 事前定義された応答の図形

応答の図形 EWS マネージ API の同等物 説明
ID のみ
 BasePropertySet.IdOnly
アイテムまたはフォルダーの ID のみを返します。 ほとんどのアプリケーションは、この応答の図形を使用し、さらに必要なプロパティを指定します。
既定値
 該当なし
 アイテムまたはフォルダー (EWS のみ) の既定である事前定義プロパティ セットを返します。
すべてのプロパティ
 BasePropertySet.FirstClassProperties
クライアント アプリケーションで最も頻繁に使用されるプロパティを返します。 プロパティ パスを使用して追加のプロパティを返すことができます。

既定の応答の図形

EWS には、フォルダーまたはフォルダー アイテムの既定の応答の図形セットが含まれています。

次の表は、FindFolder と GetFolder の EWS 操作によって、フォルダーごとに返される既定のプロパティを示します。

表 2. 既定のフォルダーのプロパティ

プロパティ 受信トレイ 予定表 連絡先 削除済みアイテム 下書き メモ その他のフォルダー 送信トレイ
表示名
 X
 X
 X
 X
 X
 X
 X
 X
フォルダー ID
 X
 X
 X
 X
 X
 X
 X
 X
サブフォルダーの数
 X
 X
 X
 X
 X
 X
 X
 X
総件数
 X
 X
 X
 X
 X
 X
 X
未読件数
 X
 X
 X
 X
 X

次の表は、FindItem と GetItem の EWS 操作によってアイテムの種類ごとに返される既定のプロパティを示します。

表 3. 既定のアイテム プロパティ

プロパティ 予定表アイテム 連絡先アイテム メッセージ アイテム 作業アイテム
Body
 X(1)
CalendarItemType
 x
CompanyName
 x
CompleteName
 x
DateTimeCreated
 x
DateTimeSent
 x
DueDate
 x(2)
EmailAddresses
 x
End
 x
FileAs
 x
接続元
 x
HasAttachments
 x
 x
 x
 x
ImAddresses
 x
IsAssociated
 x
 x
IsDeliveryReceiptRequested
 x
ItemId
 x
 x
 x
 x
JobTitle
 x
LegacyFreeBusyStatus
 x
Location
 x
開催者
 x
PercentComplete
 x
PhoneNumbers
 x
PhysicalAddresses
 x
ResponseObjects
 x(1)
 x(1)
Sensitity
 x
サイズ
 x
StartDate
 x(2)
Status
 x
対象
 x
 x
 x

注:

  1. GetItem 操作の応答に含まれます。 FindItem 操作の応答に含まれません。

  2. フィールドにデータがある場合のみ応答に含まれます。 フィールドが空白の場合は応答に含まれません。

すべてのプロパティ セットと応答の図形

次の表では、EWS マネージ API の Item.Bind メソッドと Item.FindItems メソッドを呼び出して返されるファースト クラスのプロパティ、および FindItem と GetItem の EWS 操作により返される、「すべてのプロパティ」の応答の図形を示しています。

プロパティ セットにさらにプロパティを追加したり、拡張プロパティを含めたりすることができます。 詳細については、「Exchange における EWS のプロパティと拡張プロパティ」をご参照ください。

表 4. ファースト クラスのプロパティ

プロパティ
 予定表アイテム
 連絡先アイテム
 メッセージ アイテム
 投稿アイテム
 作業アイテム
ActualWork
 x
AdjacentMeetingCount
 x
AdjacentMeetings
 x
エイリアス
 x
AllowNewTimeProposal
 x
AppointmentReplyTime
 x
AppointmentSequenceNumber
 x
AppointmentState
 x
AssignedTime
 x
AssistantName
 x
BccRecipients
 x
BillingInformation
 x
Body
 x(1)
 x(1)
 x(1)
 x(1)
BusinessHomePage
 x
 x
CalendarItemType
 x
カテゴリ
 x
 x
 x
 x
CcRecipients
 x
ChangeCount
 x
子供
 x
Companies
 x
CompleteDate
 x
CompleteName
 x
ConferenceType
 x
ConflictingMeetingCount
 x
ConflictingMeetings
 x
連絡先
 x
ContactSource
 x
ConversationId
 x
 x
 x
 x
 x
ConversationIndex
 x
 x
ConversationTopic
 x
 x
カルチャ
 x
 x
 x
 x
 x
DateTimeCreated
 x
 x
 x
 x
 x
DateTimeReceived
 x
 x
 x
 x
 x
DateTimeSent
 x
 x
 x
 x
 x
DateTimeStamp
 x
DelegationState
 x
Delegator
 x
DeletedOccurrences
 x
Department
 x
DirectoryId
 x
DirectReports
 x
DisplayCc
 x
 x
 x
 x
 x
DisplayName
 x
DisplayTo
 x
 x
 x
 x
 x
DueDate
 x
Duration
 x
EffectiveRights
 x
 x
 x
 x
 x
EmailAddresses
 x
End
 x
EndTimeZone
 x
FileAs
 x
FileAsMapping
 x
FirstOccurrence
 x
接続元
 x
 x
Generation
 x
GivenName
 x
HasAttachments
 x
 x
 x
 x
 x
HasPicture
 x
ImAddresses
 x
Importance
 x
 x
 x
 x
 x
Initials
 x
InReplyTo
 x
 x
 x
 x
 x
InternetMessageId
 x
 x
InternetMessageHeaders
 x
 x
 x
 x
 x
IsAllDayEvent
 x
IsAssociated
 x
 x
 x
 x
 x
IsCancelled
 x
IsComplete
 x
IsDeliveryReceiptRequested
 x
IsDraft
 x
 x
 x
 x
 x
IsFromMe
 x
 x
 x
 x
 x
IsMeeting
 x
IsOnlineMeeting
 x
IsRead
 x
IsReadReceiptRequested
 x
IsRecurring
 x
 x
IsResend
 x
 x
 x
 x
 x
IsResponseRequested
 x
 x
IsSubmitted
 x
 x
 x
 x
 x
IsUnmodified
 x
 x
 x
 x
 x
ItemClass
 x
 x
 x
 x
 x
ItemId
 x
 x
 x
 x
 x
JobTitle
 x
LastModifiedName
 x
 x
 x
 x
 x
LastModifiedTime
 x
 x
 x
 x
 x
LastOccurrance
 x
LegacyFreeBusyStatus
 x
Location
 x
Manager
 x
MeetingRequestWasSent
 x
MeetingTimeZone
 x
MeetingWorkspaceUrl
 x
MiddleName
 x
Mileage
 x
 x
ModifiedOccurrances
 x
MyResponseType
 x
NetShowUrl
 x
NickName
 x
メモ
 x
OfficeLocation
 x
OptionalAttendees
 x
開催者
 x
OriginalStart
 x
Owner
 x
ParentFolderId
 x
 x
 x
 x
 x
PercentComplete
 x
PhoneNumbers
 x
PhoneticFirstName
 x
PhoneticFullName
 x
PhoneticLastName
 x
Photo
 x
PhysicalAddresses
 x
PostalAddressIndex
 x
PostedTime
 x
Profession
 x
ReceivedBy
 x
ReceivedRepresenting
 x
Reccurrence
 x
 x
参照
 x
 x
ReminderDueBy
 x
 x
 x
 x
 x
ReminderIsSet
 x
 x
 x
 x
 x
ReminderMinutesBeforeStart
 x
 x
 x
 x
 x
ReplyTo
 x
RequiredAttendees
 x
リソース
 x
ResponseObjects
 x(1)
 x(1)
 x(1)
 x(1)
 x(1)
Sender
 x
 x
Sensitivity
 x
 x
 x
 x
 x
サイズ
 x
 x
 x
 x
 x
SpouseName
 x
開始
 x
StartDate
 x
StartTimeZone
 x
Status
 x
StatusDescription
 x
対象
 x
 x
 x
 x
Surname
 x
タイム ゾーン
 x
ToRecipients
 x
TotalWork
 x
WebClientEditFormQueryString
 x
 x
 x
 x
 x
WebClientReadFormQueryString
 x
 x
 x
 x
 x

注:

  1. アイテムへバインドするとき、および GetItem 操作からの応答に含まれます。 Item.FindItems メソッドの結果や FindItem 操作からの応答には含まれません。

関連項目