Mailbox Entity Reference

Messages

Message Web API Operation SDK Assembly
Assign PATCH [org URI]/api/data/v9.0/mailboxes(mailboxid)
Update ownerid property.
AssignRequest
Create POST [org URI]/api/data/v9.0/mailboxes
See Create
CreateRequest or
Create
Delete DELETE [org URI]/api/data/v9.0/mailboxes(mailboxid)
See Delete
DeleteRequest or
Delete
GrantAccess GrantAccess Action GrantAccessRequest
ModifyAccess ModifyAccess Action ModifyAccessRequest
Retrieve GET [org URI]/api/data/v9.0/mailboxes(mailboxid)
See Retrieve
RetrieveRequest or
Retrieve
RetrieveMultiple GET [org URI]/api/data/v9.0/mailboxes
See Query Data
RetrieveMultipleRequest or
RetrieveMultiple
RetrievePrincipalAccess RetrievePrincipalAccess Function RetrievePrincipalAccessRequest
RetrieveSharedPrincipalsAndAccess RetrieveSharedPrincipalsAndAccess Function RetrieveSharedPrincipalsAndAccessRequest
RevokeAccess RevokeAccess Action RevokeAccessRequest
SetState PATCH [org URI]/api/data/v9.0/mailboxes(mailboxid)
Update statecode and statuscode properties.
SetStateRequest
Update PATCH [org URI]/api/data/v9.0/mailboxes(mailboxid)
See Update
UpdateRequest or
Update

Entity Properties

Property Value
CollectionSchemaName Mailboxes
DisplayCollectionName Mailboxes
DisplayName Mailbox
EntitySetName mailboxes
IsBPFEntity False
LogicalCollectionName mailboxes
LogicalName mailbox
OwnershipType UserOwned
PrimaryIdAttribute mailboxid
PrimaryNameAttribute name
SchemaName Mailbox

Writable attributes

These attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.

ACTDeliveryMethod

Property Value
Description Choose the delivery method for the mailbox for appointments, contacts, and tasks.
DisplayName Appointments, Contacts, and Tasks
IsValidForForm True
IsValidForRead True
LogicalName actdeliverymethod
RequiredLevel None
Type Picklist

ACTDeliveryMethod Options

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

ACTStatus

Property Value
Description Status of the Appointments, Contacts, and Tasks.
DisplayName Appointments, Contacts, and Tasks Status
IsValidForCreate False
IsValidForForm True
IsValidForRead True
LogicalName actstatus
RequiredLevel None
Type Picklist

ACTStatus Options

Value Label
0 Not Run
1 Success
2 Failure

AllowEmailConnectorToUseCredentials

Property Value
Description Choose whether to allow the email connector to use credentials.
DisplayName Allow to Use Credentials for Email Processing
IsValidForForm True
IsValidForRead True
LogicalName allowemailconnectortousecredentials
RequiredLevel None
Type Boolean

AllowEmailConnectorToUseCredentials Options

Value Label
1 Yes
0 No

DefaultValue: False

EmailAddress

Property Value
Description Type the email address of the mailbox.
DisplayName Email Address
FormatName Email
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName emailaddress
MaxLength 100
RequiredLevel None
Type String

EmailRouterAccessApproval

Property Value
Description Shows the status of the email address.
DisplayName Email Address Status
IsValidForForm False
IsValidForRead True
LogicalName emailrouteraccessapproval
RequiredLevel SystemRequired
Type Picklist

EmailRouterAccessApproval Options

Value Label
0 Empty
1 Approved
2 Pending Approval
3 Rejected

EmailServerProfile

Property Value
Description Select the email server profile of the mailbox.
DisplayName Server Profile
IsValidForForm True
IsValidForRead True
LogicalName emailserverprofile
RequiredLevel None
Targets emailserverprofile
Type Lookup

EnabledForACT

Property Value
Description Indicates whether the mailbox is enabled for Appointments, Contacts, and Tasks.
DisplayName Enabled For Appointments, Contacts, And Tasks
IsValidForCreate False
IsValidForForm True
IsValidForRead True
LogicalName enabledforact
RequiredLevel SystemRequired
Type Boolean

EnabledForACT Options

Value Label
1 Yes
0 No

DefaultValue: True

EnabledForIncomingEmail

Property Value
Description Choose whether the mailbox is enabled for receiving email.
DisplayName Enabled For Incoming Email
IsValidForCreate False
IsValidForForm True
IsValidForRead True
LogicalName enabledforincomingemail
RequiredLevel SystemRequired
Type Boolean

