Share via

2.2.4.24 t:ItemType Complex Type

  • Article

The ItemType complex type specifies a generic item on the server.

 <xs:complexType name="ItemType">
     <xs:sequence>
         <xs:element name="MimeContent" type="t:MimeContentType" minOccurs="0"/>
         <xs:element name="ItemId" type="t:ItemIdType" minOccurs="0"/>
         <xs:element name="ParentFolderId" type="t:FolderIdType" minOccurs="0"/>
         <xs:element name="ItemClass" type="t:ItemClassType" minOccurs="0"/>
         <xs:element name="Subject" type="xs:string" minOccurs="0"/>
         <xs:element name="Sensitivity" type="t:SensitivityChoicesType" minOccurs="0"/>
         <xs:element name="Body" type="t:BodyType" minOccurs="0"/>
         <xs:element name="Attachments" type="t:NonEmptyArrayOfAttachmentsType" minOccurs="0"/>
         <xs:element name="DateTimeReceived" type="xs:dateTime" minOccurs="0"/>
         <xs:element name="Size" type="xs:int" minOccurs="0"/>
         <xs:element name="Categories" type="t:ArrayOfStringsType" minOccurs="0"/>
         <xs:element name="Importance" type="t:ImportanceChoicesType" minOccurs="0"/>
         <xs:element name="InReplyTo" type="xs:string" minOccurs="0"/>
         <xs:element name="IsSubmitted" type="xs:boolean" minOccurs="0"/>
         <xs:element name="IsDraft" type="xs:boolean" minOccurs="0"/>
         <xs:element name="IsFromMe" type="xs:boolean" minOccurs="0"/>
         <xs:element name="IsResend" type="xs:boolean" minOccurs="0"/>
         <xs:element name="IsUnmodified" type="xs:boolean" minOccurs="0"/>
         <xs:element name="InternetMessageHeaders" type="t:NonEmptyArrayOfInternetHeadersType" minOccurs="0"/>
         <xs:element name="DateTimeSent" type="xs:dateTime" minOccurs="0"/>
         <xs:element name="DateTimeCreated" type="xs:dateTime" minOccurs="0"/>
         <xs:element name="ResponseObjects" type="t:NonEmptyArrayOfResponseObjectsType" minOccurs="0"/>
         <xs:element name="ReminderDueBy" type="xs:dateTime" minOccurs="0"/>
         <xs:element name="ReminderIsSet" type="xs:boolean" minOccurs="0"/>
         <xs:element name="ReminderNextTime" type="xs:dateTime" minOccurs="0"/>
         <xs:element name="ReminderMinutesBeforeStart" type="t:ReminderMinutesBeforeStartType" minOccurs="0"/>
         <xs:element name="DisplayCc" type="xs:string" minOccurs="0"/>
         <xs:element name="DisplayTo" type="xs:string" minOccurs="0"/>
         <xs:element name="HasAttachments" type="xs:boolean" minOccurs="0"/>
         <xs:element name="ExtendedProperty" type="t:ExtendedPropertyType" minOccurs="0" maxOccurs="unbounded"/>
         <xs:element name="Culture" type="xs:language" minOccurs="0"/>
         <xs:element name="EffectiveRights" type="t:EffectiveRightsType" minOccurs="0"/>
         <xs:element name="LastModifiedName" type="xs:string" minOccurs="0"/>
         <xs:element name="LastModifiedTime" type="xs:dateTime" minOccurs="0"/>
         <xs:element name="IsAssociated" type="xs:boolean" minOccurs="0"/>
         <xs:element name="WebClientReadFormQueryString" type="xs:string" minOccurs="0"/>
         <xs:element name="WebClientEditFormQueryString" type="xs:string" minOccurs="0"/>
         <xs:element name="ConversationId" type="t:ItemIdType" minOccurs="0"/>
         <xs:element name="UniqueBody" type="t:BodyType" minOccurs="0"/>
         <xs:element name="Flag" type="t:FlagType" minOccurs="0"/>
         <xs:element name="StoreEntryId" type="xs:base64Binary" minOccurs="0"/>
         <xs:element name="InstanceKey" type="xs:base64Binary" minOccurs="0"/>
         <xs:element name="NormalizedBody" type="t:BodyType" minOccurs="0"/>
         <xs:element name="EntityExtractionResult" type="t:EntityExtractionResultType" minOccurs="0" />
         <xs:element name="PolicyTag" type="t:RetentionTagType" minOccurs="0"/>
         <xs:element name="ArchiveTag" type="t:RetentionTagType" minOccurs="0"/>
         <xs:element name="RetentionDate" type="xs:dateTime" minOccurs="0"/>
         <xs:element name="Preview" type="xs:string" minOccurs="0"/>
         <xs:element name="RightsManagementLicenseData" type="t:RightsManagementLicenseDataType" minOccurs="0" />
         <xs:element name="NextPredictedAction" type="t:PredictedMessageActionType" minOccurs="0" />
         <xs:element name="GroupingAction" type="t:PredictedMessageActionType" minOccurs="0"/>
         <xs:element name="PredictedActionReasons" type="t:NonEmptyArrayOfPredictedActionReasonType" minOccurs="0"/>
         <xs:element name="IsClutter" type="xs:boolean" minOccurs="0"/>
         <xs:element name="BlockStatus" type="xs:boolean" minOccurs="0" />
         <xs:element name="HasBlockedImages" type="xs:boolean" minOccurs="0" />
         <xs:element name="TextBody" type="t:BodyType" minOccurs="0"/>
         <xs:element name="IconIndex" type="t:IconIndexType" minOccurs="0"/>
         <xs:element name="MimeContentUTF8" type="t:MimeContentUTF8Type" minOccurs="0"/> 
         <xs:element name="SearchKey" type="xs:base64Binary" minOccurs="0"/>
         <xs:element name="SortKey" type="xs:long" minOccurs="0"/>
         <xs:element name="Hashtags" type="t:ArrayOfStringsType" minOccurs="0"/>
        <xs:element name="Mentions" type="t:ArrayOfRecipientsType" minOccurs="0"/>
        <xs:element name="MentionedMe" type="xs:boolean" minOccurs="0"/>
        <xs:element name="PendingSocialActivityTagIds" type="t:ArrayOfStringsType" minOccurs="0"/>
     </xs:sequence>
 </xs:complexType>

