属性集和响应形状在 EWS 在 Exchange

了解如何管理 Exchange 中的 EWS 托管 API 和 EWS 返回的响应形状和属性集。

Exchange 数据存储提供灵活的存储解决方案,使你能够将不同的项目(如联系人和日历条目)存储在同一文件夹中;但是,它可能难以管理从调用 EWS 操作或 EWS 托管 API 方法返回的数据。

为了更轻松地管理 Exchange Online 返回的数据,Exchange Online作为 Office 365 的一部分,或从 Exchange 2013 开始的 Excahange 版本,EWS 托管 API 使用属性集,EWS 使用响应形状。 这些是预定义的集合,提供存储项的最常见属性。 返回的属性集由项类型确定。 这意味着,使用 Exchange 托管 API Item.Bind 方法绑定项时,会获得一组不同的属性,具体取决于绑定到的项的类型。 绑定到日历项目将返回与绑定到联系人项目不同的属性集。 同样,如果使用 EWS,GetItem 操作 将根据返回的项类型返回一组不同的属性。

使用 Folder.Bind 方法或使用 GetFolder 操作 绑定到文件夹也会根据请求的文件夹返回不同的属性集。

表 1. 预定义的响应形状

响应形状 EWS 托管 API 等效项 说明
仅 ID
BasePropertySet.IdOnly
仅返回项目或文件夹的标识符。 大多数应用程序应使用此响应形状并指定所需的任何其他属性。
默认值
不适用
返回一组预定义的属性,这些属性是项或文件夹的默认值, (EWS 仅) 。
所有属性
BasePropertySet.FirstClassProperties
返回客户端应用程序最常使用的属性。 可以使用属性路径返回其他属性。

默认响应形状

EWS 包括文件夹和项目的一组默认响应形状。

下表列出了 FindFolderGetFolder EWS 操作为每个文件夹返回的默认属性。

表 2. 默认文件夹属性

属性 收件箱 Calendar 联系人 已删除项目 草稿 注意 其他文件夹 发件箱
显示名称
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

下表列出了 FindItemGetItem EWS 操作为每个项类型返回的默认属性。

表 3. 默认项属性

属性 日历项 联系人项目 邮件项 任务项目
正文
X (1)
CalendarItemType
x
CompanyName
x
CompleteName
x
DateTimeCreated
x
DateTimeSent
x
DueDate
x (2)
EmailAddresses
x
End
x
FileAs
x
From
x
HasAttachments
x
x
x
x
ImAddresses
x
IsAssociated
x
x
IsDeliveryReceiptRequested
x
ItemId
x
x
x
x
JobTitle
x
LegacyFreeBusyStatus
x
位置
x
组织者
x
PercentComplete
x
PhoneNumbers
x
PhysicalAddresses
x
ResponseObjects
x (1)
x (1)
敏感度
x
Size
x
StartDate
x (2)
状态
x
主题
x
x
x

注意:

  1. 包含在 GetItem 操作的响应中。 未包含在 FindItem 操作的响应中。

  2. 仅当字段包含数据时,才包含在响应中。 如果字段为空,则不会包含在响应中。

所有属性集和响应形状

下表列出了通过调用 EWS 托管 API Item.BindItem.FindItems EWS 托管 API 方法返回的第一类属性,以及 FindItemGetItem 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
正文
x (1)
x (1)
x (1)
x (1)
BusinessHomePage
x
x
CalendarItemType
x
类别
x
x
x
x
CcRecipients
x
ChangeCount
x
Children
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
Culture
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
部门
x
DirectoryId
x
DirectReports
x
DisplayCc
x
x
x
x
x
DisplayName
x
DisplayTo
x
x
x
x
x
DueDate
x
持续时间
x
EffectiveRights
x
x
x
x
x
EmailAddresses
x
End
x
EndTimeZone
x
FileAs
x
FileAsMapping
x
FirstOccurrence
x
From
x
x
Generation
x
GivenName
x
HasAttachments
x
x
x
x
x
HasPicture
x
ImAddresses
x
重要性
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
位置
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
所有者
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
References
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)
发件人
x
x
敏感度
x
x
x
x
x
Size
x
x
x
x
x
SpouseName
x
开始
x
StartDate
x
StartTimeZone
x
状态
x
StatusDescription
x
主题
x
x
x
x
Surname
x
TimeZone
x
ToRecipients
x
TotalWork
x
WebClientEditFormQueryString
x
x
x
x
x
WebClientReadFormQueryString
x
x
x
x
x

注意:

  1. 在绑定到项时包含在 GetItem 操作的响应中。 未包含在 Item.FindItems 方法的结果或 FindItem 操作的响应中。

另请参阅