EnabledForIncomingEmail Options

Value Label
1 Yes
0 No

DefaultValue: True

EnabledForOutgoingEmail

Property Value
Description Choose whether the mailbox is enabled for sending email.
DisplayName Enabled For Outgoing Email
IsValidForCreate False
IsValidForForm True
IsValidForRead True
LogicalName enabledforoutgoingemail
RequiredLevel SystemRequired
Type Boolean

EnabledForOutgoingEmail Options

Value Label
1 Yes
0 No

DefaultValue: True

EntityImage

Property Value
Description The default image for the entity.
DisplayName Entity Image
IsPrimaryImage False
IsValidForForm False
IsValidForRead True
LogicalName entityimage
MaxHeight 144
MaxWidth 144
RequiredLevel None
Type Image

EWSURL

Property Value
Description Exchange web services endpoint URL for the mailbox.
DisplayName Exchange Web Services URL
FormatName Url
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName ewsurl
MaxLength 2084
RequiredLevel None
Type String

ExchangeContactsImportStatus

Property Value
Description Indicates the exchange contacts import status for a mailbox record.
DisplayName Exchange Contacts Import Status
IsValidForForm False
IsValidForRead True
LogicalName exchangecontactsimportstatus
RequiredLevel None
Type Picklist

ExchangeContactsImportStatus Options

Value Label
0 NotImported
1 Imported
2 ImportFailed

ExchangeSyncStateXml

Property Value
Description Contains the exchange synchronization state in XML format.
DisplayName Exchange Sync State
Format TextArea
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName exchangesyncstatexml
MaxLength 1073741823
RequiredLevel None
Type Memo

FolderHierarchy

Property Value
Description Holds the hierarchy of folders under inbox in XML format.
DisplayName Folder Hierarchy
Format TextArea
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName folderhierarchy
MaxLength 1048576
RequiredLevel None
Type Memo

IncomingEmailDeliveryMethod

Property Value
Description Select how incoming email will be delivered to the mailbox.
DisplayName Incoming Email
IsValidForForm True
IsValidForRead True
LogicalName incomingemaildeliverymethod
RequiredLevel None
Type Picklist

IncomingEmailDeliveryMethod Options

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

IncomingEmailStatus

Property Value
Description Select the status that will be assigned to incoming email messages.
DisplayName Incoming Email Status
IsValidForCreate False
IsValidForForm True
IsValidForRead True
LogicalName incomingemailstatus
RequiredLevel None
Type Picklist

IncomingEmailStatus Options

Value Label
0 Not Run
1 Success
2 Failure

IsACTSyncOrgFlagSet

Property Value
Description Set the current organization as the synchronization organization.
DisplayName Set Current Organization as Synchronization Organization
IsValidForForm False
IsValidForRead True
LogicalName isactsyncorgflagset
RequiredLevel None
Type Boolean

IsACTSyncOrgFlagSet Options

Value Label
1 Yes
0 No

DefaultValue: False

IsEmailAddressApprovedByO365Admin

Property Value
Description Shows the status of approval of the email address by O365 Admin.
DisplayName Email Address O365 Admin Approval Status
IsValidForCreate False
IsValidForForm False
IsValidForRead True
LogicalName isemailaddressapprovedbyo365admin
RequiredLevel SystemRequired
Type Boolean

IsEmailAddressApprovedByO365Admin Options

Value Label
1 Yes
0 No

DefaultValue: False

ItemsFailedForLastSync

Property Value
Description For internal use only.
DisplayName Items Failed For Last Sync
Format None
IsValidForForm False
IsValidForRead True
LogicalName itemsfailedforlastsync
MaxValue 2147483647
MinValue 0
RequiredLevel None
Type Integer

ItemsProcessedForLastSync

Property Value
Description For internal use only.
DisplayName Items Processed For Last Sync
Format None
IsValidForForm False
IsValidForRead True
LogicalName itemsprocessedforlastsync
MaxValue 2147483647
MinValue 0
RequiredLevel None
Type Integer

LastAutoDiscoveredOn

Property Value
DateTimeBehavior UserLocal
Description Shows the date and time when the Exchange web services URL was last discovered using the AutoDiscover service.
DisplayName Last Auto Discovered On
Format DateAndTime
IsValidForForm False
IsValidForRead True
LogicalName lastautodiscoveredon
RequiredLevel None
Type DateTime

LastSuccessfulSyncCompletedOn