The following table lists and describes the child elements of the ItemType complex type.

Element name

Type

Description

MimeContent

t:MimeContentType (section 2.2.4.28)

Specifies an instance of the MimeContentType complex type that contains the native MIME stream of an object that is represented in base64 encoding.

This element is only applicable to PostItemType, MessageType, and CalendarItemType object when setting MIME content for an item, or an ErrorUnsupportedMimeConversion ([MS-OXWSCDATA] section 2.2.5.24) will be returned. This element is applicable for all item objects when retrieving MIME content.<52>

ItemId

t:ItemIdType (section 2.2.4.25)

Specifies an instance of the ItemIdType complex type that represents the unique identifier and specific version of an item in the server data store.

This element is read-only and can be returned by the server but if specified in a CreateItem or UpdateItem request, an ErrorInvalidPropertySet ([MS-OXWSCDATA] section 2.2.5.24) will be returned.

ParentFolderId

t:FolderIdType ([MS-OXWSCDATA] section 2.2.4.35)

Specifies an instance of the FolderIdType complex type that represents the identifier of the parent folder that contains an item or folder.

This element is read-only and can be returned by the server but if specified in a CreateItem or UpdateItem request, an ErrorInvalidPropertySet ([MS-OXWSCDATA] section 2.2.5.24) will be returned.

ItemClass

t:ItemClassType (section 2.2.5.4)

Specifies a string value that indicates the message class of an item. This value is "IPM.Contact" for contact item, "IPM.Appointment" for calendar item, "IPM.Post" for post item, "IPM.Task" for task item and "IPM.DistList" for distribution list item. If invalid values are set for these items in the CreateItem request, an ErrorObjectTypeChanged ([MS-OXWSCDATA] section 2.2.5.24) response code will be returned in the CreateItem response.

Subject

xs:string [XMLSCHEMA2]

Specifies a string value that represents the subject property of items. This value is limited to 255 characters. If the calendar item is a room mailbox, the Subject element contains the organizer's name.

Sensitivity

t:SensitivityChoicesType ([MS-OXWSCDATA] section 2.2.5.25)

Specifies one of the valid SensitivityChoicesType simple type enumeration values that indicate the sensitivity level of an item.

Body

t:BodyType ([MS-OXWSCDATA] section 2.2.4.19)

Specifies the body content and body content format of an item.

Attachments

t:NonEmptyArrayOfAttachmentsType ([MS-OXWSCDATA] section 2.2.4.47)

Specifies an array of items or files that are attached to an item.<53>

DateTimeReceived

xs:dateTime [XMLSCHEMA2]

Specifies the date and time that an item was received in a mailbox.

This element is read-only and can be returned by the server but if specified in a CreateItem or UpdateItem request, an ErrorInvalidPropertySet ([MS-OXWSCDATA] section 2.2.5.24) will be returned.

Size

xs:int [XMLSCHEMA2]

Specifies an integer value that represents the size of an item, in bytes.

This element is read-only and can be returned by the server but if specified in a CreateItem or UpdateItem request, an ErrorInvalidPropertySet ([MS-OXWSCDATA] section 2.2.5.24) will be returned.

Categories

t:ArrayOfStringsType ([MS-OXWSCDATA] section 2.2.4.13)

