mailbox EntityType

Dynamics CRM 2016
 

Updated: November 29, 2016

Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

Description: [No Description]

Entity Set path:[organization URI]/api/data/v8.2/mailboxes

Base Type: crmbaseentity EntityType

Display Name: Mailbox

Primary Key: mailboxid

Primary Name Attribute: name

Properties

Lookup Properties

Single-valued navigation properties

Collection-valued navigation properties

Properties represent fields of data stored in the entity. Some properties are read-only.

Name

Type

Details

actdeliverymethod

Edm.Int32

Description: Choose the delivery method for the mailbox for appointments, contacts, and tasks.

Default Options:

0 : Microsoft Dynamics 365 for Outlook
1 : Server-Side Synchronization
2 : None

Display Name: Appointments, Contacts, and Tasks

actstatus

Edm.Int32

Description: Status of the Appointments, Contacts, and Tasks.

Default Options:

0 : Not Run
1 : Success
2 : Failure

Display Name: Appointments, Contacts, and Tasks Status

Read-only property

allowemailconnectortousecredentials

Edm.Boolean

Description: Choose whether to allow the email connector to use credentials.

Default Options:

1 : Yes
0 : No

Display Name: Allow to Use Credentials for Email Processing

averagetotalduration

Edm.Int32

Description: Mailbox Total Duration in Average

Display Name: Monitor Total Performance

Read-only property

createdon

Edm.DateTimeOffset

Description: 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 property

emailaddress

Edm.String

Description: Type the email address of the mailbox.

Display Name: Email Address

emailrouteraccessapproval

Edm.Int32

Description: Shows the status of the email address.

Default Options:

0 : Empty
1 : Approved
2 : Pending Approval
3 : Rejected

Display Name: Email Address Status

enabledforact

Edm.Boolean

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

Default Options:

1 : Yes
0 : No

Display Name: Enabled For Appointments, Contacts, And Tasks

enabledforincomingemail

Edm.Boolean

Description: Choose whether the mailbox is enabled for receiving email.

Default Options:

1 : Yes
0 : No

Display Name: Enabled For Incoming Email

enabledforoutgoingemail

Edm.Boolean

Description: Choose whether the mailbox is enabled for sending email.

Default Options:

1 : Yes
0 : No

Display Name: Enabled For Outgoing Email

entityimage

Edm.Binary

Description: The default image for the entity.

Display Name: Entity Image

entityimage_timestamp

Edm.Int64

Description:

Read-only property

entityimage_url

Edm.String

Description:

Read-only property

entityimageid

Edm.Guid

Description: For internal use only.

Display Name: Entity Image Id

Read-only property

ewsurl

Edm.String

Description: Exchange web services endpoint URL for the mailbox.

Display Name: Exchange Web Services URL

exchangesyncstatexml

Edm.String

Description: Contains the exchange synchronization state in XML format.

Display Name: Exchange Sync State

folderhierarchy

Edm.String

Description: Holds the hierarchy of folders under inbox in XML format.

Display Name: Folder Hierarchy

forcedunlockcount

Edm.Int32

Description: For internal use only

Display Name: Count of the number of times a mailbox gets forced unlocked

Read-only property

hostid

Edm.String

Description: Unique identifier of the async host that is processing this mailbox.

Display Name: Host

Read-only property

incomingemaildeliverymethod

Edm.Int32

Description: Select how incoming email will be delivered to the mailbox.

Default Options:

0 : None
1 : Microsoft Dynamics 365 for Outlook
2 : Server-Side Synchronization or Email Router
3 : Forward Mailbox

Display Name: Incoming Email

incomingemailstatus

Edm.Int32

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

Default Options:

0 : Not Run
1 : Success
2 : Failure

Display Name: Incoming Email Status

Read-only property

isactsyncorgflagset

Edm.Boolean

Description: Set the current organization as the synchronization organization.

Default Options:

1 : Yes
0 : No

Display Name: Set Current Organization as Synchronization Organization

isemailaddressapprovedbyo365admin

Edm.Boolean

Description: Shows the status of approval of the email address by O365 Admin.

Default Options:

1 : Yes
0 : No

Display Name: Email Address O365 Admin Approval Status

isforwardmailbox

Edm.Boolean

Description: Select whether the mailbox is a forward mailbox.

Default Options:

1 : Yes
0 : No

Display Name: Is Forward Mailbox

Read-only property

ispasswordset

Edm.Boolean

Description:

Default Options:

1 : Yes
0 : No

Read-only property

isserviceaccount

Edm.Boolean

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