Property Value
DateTimeBehavior UserLocal
Description Last Successful Sync Time
DisplayName Last Successful Sync Time
Format DateAndTime
IsValidForCreate False
IsValidForForm False
IsValidForRead True
LogicalName lastsuccessfulsynccompletedon
RequiredLevel None
Type DateTime

LastSyncError

Property Value
Description For internal use only.
DisplayName Last Sync Error Stack
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName lastsyncerror
MaxLength 2048
RequiredLevel None
Type String

LastSyncErrorCode

Property Value
Description For internal use only.
DisplayName Last Sync Error Code
Format None
IsValidForForm False
IsValidForRead True
LogicalName lastsyncerrorcode
MaxValue 2147483647
MinValue -2147483648
RequiredLevel None
Type Integer

LastSyncErrorCount

Property Value
Description For internal use only
DisplayName Last Sync Error Continuous Count
Format None
IsValidForForm False
IsValidForRead True
LogicalName lastsyncerrorcount
MaxValue 2147483647
MinValue 0
RequiredLevel None
Type Integer

LastSyncErrorMachineName

Property Value
Description For internal use only.
DisplayName Last Sync Error Machine Name
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName lastsyncerrormachinename
MaxLength 320
RequiredLevel None
Type String

LastSyncErrorOccurredOn

Property Value
DateTimeBehavior UserLocal
Description For internal use only.
DisplayName Last Sync Error Time
Format DateAndTime
IsValidForForm False
IsValidForRead True
LogicalName lastsyncerroroccurredon
RequiredLevel None
Type DateTime

MailboxId

Property Value
Description Unique identifier of the mailbox.
DisplayName Mailbox
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName mailboxid
RequiredLevel SystemRequired
Type Uniqueidentifier

MailboxProcessingContext

Property Value
Description For internal use only.
DisplayName Processing Context of the Mailbox
Format None
IsValidForForm False
IsValidForRead True
LogicalName mailboxprocessingcontext
MaxValue 2147483647
MinValue 0
RequiredLevel None
Type Integer

Name

Property Value
Description Type the name of the mailbox.
DisplayName Name
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName name
MaxLength 200
RequiredLevel SystemRequired
Type String

OfficeAppsDeploymentScheduled

Property Value
Description Indicates if the office apps deployment has been scheduled for a mailbox record.
DisplayName Office Apps Deployment Scheduled
IsValidForForm False
IsValidForRead True
LogicalName officeappsdeploymentscheduled
RequiredLevel None
Type Boolean

OfficeAppsDeploymentScheduled Options

Value Label
1 Yes
0 No

DefaultValue: False

OfficeAppsDeploymentStatus

Property Value
Description Indicates the office apps deployment type for a mailbox record.
DisplayName Office Apps Deployment Type
IsValidForForm True
IsValidForRead True
LogicalName officeappsdeploymentstatus
RequiredLevel None
Type Picklist

OfficeAppsDeploymentStatus Options

Value Label
0 NotInstalled
1 Installed
2 InstallFailed
3 UninstallFailed
4 UpgradeRequired

OrgMarkedAsPrimaryForExchangeSync

Property Value
Description Indicates if the crm org is to be marked as primary syncing org for the mailbox record.
DisplayName Crm Org Marked as Primary Org for Exchange Mailbox
IsValidForForm False
IsValidForRead True
LogicalName orgmarkedasprimaryforexchangesync
RequiredLevel None
Type Boolean

OrgMarkedAsPrimaryForExchangeSync Options

Value Label
1 Yes
0 No

DefaultValue: False

OutgoingEmailDeliveryMethod

Property Value
Description Select how outgoing email will be sent from the mailbox.
DisplayName Outgoing Email
IsValidForForm True
IsValidForRead True
LogicalName outgoingemaildeliverymethod
RequiredLevel None
Type Picklist

OutgoingEmailDeliveryMethod Options

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

OutgoingEmailStatus

Property Value
Description Select the status of outgoing email messages.
DisplayName Outgoing Email Status
IsValidForCreate False
IsValidForForm True
IsValidForRead True
LogicalName outgoingemailstatus
RequiredLevel None
Type Picklist

OutgoingEmailStatus Options

Value Label
0 Not Run
1 Success
2 Failure

OwnerId

Property Value
Description 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.
DisplayName Owner
IsValidForForm True
IsValidForRead True
LogicalName ownerid
RequiredLevel SystemRequired
Targets systemuser,team
Type Owner

OwnerIdType

Property Value
Description Owner Id Type
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName owneridtype
RequiredLevel SystemRequired
Type EntityName

Password