Specifies a string array that identifies the categories to which an item in a mailbox belongs.

Importance

t:ImportanceChoicesType (section 2.2.5.3)

Specifies one of the valid ImportanceChoicesType values to indicate the importance of an item.

InReplyTo

xs:string

Specifies a string value that contains the identifier of the item to which this item is a reply.

IsSubmitted

xs:boolean [XMLSCHEMA2]

Specifies a Boolean value that indicates whether an item has been submitted to the folder which is used for submission. Such as Outbox folder or Drafts folder.

IsDraft

xs:boolean

Specifies a Boolean value that indicates whether an item has been sent.

IsFromMe

xs:boolean

Specifies a Boolean value that indicates whether a user sent an item to himself or herself.

IsResend

xs:boolean

Specifies a Boolean value that indicates whether an item has previously been sent.

IsUnmodified

xs:boolean

Specifies a Boolean value that indicates whether an item has been modified.

InternetMessageHeaders

t:NonEmptyArrayOfInternetHeadersType (section 2.2.4.32)

Specifies an array of the type InternetHeaderType ([MS-OXWSCDATA] section 2.2.4.39) that represents the collection of all Internet message headers, as described in [RFC2822] section 2.2, that are contained in an item in a mailbox. It can only be retrieved by GetItem (section 3.1.4.4) operation.

DateTimeSent

xs:dateTime

Specifies the date and time when an item in a mailbox was sent.

This element is read-only and can be returned by the server but if specified in a CreateItem or UpdateItem request, an ErrorInvalidPropertySet ([MS-OXWSCDATA] section 2.2.5.24) will be returned.

DateTimeCreated

xs:dateTime

Specifies the date and time when an item in a mailbox was created.

This element is read-only and can be returned by the server but if specified in a CreateItem or UpdateItem request, an ErrorInvalidPropertySet ([MS-OXWSCDATA] section 2.2.5.24) will be returned.

ResponseObjects

t:NonEmptyArrayOfResponseObjectsType (section 2.2.4.33)

Specifies an array of type ResponseObjectType ([MS-OXWSCDATA] section 2.2.4.67) that contains a collection of all the response objects that represent the applicable actions for an item.

ReminderDueBy

xs:dateTime

Specifies an instance of the dateTime structure that represents the date and time when an event is to occur. This is used by the ReminderMinutesBeforeStart element (as specified below) to determine when the reminder is displayed.

ReminderIsSet

xs:boolean

Specifies a Boolean value that indicates whether a reminder has been set for an item.

ReminderNextTime

xs:dateTime

Specifies the date and time for the next reminder.<54>

ReminderMinutesBeforeStart

t:ReminderMinutesBeforeStartType (section 2.2.5.5)

Specifies an int value that indicates the number of minutes before an event occurs when a reminder is displayed.

DisplayCc

xs:string

Specifies the display string that is used for the contents of the Cc box. This is the concatenated string of all carbon copy (Cc) recipient display names, separated by "; ".

DisplayTo

xs:string

Specifies the display string that is used for the contents of the To box. This is the concatenated string of all To recipient display names, separated by "; ".

This element is read-only and can be returned by the server but if specified in a CreateItem or UpdateItem request, an ErrorInvalidPropertySet ([MS-OXWSCDATA] section 2.2.5.24) will be returned.

HasAttachments

xs:boolean

Specifies a Boolean value that indicates whether an item has at least one attachment.

ExtendedProperty

t:ExtendedPropertyType ([MS-OXWSXPROP] section 2.1.5)

Specifies an array of ExtendedPropertyType elements that identify extended Messaging Application Programming Interface (MAPI) properties.

Culture

xs:language ([XMLSCHEMA2])

Specifies the culture for an item in a mailbox.

EffectiveRights

t:EffectiveRightsType ([MS-OXWSCDATA] section 2.2.4.29)

Specifies an EffectiveRightsType element that represents the client's rights based on the permission settings for an item or folder.

This element is read-only and can be returned by the server but if specified in a CreateItem or UpdateItem request, an ErrorInvalidPropertySet ([MS-OXWSCDATA] section 2.2.5.24) will be returned.

LastModifiedName

xs:string

Specifies a string value that contains the name of the user who last modified an item.

This element is read-only and can be returned by the server but if specified in a CreateItem or UpdateItem request, an ErrorInvalidPropertySet ([MS-OXWSCDATA] section 2.2.5.24) will be returned.

LastModifiedTime

xs:dateTime

Specifies an instance of the dateTime

IsAssociated

xs:boolean

Specifies a value that indicates whether the item is associated with a folder.<55>

WebClientReadFormQueryString

xs:string

Specifies a query string that identifies a read form accessible by using a Web browser.<56> It is read-only for client.

This element is read-only and can be returned by the server but if specified in a CreateItem or UpdateItem request, an ErrorInvalidPropertySet ([MS-OXWSCDATA] section 2.2.5.24) will be returned.