Default Options:

1 : Yes
0 : No

Display Name: Is Service Account

Read-only property

itemsfailedforlastsync

Edm.Int32

Description: For internal use only.

Display Name: Items Failed For Last Sync

itemsprocessedforlastsync

Edm.Int32

Description: For internal use only.

Display Name: Items Processed For Last Sync

lastautodiscoveredon

Edm.DateTimeOffset

Description: 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

Description: Last Duration for the mailbox

Display Name: Monitor last duration Performance

Read-only property

lastmailboxforcedunlockoccurredon

Edm.DateTimeOffset

Description: For internal use only.

Display Name: Last Date Time when a mailbox got forced unlocked

Read-only property

lastsuccessfulsynccompletedon

Edm.DateTimeOffset

Description: Last Successful Sync Time

Display Name: Last Successful Sync Time

Read-only property

lastsyncerror

Edm.String

Description: For internal use only.

Display Name: Last Sync Error Stack

lastsyncerrorcode

Edm.Int32

Description: For internal use only.

Display Name: Last Sync Error Code

lastsyncerrorcount

Edm.Int32

Description: For internal use only

Display Name: Last Sync Error Continuous Count

lastsyncerrormachinename

Edm.String

Description: For internal use only.

Display Name: Last Sync Error Machine Name

lastsyncerroroccurredon

Edm.DateTimeOffset

Description: For internal use only.

Display Name: Last Sync Error Time

lastsyncstartedon

Edm.DateTimeOffset

Description: Last Sync Start Time

Display Name: Last Sync Start Time

Read-only property

mailboxid

Edm.Guid

Description: Unique identifier of the mailbox.

Display Name: Mailbox

mailboxprocessingcontext

Edm.Int32

Description: For internal use only.

Display Name: Processing Context of the Mailbox

mailboxstatus

Edm.Int32

Description: Last Sync Status for Outgoing, Incoming and ACT as a whole.

Default Options:

0 : Not Run
1 : Success
2 : Failure

Display Name: Mailbox Status

Read-only property

modifiedon

Edm.DateTimeOffset

Description: 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 property

name

Edm.String

Description: Type the name of the mailbox.

Display Name: Name

noactcount

Edm.Int32

Description: For internal use only.

Display Name: Zero appointment, contact, task count for mailbox

Read-only property

noemailcount

Edm.Int32

Description: For internal use only.

Display Name: Zero email count for mailbox

Read-only property

officeappsdeploymentcompleteon

Edm.DateTimeOffset

Description: Date and time when the last office apps deployment was completed for a mailbox record.

Display Name: Office Apps Deployment Completed On

Read-only property

officeappsdeploymenterror

Edm.String

Description: The Office Apps deployment error.

Display Name: Office Apps Deployment Error

Read-only property

officeappsdeploymentscheduled

Edm.Boolean

Description: Indicates if the office apps deployment has been scheduled for a mailbox record.

Default Options:

1 : Yes
0 : No

Display Name: Office Apps Deployment Scheduled

officeappsdeploymentstatus

Edm.Int32

Description: Indicates the office apps deployment type for a mailbox record.

Default Options:

0 : NotInstalled
1 : Installed
2 : InstallFailed
3 : UninstallFailed
4 : UpgradeRequired

Display Name: Office Apps Deployment Type

orgmarkedasprimaryforexchangesync

Edm.Boolean

Description: Indicates if the crm org is to be marked as primary syncing org for the mailbox record.

Default Options:

1 : Yes
0 : No

Display Name: Crm Org Marked as Primary Org for Exchange Mailbox

outgoingemaildeliverymethod

Edm.Int32

Description: Select how outgoing email will be sent from the mailbox.

Default Options:

0 : None
1 : Microsoft Dynamics 365 for Outlook
2 : Server-Side Synchronization or Email Router

Display Name: Outgoing Email

outgoingemailstatus

Edm.Int32

Description: Select the status of outgoing email messages.

Default Options:

0 : Not Run
1 : Success
2 : Failure

Display Name: Outgoing Email Status

Read-only property

password

Edm.String

Description: Type the password for the mailbox.

Display Name: Password

postponemailboxprocessinguntil

Edm.DateTimeOffset

Description: Shows the date and time when processing will begin on this mailbox.

Display Name: Postpone Mailbox Processing Until

postponeofficeappsdeploymentuntil

Edm.DateTimeOffset

Description: 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

Description: Shows the date and time when the mailbox can start sending emails.

Display Name: Postpone Sending Until

postponetestemailconfigurationuntil

Edm.DateTimeOffset