Property Value
Description Type the password for the mailbox.
DisplayName Password
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead False
LogicalName password
MaxLength 200
RequiredLevel None
Type String

PostponeMailboxProcessingUntil

Property Value
DateTimeBehavior UserLocal
Description Shows the date and time when processing will begin on this mailbox.
DisplayName Postpone Mailbox Processing Until
Format DateOnly
IsValidForCreate False
IsValidForForm False
IsValidForRead True
LogicalName postponemailboxprocessinguntil
RequiredLevel SystemRequired
Type DateTime

PostponeOfficeAppsDeploymentUntil

Property Value
DateTimeBehavior UserLocal
Description Shows the date and time when the next outlook mail app install will be run for a mailbox record.
DisplayName Postpone Outlook Mail App Install Until
Format DateAndTime
IsValidForForm True
IsValidForRead True
LogicalName postponeofficeappsdeploymentuntil
RequiredLevel None
Type DateTime

PostponeSendingUntil

Property Value
DateTimeBehavior UserLocal
Description Shows the date and time when the mailbox can start sending emails.
DisplayName Postpone Sending Until
Format DateOnly
IsValidForForm False
IsValidForRead True
LogicalName postponesendinguntil
RequiredLevel SystemRequired
Type DateTime

PostponeTestEmailConfigurationUntil

Property Value
DateTimeBehavior UserLocal
Description Shows the date and time when the next email configuration test will be run for a mailbox record.
DisplayName Postpone Test Email Configuration Until
Format DateAndTime
IsValidForForm True
IsValidForRead True
LogicalName postponetestemailconfigurationuntil
RequiredLevel None
Type DateTime

ProcessAndDeleteEmails

Property Value
Description Select whether to delete emails from the mailbox after processing.
DisplayName Delete Emails after Processing
IsValidForForm True
IsValidForRead True
LogicalName processanddeleteemails
RequiredLevel None
Type Boolean

ProcessAndDeleteEmails Options

Value Label
1 Yes
0 No

DefaultValue: False

ProcessEmailReceivedAfter

Property Value
DateTimeBehavior UserLocal
Description Shows the date and time to start processing email received by the mailbox.
DisplayName Process Email Received After
Format DateOnly
IsValidForForm True
IsValidForRead True
LogicalName processemailreceivedafter
RequiredLevel None
Type DateTime

StateCode

Property Value
Description Shows whether the mailbox is active or inactive.
DisplayName Status
IsValidForCreate False
IsValidForForm True
IsValidForRead True
LogicalName statecode
RequiredLevel SystemRequired
Type State

StateCode Options

Value Label DefaultStatus InvariantName
0 Active 1 Active
1 Inactive 2 Inactive

StatusCode

Property Value
Description Select the mailbox's status.
DisplayName Status Reason
IsValidForForm True
IsValidForRead True
LogicalName statuscode
RequiredLevel SystemRequired
Type Status

StatusCode Options

Value Label State
1 Active 0
2 Inactive 1

TestEmailConfigurationRetryCount

Property Value
Description Shows the number of times an email configuration test has been performed.
DisplayName Test Email Configuration Retry Count
Format None
IsValidForForm False
IsValidForRead True
LogicalName testemailconfigurationretrycount
MaxValue 2147483647
MinValue 0
RequiredLevel SystemRequired
Type Integer

TestEmailConfigurationScheduled

Property Value
Description Indicates if the email configuration test has been scheduled for a mailbox record.
DisplayName Test Email Configuration Scheduled
IsValidForForm False
IsValidForRead True
LogicalName testemailconfigurationscheduled
RequiredLevel None
Type Boolean

TestEmailConfigurationScheduled Options

Value Label
1 Yes
0 No

DefaultValue: False

TestMailboxAccessCompletedOn

Property Value
DateTimeBehavior UserLocal
Description Date and time when the last email configuration test was completed for a mailbox record.
DisplayName Mailbox Test Completed On
Format DateAndTime
IsValidForCreate False
IsValidForForm True
IsValidForRead True
LogicalName testmailboxaccesscompletedon
RequiredLevel None
Type DateTime

TimeZoneRuleVersionNumber

Property Value
Description For internal use only.
DisplayName Time Zone Rule Version Number
Format None
IsValidForForm False
IsValidForRead True
LogicalName timezoneruleversionnumber
MaxValue 2147483647
MinValue -1
RequiredLevel None
Type Integer

UndeliverableFolder