WebClientEditFormQueryString

xs:string

MAY specify a query string that identifies an edit form accessible by using a Web browser.<57> It is read-only for client.

ConversationId

t:ItemIdType

Specifies the ID of the conversation that an item is part of.<58> For more information on conversations, see [MS-OXWSCONV].

UniqueBody

t:BodyType ([MS-OXWSCDATA] section 2.2.4.19)

Specifies the body part that is unique to the conversation that an item is part of.<59>  For more information on conversations, see [MS-OXWSCONV].

Flag

t:FlagType (section 2.2.4.23)

Specifies a flag indicating status, start date, due date or completion date for an item .<60>

StoreEntryId

xs:base64Binary ([XMLSCHEMA2])

Specifies the entry ID of the store that hosts an item. This element SHOULD<61> be included. It is read-only for the client and will be ignored by the server.<62>

InstanceKey

xs:base64Binary

Specifies the key for an instance.<63>

This element is read-only and can be returned by the server but if specified in a CreateItem or UpdateItem request, an ErrorInvalidPropertySet ([MS-OXWSCDATA] section 2.2.5.24) will be returned.

NormalizedBody

t:BodyType ([MS-OXWSCDATA] section 2.2.4.19)

Specifies the version of the body of a message visible in the preview pane when accessing a message over the Internet.<64>

This element is read-only and can be returned by the server but if specified in a CreateItem or UpdateItem request, an ErrorInvalidPropertySet ([MS-OXWSCDATA] section 2.2.5.24) will be returned.

EntityExtractionResult

t:EntityExtractionResultType (section 2.2.4.21)

Specifies the result of an entity extraction .<65>

PolicyTag

t:RetentionTagType ([MS-OXWSURPT] section 2.2.4.1)

Specifies the retention policy for the item.<66>

ArchiveTag

t:RetentionTagType

Specifies an archive tag.<67>

RetentionDate

xs:dateTime

Specifies the retention date for an item.<68>

Preview

xs:string

Specifies the first 256 characters of the body of a message for preview without opening the message.<69>

This element is read-only and can be returned by the server but if specified in a CreateItem or UpdateItem request, an ErrorInvalidPropertySet ([MS-OXWSCDATA] section 2.2.5.24) will be returned.

RightsManagementLicenseData

t:RightsManagementLicenseDataType (section 2.2.4.42)

Specifies rights management license data.<70>

This element is read-only and can be returned by the server but if specified in a CreateItem or UpdateItem request, an ErrorInvalidPropertySet ([MS-OXWSCDATA] section 2.2.5.24) will be returned.

NextPredictedAction

t:PredictedMessageActionType ([MS-OXWSCDATA] section 2.2.5.22)

Specifies the next predicted action for the item.<71>

GroupingAction

t:PredictedMessageActionType

Specifies that the next predicted action is grouping items.<72>

This element is read-only and can be returned by the server.

PredictedActionReasons

t:NonEmptyArrayOfPredictedActionReasonType

Intended for internal use only.<73>

IsClutter

xs:boolean

<74>Intended for internal use only.

BlockStatus

xs:boolean

Indicates whether images are blocked.<75>

This element is read-only and can be returned by the server but if specified in a CreateItem request, an ErrorInvalidPropertySet ([MS-OXWSCDATA] section 2.2.5.24) will be returned.

HasBlockedImages

xs:boolean

Indicates whether the item has blocked images.<76>

TextBody

t:BodyType

Specifies the text body of the item.<77>

This element is read-only and can be returned by the server but if specified in a CreateItem or UpdateItem request, an ErrorInvalidPropertySet ([MS-OXWSCDATA] section 2.2.5.24) will be returned.

IconIndex

t:IconIndexType ([MS-OXWSCDATA] section 2.2.5.16)

Specifies the index of the icon for the item.<78>

This element is read-only and can be returned by the server but if specified in a CreateItem or UpdateItem request, an ErrorInvalidPropertySet ([MS-OXWSCDATA] section 2.2.5.24) will be returned.

MimeContentUTF8

t:MimeContentUTF8Type (section 2.2.4.29)

Specifies an instance of the MimeContentUTF8Type complex type that contains the native MIME stream of an object that is represented in UTF-8.<79>

SearchKey

xs:base64Binary

Specifies a search key.<80>

SortKey

xs:long ([XMLSCHEMA2])

Specifies a sort key.<81>

Hashtags

t:ArrayOfStringsType

Specifies hashtags.<82>

Mentions

t:ArrayOfRecipientsType

Specifies mentions.<83>

MentionedMe

xs:boolean

Specifies whether the mention applies to the mailbox owner.<84>

PendingSocialActivityTagIds

t:ArrayOfStringsType

Specifies tag ids to track draft social activity tags.<85>