Inbox
Create, update, delete, and query Inbox items.
Table Specific Information
Select Emails from Inbox Subfolders
When performing a SELECT operation on the Inbox table, the provider will not include the items in the subfolders under Inbox, but only the items contained within the Inbox folder.
If you wish to retrieve the items under the Inbox subfolders, your will need to specify the ParentFolderId-s in the WHERE clause. You can get every Inbox subfolder Id by executing a filtered by ParentFolderName query to the Folders table. You can use the example query below, to retrieve the items within the Inbox subfolders:
SELECT * FROM Inbox WHERE ParentFolderId IN (SELECT FolderId FROM Folders WHERE ParentFolderName = 'Inbox' AND TotalCount > 0)
Update and Delete
The provider will need the ItemChangeKey to update or delete an item. However, if you are unsure of the ItemChangeKey, the provider is able to retrieve it from the Exchange server automatically. Note that this may increase the time it takes to perform a query.
Columns
Name | Type | ReadOnly | Description |
ItemId [KEY] | String | True |
Contains the unique identifier of an item in the Exchange store. |
MimeContent | String | True |
Contains the native Multipurpose Internet Mail Extensions (MIME) stream of an object that is represented in Base64 binary format. |
ItemChangeKey | String | True |
Contains the unique change key of an item in the Exchange store. |
ParentFolderId | String | False |
Represents the unique identifier of the parent folder that contains the item or folder. |
ParentFolderChangeKey | String | True |
Represents the unique change key of the parent folder that contains the item or folder. |
ItemClass | String | False |
Represents the message class of an item. |
Subject | String | False |
Represents the subject for Exchange store items and response objects. The subject is limited to 255 characters. |
Sensitivity | String | True |
Indicates the sensitivity level of an item. |
Body | String | False |
Represents the actual body content of a message. |
DateTimeReceived | Datetime | True |
Represents the date and time that an item in a mailbox was received. |
Size | Integer | True |
Represents the size in bytes of an item. This property is read-only. |
Categories | String | False |
Represents a collection of strings that identify to which categories an item in the mailbox belongs. |
Importance | String | False |
Describes the importance of an item. |
InReplyTo | String | False |
Represents the identifier of the item to which this item is a reply. |
IsSubmitted | Boolean | True |
Indicates whether an item has been submitted to the Outbox default folder. |
IsDraft | Boolean | True |
Represents whether an item has not yet been sent. |
IsFromMe | Boolean | True |
Indicates whether a user sent an item to himself or herself. |
IsResend | Boolean | True |
Indicates whether the item had previously been sent. |
IsUnmodified | Boolean | True |
Indicates whether the item has been modified. |
InternetMessageHeaders | String | True |
Represents the collection of all Internet message headers that are contained within an item in a mailbox. |
DateTimeSent | Datetime | True |
Represents the date and time that an item in a mailbox was sent. |
DateTimeCreated | Datetime | True |
Represents the date and time that a given item in the mailbox was created. |
ReminderDueBy | Datetime | False |
Represents the date and time when the event occurs. This is used by the ReminderMinutesBeforeStart element to determine when the reminder is displayed. |
ReminderIsSet | Boolean | False |
Indicates whether a reminder has been set for an item in the Exchange store. |
ReminderMinutesBeforeStart | Integer | False |
Represents the number of minutes before an event occurs when a reminder is displayed. |
DisplayCc | String | True |
Represents the display string that is used for the contents of the To box. This is the concatenated string of all To recipient display names. |
DisplayTo | String | True |
Represents a property that is set to true if an item has at least one visible attachment. This property is read-only. |
HasAttachments | Boolean | True |
Indicates whether an item has attachments. |
Culture | String | False |
Represents the Culture of an item. |
SenderName | String | False |
Defines the name of the Sender mailbox user. |
SenderEmailAddress | String | False |
Defines the Simple Mail Transfer Protocol (SMTP) address of the Sender mailbox user. |
SenderRoutingType | String | False |
Defines the routing that is used for the Sender mailbox. The default is SMTP. |
ToRecipients_Names | String | False |
Defines the name of the ToRecipient. |
ToRecipients_EmailAddresses | String | False |
Defines the Simple Mail Transfer Protocol (SMTP) address of the ToRecipient. |
ToRecipients_ItemIds | String | False |
Defines the item identifier of a ToRecipient. |
CcRecipients_Names | String | False |
Defines the name of the CcRecipient. |
CcRecipients_EmailAddresses | String | False |
Defines the Simple Mail Transfer Protocol (SMTP) address of the CcRecipient. |
CcRecipients_ItemIds | String | False |
Defines the item identifier of a CcRecipient. |
BccRecipients_Name | String | False |
Defines the name of the BccRecipient. |
BccRecipients_EmailAddress | String | False |
Defines the Simple Mail Transfer Protocol (SMTP) address of the BccRecipient. |
BccRecipients_ItemId | String | False |
Defines the item identifier of a BccRecipient. |
IsReadReceiptRequested | Boolean | False |
Indicates whether the sender of an item requests a read receipt. |
IsDeliveryReceiptRequested | Boolean | False |
Indicates whether the sender of an item requests a delivery receipt. |
ConversationIndex | String | False |
Contains a binary Id that represents the thread to which this message belongs. |
ConversationTopic | String | False |
Represents the conversation topic. |
FromName | String | False |
Defines the name of the From mailbox user. |
FromEmailAddress | String | False |
Defines the Simple Mail Transfer Protocol (SMTP) address of the From mailbox user. |
FromRoutingType | String | False |
Defines the routing that is used for the From mailbox. The default is SMTP. |
InternetMessageId | String | False |
Represents the Internet message identifier of an item. |
IsRead | Boolean | False |
Indicates whether a message has been read. |
IsResponseRequested | Boolean | False |
Indicates whether a response to an item is requested. |
References | String | False |
Represents the Usenet header that is used to associate replies with the original messages. |
EffectiveRights_CreateAssociated | Boolean | True |
Indicates whether a client can create an associated contents table. |
EffectiveRights_CreateContents | Boolean | True |
Indicates whether a client can create a contents table. |
EffectiveRights_CreateHierarchy | Boolean | True |
Indicates whether a client can create a hierarchy table. |
EffectiveRights_Delete | Boolean | True |
Indicates whether a client can delete a folder or item. |
EffectiveRights_Modify | Boolean | True |
Indicates whether a client can modify a folder or item. |
EffectiveRights_Read | Boolean | True |
Indicates whether a client can read a folder or item. |
EffectiveRights_ViewPrivateItems | Boolean | True |
Indicates whether a private item can be viewed. |
ReceivedByName | String | False |
Defines the name of the ReceivedBy mailbox user. |
ReceivedByEmailAddress | String | False |
Defines the Simple Mail Transfer Protocol (SMTP) address of the ReceivedBy mailbox user. |
ReceivedByRoutingType | String | False |
Defines the routing that is used for the ReceivedBy mailbox. The default is SMTP. |
ReceivedRepresentingName | String | False |
Defines the name of the ReceivedRepresenting mailbox user. |
ReceivedRepresentingEmailAddress | String | False |
Defines the Simple Mail Transfer Protocol (SMTP) address of the ReceivedRepresenting mailbox user. |
ReceivedRepresentingRoutingType | String | False |
Defines the routing that is used for the ReceivedRepresenting mailbox. The default is SMTP. |
LastModifiedName | String | True |
Contains the display name of the last user to modify an item. |
LastModifiedTime | Datetime | True |
Indicates when an item was last modified. This element is read-only. |
IsAssociated | Boolean | False |
Indicates whether the item is associated with a folder. |
WebClientReadFormQueryString | String | True |
Represents a URL to concatenate to the Microsoft Office Outlook Web App endpoint to read an item in Outlook Web App. |
WebClientEditFormQueryString | String | True |
Represents a URL to concatenate to the Outlook Web App endpoint to edit an item in Outlook Web App. |
ConversationId | String | True |
Identifies a specific conversation in the Exchange store. |
ConversationChangeKey | String | True |
Contains the change key of an item or conversation. |
UniqueBody | String | True |
Represents an HTML fragment or plain-text which represents the unique body of this conversation. |
UniqueBodyType | String | True |
Describes how the unique item body is stored in the item (HTML or TEXT). |
ReminderMessageData_Text | String | False |
Specifies the text of a reminder message. |
ReminderMessageData_Location | String | False |
Represents the location of a meeting, appointment, or persona. |
ReminderMessageData_StartTime | Datetime | False |
Specifies the starting time of the item that the reminder is for. |
ReminderMessageData_EndTime | Datetime | False |
Specifies the ending time of the item that the reminder is for. |
ReminderMessageData_AssociatedCalendarId | String | True |
Represents the calendar item that is associated with the ReminderMessageData. |
Attachments | String | True |
Contains a comma-separated list of the Ids of the attached files. |
Pseudo-Columns
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
ImpersonationUser | String |
The Identifier of the user to impersonate. |
ImpersonationType | String |
The type of Identifier used for the impersonation user (PrincipalName, SID, PrimarySmtpAddress, SmtpAddress). |
SharedMailboxEmail | String |
The email of a shared mailbox. Use this to retrieve the inbox items of a shared mailbox. |