Property Value
Description Shows the ID of the Undeliverable folder in the mailbox managed by Microsoft Exchange.
DisplayName Undeliverable Folder
FormatName Text
IsLocalizable False
IsValidForCreate False
IsValidForForm False
IsValidForRead True
LogicalName undeliverablefolder
MaxLength 256
RequiredLevel None
Type String

Username

Property Value
Description Type a user name used for mailbox authentication.
DisplayName User Name
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName username
MaxLength 200
RequiredLevel None
Type String

UTCConversionTimeZoneCode

Property Value
Description Time zone code that was in use when the record was created.
DisplayName UTC Conversion Time Zone Code
Format None
IsValidForForm False
IsValidForRead True
LogicalName utcconversiontimezonecode
MaxValue 2147483647
MinValue -1
RequiredLevel None
Type Integer

VerboseLoggingEnabled

Property Value
Description Indicates if verbose tracing needs to be enabled for this mailbox.
DisplayName Verbose Logging
Format None
IsValidForCreate False
IsValidForForm True
IsValidForRead True
LogicalName verboseloggingenabled
MaxValue 100
MinValue 0
RequiredLevel SystemRequired
Type Integer

Read-only attributes

These attributes return false for both IsValidForCreate or IsValidForUpdate. Listed by SchemaName.

AverageTotalDuration

Property Value
Description Mailbox Total Duration in Average
DisplayName Monitor Total Performance
Format None
IsValidForForm False
IsValidForRead True
LogicalName averagetotalduration
MaxValue 2147483647
MinValue -1
RequiredLevel None
Type Integer

CreatedBy

Property Value
Description Shows who created the record.
DisplayName Created By
IsValidForForm True
IsValidForRead True
LogicalName createdby
RequiredLevel None
Targets systemuser
Type Lookup

CreatedByName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdbyname
MaxLength 160
RequiredLevel None
Type String

CreatedByYomiName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdbyyominame
MaxLength 160
RequiredLevel SystemRequired
Type String

CreatedOn

Property Value
DateTimeBehavior UserLocal
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.
DisplayName Created On
Format DateAndTime
IsValidForForm True
IsValidForRead True
LogicalName createdon
RequiredLevel None
Type DateTime

CreatedOnBehalfBy

Property Value
Description Shows who created the record on behalf of another user.
DisplayName Created By (Delegate)
IsValidForForm True
IsValidForRead True
LogicalName createdonbehalfby
RequiredLevel None
Targets systemuser
Type Lookup

CreatedOnBehalfByName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdonbehalfbyname
MaxLength 160
RequiredLevel None
Type String

CreatedOnBehalfByYomiName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdonbehalfbyyominame
MaxLength 160
RequiredLevel SystemRequired
Type String

EmailServerProfileName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName emailserverprofilename
MaxLength 100
RequiredLevel None
Type String

EntityImage_Timestamp

Property Value
Description
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName entityimage_timestamp
MaxValue 9223372036854775807
MinValue -9223372036854775808
RequiredLevel None
Type BigInt

EntityImage_URL

Property Value
Description
DisplayName
FormatName Url
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName entityimage_url
MaxLength 200
RequiredLevel None
Type String

EntityImageId

Property Value
Description For internal use only.
DisplayName Entity Image Id
IsValidForForm False
IsValidForRead True
LogicalName entityimageid
RequiredLevel None
Type Uniqueidentifier

ExchangeContactsImportCompletedOn

Property Value
DateTimeBehavior UserLocal
Description Date and time when the exchange contacts import was last completed for a mailbox record.
DisplayName Exchange Contacts Import Completed On
Format DateAndTime
IsValidForForm False
IsValidForRead True
LogicalName exchangecontactsimportcompletedon
RequiredLevel None
Type DateTime

ForcedUnlockCount

Property Value
Description For internal use only
DisplayName Count of the number of times a mailbox gets forced unlocked
Format None
IsValidForForm False
IsValidForRead True
LogicalName forcedunlockcount
MaxValue 2147483647
MinValue 0
RequiredLevel SystemRequired
Type Integer

HostId

Property Value
Description Unique identifier of the async host that is processing this mailbox.
DisplayName Host
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName hostid
MaxLength 256
RequiredLevel None
Type String

IsExchangeContactsImportScheduled

Property Value
Description Is Exchange Contacts Import Scheduled.
DisplayName Is Exchange Contacts Import Scheduled.
IsValidForForm False
IsValidForRead True
LogicalName isexchangecontactsimportscheduled
RequiredLevel SystemRequired
Type Boolean

IsExchangeContactsImportScheduled Options

Value Label
1 Yes
0 No

DefaultValue: False

IsForwardMailbox

