mailbox EntityType

Entity Set Path
[organization URI]/api/data/v9.0/mailboxes
Base Type
crmbaseentity
Display Name
Mailbox
Primary Key
mailboxid
Primary Key Attribute
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
Value Label
0 Microsoft Dynamics 365 for Outlook
1 Server-Side Synchronization
2 None
actstatus Edm.Int32

Status of the Appointments, Contacts, and Tasks.

Display Name: Appointments, Contacts, and Tasks Status

Default Options
Value Label
0 Not Run
1 Success
2 Failure
allowemailconnectortousecredentials Edm.Boolean

Choose whether to allow the email connector to use credentials.

Display Name: Allow to Use Credentials for Email Processing

Default Options
Value Label
1 Yes
0 No
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
Value Label
0 Empty
1 Approved
2 Pending Approval
3 Rejected
enabledforact Edm.Boolean

Indicates whether the mailbox is enabled for Appointments, Contacts, and Tasks.

Display Name: Enabled For Appointments, Contacts, And Tasks

Default Options
Value Label
1 Yes
0 No
enabledforincomingemail Edm.Boolean

Choose whether the mailbox is enabled for receiving email.

Display Name: Enabled For Incoming Email

Default Options
Value Label
1 Yes
0 No
enabledforoutgoingemail Edm.Boolean

Choose whether the mailbox is enabled for sending email.

Display Name: Enabled For Outgoing Email

Default Options
Value Label
1 Yes
0 No
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
Value Label
0 NotImported
1 Imported
2 ImportFailed
exchangesyncstatexml Edm.String

Contains the exchange synchronization state in XML format.

Display Name: Exchange Sync State

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
Value Label
0 None
1 Microsoft Dynamics 365 for Outlook
2 Server-Side Synchronization or Email Router
3 Forward Mailbox
incomingemailstatus Edm.Int32

Select the status that will be assigned to incoming email messages.

Display Name: Incoming Email Status

Default Options
Value Label
0 Not Run
1 Success
2 Failure
isactsyncorgflagset Edm.Boolean

Set the current organization as the synchronization organization.

Display Name: Set Current Organization as Synchronization Organization

Default Options
Value Label
1 Yes
0 No
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
Value Label
1 Yes
0 No
isexchangecontactsimportscheduled Edm.Boolean

Is Exchange Contacts Import Scheduled.

Display Name: Is Exchange Contacts Import Scheduled.

Read Only
Default Options
Value Label
1 Yes
0 No
isforwardmailbox Edm.Boolean

Select whether the mailbox is a forward mailbox.

Display Name: Is Forward Mailbox

Read Only
Default Options
Value Label
1 Yes
0 No
ispasswordset Edm.Boolean
Read Only
Default Options
Value Label
1 Yes
0 No
isserviceaccount Edm.Boolean

Select whether the mailbox corresponds to one for the service account.

Display Name: Is Service Account

Read Only
Default Options
Value Label
1 Yes
0 No
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
lastsuccessfulsynccompletedon Edm.DateTimeOffset

Last Successful Sync Time

Display Name: Last Successful Sync Time

Read Only
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
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
Value Label
0 Not Run
1 Success
2 Failure
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

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
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
Value Label
1 Yes
0 No
officeappsdeploymentstatus Edm.Int32

Indicates the office apps deployment type for a mailbox record.

Display Name: Office Apps Deployment Type

Default Options
Value Label
0 NotInstalled
1 Installed
2 InstallFailed
3 UninstallFailed
4 UpgradeRequired
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
Value Label
1 Yes
0 No
outgoingemaildeliverymethod Edm.Int32

Select how outgoing email will be sent from the mailbox.

Display Name: Outgoing Email

Default Options
Value Label
0 None
1 Microsoft Dynamics 365 for Outlook
2 Server-Side Synchronization or Email Router
outgoingemailstatus Edm.Int32

Select the status of outgoing email messages.

Display Name: Outgoing Email Status

Default Options
Value Label
0 Not Run
1 Success
2 Failure
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
Value Label
1 Yes
0 No
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

Read Only
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
Value Label
0 Active
1 Inactive
statuscode Edm.Int32

Select the mailbox's status.

Display Name: Status Reason

Default Options
Value Label
1 Active
2 Inactive
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
Value Label
1 Yes
0 No
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 Retrieve data about lookup properties.

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 regardingobjectidregardingobjectid_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
bulkoperation_mailbox_sendermailboxid bulkoperation sendermailboxid_bulkoperation
campaignactivity_mailbox_sendermailboxid campaignactivity sendermailboxid_campaignactivity
campaignresponse_mailbox_sendermailboxid campaignresponse sendermailboxid_campaignresponse
email_sendermailboxid_mailbox email sendermailboxid_email
incidentresolution_mailbox_sendermailboxid incidentresolution sendermailboxid_incidentresolution
Mailbox_Annotation annotation objectid_mailbox
mailbox_asyncoperations asyncoperation regardingobjectid_mailbox
Mailbox_MailboxTrackingFolder mailboxtrackingfolder mailboxid
mailbox_processsessions processsession regardingobjectid_mailbox
Mailbox_SyncErrors syncerror regardingobjectid_mailbox_syncerror
msdyn_approval_mailbox_sendermailboxid msdyn_approval sendermailboxid_msdyn_approval
msdyn_bookingalert_mailbox_sendermailboxid msdyn_bookingalert sendermailboxid_msdyn_bookingalert
opportunityclose_mailbox_sendermailboxid opportunityclose sendermailboxid_opportunityclose
orderclose_mailbox_sendermailboxid orderclose sendermailboxid_orderclose
queue_defaultmailbox_mailbox queue defaultmailbox
quoteclose_mailbox_sendermailboxid quoteclose sendermailboxid_quoteclose
serviceappointment_mailbox_sendermailboxid serviceappointment sendermailboxid_serviceappointment
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

Solutions

The following solutions include the mailbox entity type.

Name Description
Application Common For internal use only.
System Solution Internal CRM System Solution

See Also