Description: 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

Description: Select whether to delete emails from the mailbox after processing.

Default Options:

1 : Yes
0 : No

Display Name: Delete Emails after Processing

processedtimes

Edm.Int32

Description: The number of times mailbox has processed

Display Name: Monitor Performance

Read-only property

processemailreceivedafter

Edm.DateTimeOffset

Description: Shows the date and time to start processing email received by the mailbox.

Display Name: Process Email Received After

processinglastattemptedon

Edm.DateTimeOffset

Description: Date and time when the processing of the mailbox was last attempted.

Display Name: Date Processing Last Attempted

Read-only property

processingstatecode

Edm.Int32

Description: Information that indicates whether email will be processed for this mailbox

Display Name: Mailbox Processing State

Read-only property

receivingpostponeduntil

Edm.DateTimeOffset

Description: For internal use only.

Display Name: Postpone receiving emails for the mailbox until the specified data and time.

Read-only property

receivingpostponeduntilforact

Edm.DateTimeOffset

Description: For internal use only.

Display Name: Postpone processing Appointments, Contacts, and Tasks for the mailbox until the specified data and time.

Read-only property

statecode

Edm.Int32

Description: Shows whether the mailbox is active or inactive.

Default Options:

0 : Active
1 : Inactive

Display Name: Status

statuscode

Edm.Int32

Description: Select the mailbox's status.

Default Options:

1 : Active
2 : Inactive

Display Name: Status Reason

testemailconfigurationretrycount

Edm.Int32

Description: Shows the number of times an email configuration test has been performed.

Display Name: Test Email Configuration Retry Count

testemailconfigurationscheduled

Edm.Boolean

Description: Indicates if the email configuration test has been scheduled for a mailbox record.

Default Options:

1 : Yes
0 : No

Display Name: Test Email Configuration Scheduled

testmailboxaccesscompletedon

Edm.DateTimeOffset

Description: Date and time when the last email configuration test was completed for a mailbox record.

Display Name: Mailbox Test Completed On

Read-only property

timezoneruleversionnumber

Edm.Int32

Description: For internal use only.

Display Name: Time Zone Rule Version Number

transientfailurecount

Edm.Int32

Description: Concatenation of transient failure counts of all mailbox operations.

Display Name: Transient Failure Count

Read-only property

undeliverablefolder

Edm.String

Description: Shows the ID of the Undeliverable folder in the mailbox managed by Microsoft Exchange.

Display Name: Undeliverable Folder

username

Edm.String

Description: Type a user name used for mailbox authentication.

Display Name: User Name

utcconversiontimezonecode

Edm.Int32

Description: Time zone code that was in use when the record was created.

Display Name: UTC Conversion Time Zone Code

verboseloggingenabled

Edm.Int32

Description: Indicates if verbose tracing needs to be enabled for this mailbox.

Display Name: Verbose Logging

versionnumber

Edm.Int64

Description: Version number of the mailbox.

Display Name: Version Number

Read-only property

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

regardingobjectid

regardingobjectid_queue

Choose the user associated to the mailbox.

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 EntityType

lk_mailbox_createdby

createdonbehalfby

systemuser EntityType

lk_mailbox_createdonbehalfby

emailserverprofile

emailserverprofile EntityType

emailserverprofile_mailbox

modifiedby

systemuser EntityType

lk_mailbox_modifiedby

modifiedonbehalfby

systemuser EntityType

lk_mailbox_modifiedonbehalfby

organizationid

organization EntityType

organization_mailbox

ownerid

principal EntityType

owner_mailbox

owningbusinessunit

businessunit EntityType

business_unit_mailbox

owningteam

team EntityType

team_mailbox

owninguser

systemuser EntityType

user_mailbox

regardingobjectid

systemuser EntityType

mailbox_regarding_systemuser

regardingobjectid_queue

queue EntityType

mailbox_regarding_queue

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 EntityType

sendermailboxid

email_sendermailboxid_mailbox

email EntityType

sendermailboxid_email

Mailbox_Annotation

annotation EntityType

objectid_mailbox

mailbox_asyncoperations

asyncoperation EntityType

regardingobjectid_mailbox

Mailbox_SyncErrors

syncerror EntityType

regardingobjectid_mailbox_syncerror

queue_defaultmailbox_mailbox

queue EntityType

defaultmailbox

systemuser_defaultmailbox_mailbox

systemuser EntityType

defaultmailbox

tracelog_Mailbox

tracelog EntityType

regardingobjectid_mailbox

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright

Community Additions

ADD
Show: