mailbox EntityType
- Entity set path:
- [organization URI]/api/data/v9.2/mailboxes
- Base type:
- crmbaseentity
- Table type:
- Standard
- Display name:
- Mailbox
- Primary key:
- mailboxid
- Primary name column:
- name
- Operations supported:
- POST GET PATCH DELETE
Properties
Properties represent fields of data stored in the entity. Some properties are read-only.
| Name | Type | Details | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| actdeliverymethod | Edm.Int32 |
Choose the delivery method for the mailbox for appointments, contacts, and tasks. Display name: Appointments, Contacts, and Tasks
Default options
|
||||||||||||
| actstatus | Edm.Int32 |
Status of the Appointments, Contacts, and Tasks. Display name: Appointments, Contacts, and Tasks Status
Default options
|
||||||||||||
| allowemailconnectortousecredentials | Edm.Boolean |
Choose whether to allow the email connector to use credentials. Display name: Allow to Use Credentials for Email Processing
Default options
|
||||||||||||
| averagetotalduration | Edm.Int32 |
Mailbox Total Duration in Average Display name: Monitor Total Performance Read only
|
||||||||||||
| createdon | Edm.DateTimeOffset |
Shows the date and time when the record was created. The date and time are displayed in the time zone selected in Microsoft Dynamics 365 options. Display name: Created On Read only
|
||||||||||||
| emailaddress | Edm.String |
Type the email address of the mailbox. Display name: Email Address |
||||||||||||
| emailrouteraccessapproval | Edm.Int32 |
Shows the status of the email address. Display name: Email Address Status
Default options
|
||||||||||||
| enabledforact | Edm.Boolean |
Indicates whether the mailbox is enabled for Appointments, Contacts, and Tasks. Display name: Enabled For Appointments, Contacts, And Tasks
Default options
|
||||||||||||
| enabledforincomingemail | Edm.Boolean |
Choose whether the mailbox is enabled for receiving email. Display name: Enabled For Incoming Email
Default options
|
||||||||||||
| enabledforoutgoingemail | Edm.Boolean |
Choose whether the mailbox is enabled for sending email. Display name: Enabled For Outgoing Email
Default options
|
||||||||||||
| entityimage | Edm.Binary |
The default image for the entity. Display name: Entity Image |
||||||||||||
| entityimage_timestamp | Edm.Int64 |
Read only
|
||||||||||||
| entityimage_url | Edm.String |
Read only
|
||||||||||||
| entityimageid | Edm.Guid |
For internal use only. Display name: Entity Image Id Read only
|
||||||||||||
| ewsurl | Edm.String |
Exchange web services endpoint URL for the mailbox. Display name: Exchange Web Services URL |
||||||||||||
| exchangecontactsimportcompletedon | Edm.DateTimeOffset |
Date and time when the exchange contacts import was last completed for a mailbox record. Display name: Exchange Contacts Import Completed On Read only
|
||||||||||||
| exchangecontactsimportstatus | Edm.Int32 |
Indicates the exchange contacts import status for a mailbox record. Display name: Exchange Contacts Import Status
Default options
|
||||||||||||
| exchangesyncstatexml | Edm.String |
Contains the exchange synchronization state in XML format. Display name: Exchange Sync State |
||||||||||||
| exchangesyncstatexmlfileref | Edm.Binary |
Reference to the ExchangeSyncStateXml file on Azure. Display name: ExchangeSyncStateXml File Ref Read only
|
||||||||||||
| exchangesyncstatexmlfileref_name | Edm.String |
Read only
|
||||||||||||
| folderhierarchy | Edm.String |
Holds the hierarchy of folders under inbox in XML format. Display name: Folder Hierarchy |
||||||||||||
| forcedunlockcount | Edm.Int32 |
For internal use only Display name: Count of the number of times a mailbox gets forced unlocked Read only
|
||||||||||||
| hostid | Edm.String |
Unique identifier of the async host that is processing this mailbox. Display name: Host Read only
|
||||||||||||
| incomingemaildeliverymethod | Edm.Int32 |
Select how incoming email will be delivered to the mailbox. Display name: Incoming Email
Default options
|
||||||||||||
| incomingemailstatus | Edm.Int32 |
Select the status that will be assigned to incoming email messages. Display name: Incoming Email Status
Default options
|
||||||||||||
| isactsyncorgflagset | Edm.Boolean |
Set the current organization as the synchronization organization. Display name: Set Current Organization as Synchronization Organization
Default options
|
||||||||||||
| isemailaddressapprovedbyo365admin | Edm.Boolean |
Shows the status of approval of the email address by O365 Admin. Display name: Email Address O365 Admin Approval Status
Default options
|
||||||||||||
| isexchangecontactsimportscheduled | Edm.Boolean |
Is Exchange Contacts Import Scheduled. Display name: Is Exchange Contacts Import Scheduled. Read only
Default options
|
||||||||||||
| isforwardmailbox | Edm.Boolean |
Select whether the mailbox is a forward mailbox. Display name: Is Forward Mailbox Read only
Default options
|
||||||||||||
| isoauthaccesstokenset | Edm.Boolean |
Read only
Default options
|
||||||||||||
| isoauthrefreshtokenset | Edm.Boolean |
Read only
Default options
|
||||||||||||
| ispasswordset | Edm.Boolean |
Read only
Default options
|
||||||||||||
| isserviceaccount | Edm.Boolean |
Select whether the mailbox corresponds to one for the service account. Display name: Is Service Account Read only
Default options
|
||||||||||||
| itemsfailedforlastsync | Edm.Int32 |
For internal use only. Display name: Items Failed For Last Sync |
||||||||||||
| itemsprocessedforlastsync | Edm.Int32 |
For internal use only. Display name: Items Processed For Last Sync |
||||||||||||
| lastautodiscoveredon | Edm.DateTimeOffset |
Shows the date and time when the Exchange web services URL was last discovered using the AutoDiscover service. Display name: Last Auto Discovered On |
||||||||||||
| lastduration | Edm.Int32 |
Last Duration for the mailbox Display name: Monitor last duration Performance Read only
|
||||||||||||
| lastmailboxforcedunlockoccurredon | Edm.DateTimeOffset |
For internal use only. Display name: Last Date Time when a mailbox got forced unlocked Read only
|
||||||||||||
| lastmessageid | Edm.String |
Unique identifier of the last message. Display name: Last Message ID |
||||||||||||
| lastsuccessfulsynccompletedon | Edm.DateTimeOffset |
Last Successful Sync Time Display name: Last Successful Sync Time |
||||||||||||
| lastsyncerror | Edm.String |
For internal use only. Display name: Last Sync Error Stack |
||||||||||||
| lastsyncerrorcode | Edm.Int32 |
For internal use only. Display name: Last Sync Error Code |
||||||||||||
| lastsyncerrorcount | Edm.Int32 |
For internal use only Display name: Last Sync Error Continuous Count |
||||||||||||
| lastsyncerrormachinename | Edm.String |
For internal use only. Display name: Last Sync Error Machine Name |
||||||||||||
| lastsyncerroroccurredon | Edm.DateTimeOffset |
For internal use only. Display name: Last Sync Error Time |
||||||||||||
| lastsyncstartedon | Edm.DateTimeOffset |
Last Sync Start Time Display name: Last Sync Start Time Read only
|
||||||||||||
| lasttagcompletedon | Edm.DateTimeOffset |
Identifies the timestamp when tagging last completed. For internal use only. Display name: Last Tag Completed On |
||||||||||||
| lasttaggedmessageid | Edm.String |
Identifies the last MessageId that has been processed for tagging in the remote system. Display name: Last Tagged MessageId |
||||||||||||
| lasttagprocessedmaxitems | Edm.Boolean |
Indicates if the last tagging cycle processed the maximum number of items. For internal use only. Display name: Last Tag Processed Max Items
Default options
|
||||||||||||
| mailboxid | Edm.Guid |
Unique identifier of the mailbox. Display name: Mailbox |
||||||||||||
| mailboxprocessingcontext | Edm.Int32 |
For internal use only. Display name: Processing Context of the Mailbox |
||||||||||||
| mailboxstatus | Edm.Int32 |
Last Sync Status for Outgoing, Incoming and ACT as a whole. Display name: Mailbox Status Read only
Default options
|
||||||||||||
| modifiedon | Edm.DateTimeOffset |
Shows the date and time when the record was last updated. The date and time are displayed in the time zone selected in Microsoft Dynamics 365 options. Display name: Modified On Read only
|
||||||||||||
| name | Edm.String |
Type the name of the mailbox. Display name: Name |
||||||||||||
| nextscheduledactsyncinseconds | Edm.Int32 |
The next scheduled ACT sync delay, in seconds, to apply to the mailbox. Display name: Next Scheduled ACT Sync Delay In Seconds Read only
|
||||||||||||
| noactcount | Edm.Int32 |
For internal use only. Display name: Zero appointment, contact, task count for mailbox Read only
|
||||||||||||
| noemailcount | Edm.Int32 |
For internal use only. Display name: Zero email count for mailbox Read only
|
||||||||||||
| oauthaccesstoken | Edm.String |
Type the Oauth access token for the mailbox. Display name: Oauth access token |
||||||||||||
| oauthrefreshtoken | Edm.String |
Type the Oauth refresh token for the mailbox. Display name: Oauth refresh token |
||||||||||||
| oauthtokenexpireson | Edm.DateTimeOffset |
Date and time when the Oauth token will expire Display name: Oauth token expiration datetime |
||||||||||||
| officeappsdeploymentcompleteon | Edm.DateTimeOffset |
Date and time when the last office apps deployment was completed for a mailbox record. Display name: Office Apps Deployment Completed On Read only
|
||||||||||||
| officeappsdeploymenterror | Edm.String |
The Office Apps deployment error. Display name: Office Apps Deployment Error Read only
|
||||||||||||
| officeappsdeploymentscheduled | Edm.Boolean |
Indicates if the office apps deployment has been scheduled for a mailbox record. Display name: Office Apps Deployment Scheduled
Default options
|
||||||||||||
| officeappsdeploymentstatus | Edm.Int32 |
Indicates the office apps deployment type for a mailbox record. Display name: Office Apps Deployment Type
Default options
|
||||||||||||
| orgmarkedasprimaryforexchangesync | Edm.Boolean |
Indicates if the crm org is to be marked as primary syncing org for the mailbox record. Display name: Crm Org Marked as Primary Org for Exchange Mailbox
Default options
|
||||||||||||
| outgoingemaildeliverymethod | Edm.Int32 |
Select how outgoing email will be sent from the mailbox. Display name: Outgoing Email
Default options
|
||||||||||||
| outgoingemailstatus | Edm.Int32 |
Select the status of outgoing email messages. Display name: Outgoing Email Status
Default options
|
||||||||||||
| password | Edm.String |
Type the password for the mailbox. Display name: Password |
||||||||||||
| postponemailboxprocessinguntil | Edm.DateTimeOffset |
Shows the date and time when processing will begin on this mailbox. Display name: Postpone Mailbox Processing Until |
||||||||||||
| postponeofficeappsdeploymentuntil | Edm.DateTimeOffset |
Shows the date and time when the next outlook mail app install will be run for a mailbox record. Display name: Postpone Outlook Mail App Install Until |
||||||||||||
| postponesendinguntil | Edm.DateTimeOffset |
Shows the date and time when the mailbox can start sending emails. Display name: Postpone Sending Until |
||||||||||||
| postponetestemailconfigurationuntil | Edm.DateTimeOffset |
Shows the date and time when the next email configuration test will be run for a mailbox record. Display name: Postpone Test Email Configuration Until |
||||||||||||
| processanddeleteemails | Edm.Boolean |
Select whether to delete emails from the mailbox after processing. Display name: Delete Emails after Processing
Default options
|
||||||||||||
| processedtimes | Edm.Int32 |
The number of times mailbox has processed Display name: Monitor Performance Read only
|
||||||||||||
| processemailreceivedafter | Edm.DateTimeOffset |
Shows the date and time to start processing email received by the mailbox. Display name: Process Email Received After |
||||||||||||
| processinglastattemptedon | Edm.DateTimeOffset |
Date and time when the processing of the mailbox was last attempted. Display name: Date Processing Last Attempted |
||||||||||||
| processingstatecode | Edm.Int32 |
Information that indicates whether email will be processed for this mailbox Display name: Mailbox Processing State Read only
|
||||||||||||
| receivingpostponeduntil | Edm.DateTimeOffset |
For internal use only. Display name: Postpone receiving emails for the mailbox until the specified data and time. Read only
|
||||||||||||
| receivingpostponeduntilforact | Edm.DateTimeOffset |
For internal use only. Display name: Postpone processing Appointments, Contacts, and Tasks for the mailbox until the specified data and time. Read only
|
||||||||||||
| statecode | Edm.Int32 |
Shows whether the mailbox is active or inactive. Display name: Status
Default options
|
||||||||||||
| statuscode | Edm.Int32 |
Select the mailbox's status. Display name: Status Reason
Default options
|
||||||||||||
| tagemailsafter | Edm.DateTimeOffset |
Identifies the timestamp after for which emails should be tagged in the remote system. Display name: Tag Emails After |
||||||||||||
| testemailconfigurationretrycount | Edm.Int32 |
Shows the number of times an email configuration test has been performed. Display name: Test Email Configuration Retry Count |
||||||||||||
| testemailconfigurationscheduled | Edm.Boolean |
Indicates if the email configuration test has been scheduled for a mailbox record. Display name: Test Email Configuration Scheduled
Default options
|
||||||||||||
| testmailboxaccesscompletedon | Edm.DateTimeOffset |
Date and time when the last email configuration test was completed for a mailbox record. Display name: Mailbox Test Completed On |
||||||||||||
| timezoneruleversionnumber | Edm.Int32 |
For internal use only. Display name: Time Zone Rule Version Number |
||||||||||||
| transientfailurecount | Edm.Int32 |
Concatenation of transient failure counts of all mailbox operations. Display name: Transient Failure Count Read only
|
||||||||||||
| undeliverablefolder | Edm.String |
Shows the ID of the Undeliverable folder in the mailbox managed by Microsoft Exchange. Display name: Undeliverable Folder |
||||||||||||
| username | Edm.String |
Type a user name used for mailbox authentication. Display name: User Name |
||||||||||||
| utcconversiontimezonecode | Edm.Int32 |
Time zone code that was in use when the record was created. Display name: UTC Conversion Time Zone Code |
||||||||||||
| verboseloggingenabled | Edm.Int32 |
Indicates if verbose tracing needs to be enabled for this mailbox. Display name: Verbose Logging |
||||||||||||
| versionnumber | Edm.Int64 |
Version number of the mailbox. Display name: Version Number Read only
|
Lookup properties
Lookup properties are read-only, computed properties which contain entity primary key Edm.Guid data for one or more corresponding single-valued navigation properties. More information: Lookup properties and Lookup property data.
| Name | Single-valued navigation property | Description |
|---|---|---|
| _createdby_value | createdby |
Shows who created the record. |
| _createdonbehalfby_value | createdonbehalfby |
Shows who created the record on behalf of another user. |
| _emailserverprofile_value | emailserverprofile |
Select the email server profile of the mailbox. |
| _modifiedby_value | modifiedby |
Shows who last updated the record. |
| _modifiedonbehalfby_value | modifiedonbehalfby |
Shows who last updated the record on behalf of another user. |
| _organizationid_value | organizationid |
Unique identifier of the organization associated with the record. |
| _ownerid_value | ownerid |
Enter the user or team who is assigned to manage the record. This field is updated every time the record is assigned to a different user. |
| _owningbusinessunit_value | owningbusinessunit |
Select the business unit that owns the record. |
| _owningteam_value | owningteam |
Unique identifier for the team that owns the record. |
| _owninguser_value | owninguser |
Unique identifier for the user that owns the record. |
| _regardingobjectid_value | regardingobjectid regardingobjectid_queue |
Choose the user associated to the mailbox. |
Single-valued navigation properties
Single-valued navigation properties represent lookup fields where a single entity can be referenced. Each single-valued navigation property has a corresponding partner collection-valued navigation property on the related entity.
| Name | Type | Partner |
|---|---|---|
| createdby | systemuser | lk_mailbox_createdby |
| createdonbehalfby | systemuser | lk_mailbox_createdonbehalfby |
| emailserverprofile | emailserverprofile | emailserverprofile_mailbox |
| modifiedby | systemuser | lk_mailbox_modifiedby |
| modifiedonbehalfby | systemuser | lk_mailbox_modifiedonbehalfby |
| organizationid | organization | organization_mailbox |
| ownerid | principal | owner_mailbox |
| owningbusinessunit | businessunit | business_unit_mailbox |
| owningteam | team | team_mailbox |
| owninguser | systemuser | user_mailbox |
| regardingobjectid | systemuser | mailbox_regarding_systemuser |
| regardingobjectid_queue | queue | mailbox_regarding_queue |
Collection-valued navigation properties
Collection-valued navigation properties represent collections of entities which may represent either a one-to-many (1:N) or many-to-many (N:N) relationship between the entities.
| Name | Type | Partner |
|---|---|---|
| activitypointer_sendermailboxid_mailbox | activitypointer | sendermailboxid |
| adx_inviteredemption_mailbox_sendermailboxid | adx_inviteredemption | sendermailboxid_adx_inviteredemption |
| adx_portalcomment_mailbox_sendermailboxid | adx_portalcomment | sendermailboxid_adx_portalcomment |
| chat_mailbox_sendermailboxid | chat | sendermailboxid_chat |
| email_sendermailboxid_mailbox | sendermailboxid_email | |
| Mailbox_Annotation | annotation | objectid_mailbox |
| mailbox_asyncoperations | asyncoperation | regardingobjectid_mailbox |
| mailbox_email_ReceivingMailboxId | ReceivingMailboxId_Email | |
| mailbox_FileAttachments | fileattachment | objectid_mailbox |
| Mailbox_MailboxTrackingFolder | mailboxtrackingfolder | mailboxid |
| mailbox_processsessions | processsession | regardingobjectid_mailbox |
| Mailbox_SyncErrors | syncerror | regardingobjectid_mailbox_syncerror |
| queue_defaultmailbox_mailbox | queue | defaultmailbox |
| systemuser_defaultmailbox_mailbox | systemuser | defaultmailbox |
| tracelog_Mailbox | tracelog | regardingobjectid_mailbox |
Operations
The following operations can be used with the mailbox entity type.
| Name | Binding |
|---|---|
| GrantAccess | Not Bound |
| ModifyAccess | Not Bound |
| RetrievePrincipalAccess | Not Bound |
| RetrieveSharedPrincipalsAndAccess | Not Bound |
| RevokeAccess | Not Bound |