Property Value
Description Select whether the mailbox is a forward mailbox.
DisplayName Is Forward Mailbox
IsValidForForm True
IsValidForRead True
LogicalName isforwardmailbox
RequiredLevel SystemRequired
Type Boolean

IsForwardMailbox Options

Value Label
1 Yes
0 No

DefaultValue: True

IsPasswordSet

Property Value
Description
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName ispasswordset
RequiredLevel None
Type Boolean

IsPasswordSet Options

Value Label
1 Yes
0 No

DefaultValue: False

IsServiceAccount

Property Value
Description Select whether the mailbox corresponds to one for the service account.
DisplayName Is Service Account
IsValidForForm False
IsValidForRead True
LogicalName isserviceaccount
RequiredLevel SystemRequired
Type Boolean

IsServiceAccount Options

Value Label
1 Yes
0 No

DefaultValue: False

LastActiveOn

Property Value
DateTimeBehavior UserLocal
Description For internal use only.
DisplayName Last Active On
Format DateAndTime
IsValidForForm False
IsValidForRead False
LogicalName lastactiveon
RequiredLevel SystemRequired
Type DateTime

LastDuration

Property Value
Description Last Duration for the mailbox
DisplayName Monitor last duration Performance
Format None
IsValidForForm False
IsValidForRead True
LogicalName lastduration
MaxValue 2147483647
MinValue -1
RequiredLevel None
Type Integer

LastMailboxForcedUnlockOccurredOn

Property Value
DateTimeBehavior UserLocal
Description For internal use only.
DisplayName Last Date Time when a mailbox got forced unlocked
Format DateAndTime
IsValidForForm False
IsValidForRead True
LogicalName lastmailboxforcedunlockoccurredon
RequiredLevel None
Type DateTime

LastMessageId

Property Value
Description Unique identifier of the last message.
DisplayName Last Message ID
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead False
LogicalName lastmessageid
MaxLength 320
RequiredLevel None
Type String

LastSyncStartedOn

Property Value
DateTimeBehavior UserLocal
Description Last Sync Start Time
DisplayName Last Sync Start Time
Format DateAndTime
IsValidForForm False
IsValidForRead True
LogicalName lastsyncstartedon
RequiredLevel None
Type DateTime

MailboxStatus

Property Value
Description Last Sync Status for Outgoing, Incoming and ACT as a whole.
DisplayName Mailbox Status
IsValidForForm True
IsValidForRead True
LogicalName mailboxstatus
RequiredLevel None
Type Picklist

MailboxStatus Options

Value Label
0 Not Run
1 Success
2 Failure

ModifiedBy

Property Value
Description Shows who last updated the record.
DisplayName Modified By
IsValidForForm True
IsValidForRead True
LogicalName modifiedby
RequiredLevel None
Targets systemuser
Type Lookup

ModifiedByName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedbyname
MaxLength 160
RequiredLevel None
Type String

ModifiedByYomiName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedbyyominame
MaxLength 160
RequiredLevel SystemRequired
Type String

ModifiedOn

Property Value
DateTimeBehavior UserLocal
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.
DisplayName Modified On
Format DateAndTime
IsValidForForm True
IsValidForRead True
LogicalName modifiedon
RequiredLevel None
Type DateTime

ModifiedOnBehalfBy

Property Value
Description Shows who last updated the record on behalf of another user.
DisplayName Modified By (Delegate)
IsValidForForm True
IsValidForRead True
LogicalName modifiedonbehalfby
RequiredLevel None
Targets systemuser
Type Lookup

ModifiedOnBehalfByName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedonbehalfbyname
MaxLength 160
RequiredLevel None
Type String

ModifiedOnBehalfByYomiName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedonbehalfbyyominame
MaxLength 160
RequiredLevel SystemRequired
Type String

NoACTCount

Property Value
Description For internal use only.
DisplayName Zero appointment, contact, task count for mailbox
Format None
IsValidForForm False
IsValidForRead True
LogicalName noactcount
MaxValue 2147483647
MinValue 0
RequiredLevel None
Type Integer

NoEmailCount

Property Value
Description For internal use only.
DisplayName Zero email count for mailbox
Format None
IsValidForForm False
IsValidForRead True
LogicalName noemailcount
MaxValue 2147483647
MinValue 0
RequiredLevel None
Type Integer

OfficeAppsDeploymentCompleteOn

Property Value
DateTimeBehavior UserLocal
Description Date and time when the last office apps deployment was completed for a mailbox record.
DisplayName Office Apps Deployment Completed On
Format DateAndTime
IsValidForForm True
IsValidForRead True
LogicalName officeappsdeploymentcompleteon
RequiredLevel None
Type DateTime

OfficeAppsDeploymentError

Property Value
Description The Office Apps deployment error.
DisplayName Office Apps Deployment Error
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName officeappsdeploymenterror
MaxLength 2048
RequiredLevel None
Type String

OrganizationId

Property Value
Description Unique identifier of the organization associated with the record.
DisplayName Organization
IsValidForForm False
IsValidForRead True
LogicalName organizationid
RequiredLevel SystemRequired
Targets organization
Type Lookup

OrganizationIdName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName organizationidname
MaxLength 160
RequiredLevel SystemRequired
Type String

OwnerIdName

Property Value
Description Name of the owner
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName owneridname
MaxLength 160
RequiredLevel SystemRequired
Type String

OwnerIdYomiName

Property Value
Description Yomi name of the owner
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName owneridyominame
MaxLength 160
RequiredLevel SystemRequired
Type String

OwningBusinessUnit

Property Value
Description Select the business unit that owns the record.
DisplayName Owning Business Unit
IsValidForForm True
IsValidForRead True
LogicalName owningbusinessunit
RequiredLevel None
Targets businessunit
Type Lookup

OwningBusinessUnitName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName owningbusinessunitname
MaxLength 160
RequiredLevel None
Type String

OwningTeam

Property Value
Description Unique identifier for the team that owns the record.
DisplayName Owning Team
IsValidForForm False
IsValidForRead True
LogicalName owningteam
RequiredLevel None
Targets team
Type Lookup

OwningUser

Property Value
Description Unique identifier for the user that owns the record.
DisplayName Owning User
IsValidForForm False
IsValidForRead True
LogicalName owninguser
RequiredLevel None
Targets systemuser
Type Lookup

ProcessedTimes

Property Value
Description The number of times mailbox has processed
DisplayName Monitor Performance
Format None
IsValidForForm False
IsValidForRead True
LogicalName processedtimes
MaxValue 2147483647
MinValue -1
RequiredLevel None
Type Integer

ProcessingLastAttemptedOn

Property Value
DateTimeBehavior UserLocal
Description Date and time when the processing of the mailbox was last attempted.
DisplayName Date Processing Last Attempted
Format DateAndTime
IsValidForForm True
IsValidForRead True
LogicalName processinglastattemptedon
RequiredLevel None
Type DateTime

ProcessingStateCode

Property Value
Description Information that indicates whether email will be processed for this mailbox
DisplayName Mailbox Processing State
Format None
IsValidForForm False
IsValidForRead True
LogicalName processingstatecode
MaxValue 2147483647
MinValue 0
RequiredLevel SystemRequired
Type Integer

ReceivingPostponedUntil

Property Value
DateTimeBehavior UserLocal
Description For internal use only.
DisplayName Postpone receiving emails for the mailbox until the specified data and time.
Format DateOnly
IsValidForForm False
IsValidForRead True
LogicalName receivingpostponeduntil
RequiredLevel None
Type DateTime

ReceivingPostponedUntilForACT

Property Value
DateTimeBehavior UserLocal
Description For internal use only.
DisplayName Postpone processing Appointments, Contacts, and Tasks for the mailbox until the specified data and time.
Format DateOnly
IsValidForForm False
IsValidForRead True
LogicalName receivingpostponeduntilforact
RequiredLevel None
Type DateTime

RegardingObjectId

Property Value
Description Choose the user associated to the mailbox.
DisplayName Regarding
IsValidForForm True
IsValidForRead True
LogicalName regardingobjectid
RequiredLevel None
Targets queue,systemuser
Type Lookup

RegardingObjectIdName

Property Value
Description Name for User associated with Mailbox.
DisplayName Regarding Name
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName regardingobjectidname
MaxLength 200
RequiredLevel None
Type String

RegardingObjectTypeCode

Property Value
Description Object Type of the entity associated with the mailbox.
DisplayName Regarding Object Type Code
IsValidForForm False
IsValidForRead True
LogicalName regardingobjecttypecode
RequiredLevel None
Type EntityName

TransientFailureCount

Property Value
Description Concatenation of transient failure counts of all mailbox operations.
DisplayName Transient Failure Count
Format None
IsValidForForm False
IsValidForRead True
LogicalName transientfailurecount
MaxValue 2147483647
MinValue 0
RequiredLevel SystemRequired
Type Integer

VersionNumber

Property Value
Description Version number of the mailbox.
DisplayName Version Number
IsValidForForm False
IsValidForRead True
LogicalName versionnumber
MaxValue 9223372036854775807
MinValue -9223372036854775808
RequiredLevel None
Type BigInt

One-To-Many Relationships

Listed by SchemaName.

systemuser_defaultmailbox_mailbox

Same as systemuser entity systemuser_defaultmailbox_mailbox Many-To-One relationship.

Property Value
ReferencingEntity systemuser
ReferencingAttribute defaultmailbox
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName systemuser_defaultmailbox_mailbox
AssociatedMenuConfiguration Behavior: UseCollectionName
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: RemoveLink
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

queue_defaultmailbox_mailbox

Same as queue entity queue_defaultmailbox_mailbox Many-To-One relationship.

Property Value
ReferencingEntity queue
ReferencingAttribute defaultmailbox
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName queue_defaultmailbox_mailbox
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: RemoveLink
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

activitypointer_sendermailboxid_mailbox

Same as activitypointer entity activitypointer_sendermailboxid_mailbox Many-To-One relationship.

Property Value
ReferencingEntity activitypointer
ReferencingAttribute sendermailboxid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName activitypointer_sendermailboxid_mailbox
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

Mailbox_MailboxTrackingFolder

Same as mailboxtrackingfolder entity Mailbox_MailboxTrackingFolder Many-To-One relationship.

Property Value
ReferencingEntity mailboxtrackingfolder
ReferencingAttribute mailboxid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName Mailbox_MailboxTrackingFolder
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

Mailbox_Annotation

Same as annotation entity Mailbox_Annotation Many-To-One relationship.

Property Value
ReferencingEntity annotation
ReferencingAttribute objectid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName Mailbox_Annotation
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: Cascade
Delete: Cascade
Merge: Cascade
Reparent: Cascade
Share: Cascade
Unshare: Cascade

Mailbox_SyncErrors

Same as syncerror entity Mailbox_SyncErrors Many-To-One relationship.

Property Value
ReferencingEntity syncerror
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName Mailbox_SyncErrors
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: Cascade
Delete: Cascade
Merge: Cascade
Reparent: Cascade
Share: Cascade
Unshare: Cascade

mailbox_processsessions

Same as processsession entity mailbox_processsessions Many-To-One relationship.

Property Value
ReferencingEntity processsession
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName mailbox_processsessions
AssociatedMenuConfiguration Behavior: UseCollectionName
Group: Details
Label:
Order: 110
CascadeConfiguration Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

mailbox_asyncoperations

Same as asyncoperation entity mailbox_asyncoperations Many-To-One relationship.

Property Value
ReferencingEntity asyncoperation
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName mailbox_asyncoperations
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

tracelog_Mailbox

Same as tracelog entity tracelog_Mailbox Many-To-One relationship.

Property Value
ReferencingEntity tracelog
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName tracelog_Mailbox
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

email_sendermailboxid_mailbox

Same as email entity email_sendermailboxid_mailbox Many-To-One relationship.

Property Value
ReferencingEntity email
ReferencingAttribute sendermailboxid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName email_sendermailboxid_mailbox
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

Many-To-One Relationships

Each Many-To-One relationship is defined by a corresponding One-To-Many relationship with the related entity. Listed by SchemaName.

lk_mailbox_createdby

See systemuser Entity lk_mailbox_createdby One-To-Many relationship.

lk_mailbox_createdonbehalfby

See systemuser Entity lk_mailbox_createdonbehalfby One-To-Many relationship.

lk_mailbox_modifiedby

See systemuser Entity lk_mailbox_modifiedby One-To-Many relationship.

lk_mailbox_modifiedonbehalfby

See systemuser Entity lk_mailbox_modifiedonbehalfby One-To-Many relationship.

user_mailbox

See systemuser Entity user_mailbox One-To-Many relationship.

team_mailbox

See team Entity team_mailbox One-To-Many relationship.

business_unit_mailbox

See businessunit Entity business_unit_mailbox One-To-Many relationship.

mailbox_regarding_systemuser

See systemuser Entity mailbox_regarding_systemuser One-To-Many relationship.

emailserverprofile_mailbox

See emailserverprofile Entity emailserverprofile_mailbox One-To-Many relationship.

organization_mailbox

See organization Entity organization_mailbox One-To-Many relationship.

mailbox_regarding_queue

See queue Entity mailbox_regarding_queue One-To-Many relationship.

See also

About the Entity Reference
Web API Reference
mailbox EntityType