emailserverprofile EntityType

Holds the Email Server Profiles of an organization

Entity Set Path
[organization URI]/api/data/v9.0/emailserverprofiles
Base Type
crmbaseentity
Display Name
Email Server Profile
Primary Key
emailserverprofileid
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
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
defaultserverlocation Edm.String

Type the default location of the server.

Display Name: Default Email Server Location

description Edm.String

Type additional information that describes the email server profile.

Display Name: Description

emailserverprofileid Edm.Guid

Unique identifier of the email server profile.

Display Name: EmailServerProfile

emailservertypename Edm.String

Email Server Type Name

Display Name: Email Server Type Name

Read Only
encodingcodepage Edm.String

Indicates the code page to use when encoding email content.

Display Name: Encoding Code Page

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
exchangeonlinetenantid Edm.String

Type the tenant ID of Exchange Online.

Display Name: Exchange Online Tenant Id

exchangeversion Edm.Int32

Select the version of Exchange that is on the email server.

Display Name: Exchange Version

Default Options
Value Label
0 Exchange 2007
1 Exchange 2007 SP1
2 Exchange 2010
3 Exchange 2010 SP1
4 Exchange 2010 SP2
5 Exchange 2013
incomingauthenticationprotocol Edm.Int32

Select the incoming email authentication protocol that is used for connecting to the email server.

Display Name: Incoming Authentication Protocol

Default Options
Value Label
0 Auto Detect
1 Negotiate
2 NTLM
3 Basic
incomingcredentialretrieval Edm.Int32

Select how credentials will be retrieved for incoming email.

Display Name: Incoming Email Credential Retrieval

Default Options
Value Label
0 Credentials Specified by a User or Queue
1 Credentials Specified in Email Server Profile
2 Server to Server Authentication
3 Windows Integrated Authentication
4 Without Credentials (Anonymous)
incomingpassword Edm.String

Type the password for incoming email.

Display Name: Incoming Email Password

incomingportnumber Edm.Int32

Type the Exchange port number for incoming mail.

Display Name: Incoming Email Port

incomingserverlocation Edm.String

Type the location of the server for incoming email.

Display Name: Incoming Email Server Location

incominguseimpersonation Edm.Boolean

Select whether to use impersonation to access the mailbox to process incoming emails.

Display Name: Use Impersonation for Incoming Email

Default Options
Value Label
1 Yes
0 No
incomingusername Edm.String

Type the user name for incoming email.

Display Name: Incoming Email User Name

incomingusessl Edm.Boolean

Select whether to use the Secure Sockets Layer (SSL) protocol for incoming email.

Display Name: Use SSL for Incoming Email

Default Options
Value Label
1 Yes
0 No
isincomingpasswordset Edm.Boolean
Read Only
Default Options
Value Label
1 Yes
0 No
isoutgoingpasswordset Edm.Boolean
Read Only
Default Options
Value Label
1 Yes
0 No
lastauthorizationstatus Edm.Int32

Shows the last test authorization status of email server profile

Display Name: Last Test Authorization Status

Default Options
Value Label
0 Failure
1 Success
lastcrmmessage Edm.String

Shows the Dynamics 365 message obtained during the Last Test

Display Name: Last Dynamics 365 Message

lasttestexecutionstatus Edm.Int32

Shows the last test Execution status of email server profile

Display Name: Last Test Execution Status

Default Options
Value Label
0 Failure
1 Success
2 Warning
lasttestrequest Edm.String

Shows the EWS Request created during the Last Test

Display Name: Last Test Request

lasttestresponse Edm.String

Shows the EWS Response obtained during the Last Test

Display Name: Last Test Response

lastteststarttime Edm.DateTimeOffset

Shows the Last Test Start date and time

Display Name: Last Test Time

lasttesttotalexecutiontime Edm.Int64

Shows the Time taken while running the last test

Display Name: Last Test Time Taken

lasttestvalidationstatus Edm.Int32

Shows the last test Validation status of email server profile

Display Name: Last Test Validation Status

Default Options
Value Label
0 Failure
1 Success
maxconcurrentconnections Edm.Int32

Maximum number of concurrent connections allowed to the email server per authenticated user.

Display Name: Maximum Concurrent Connections

minpollingintervalinminutes Edm.Int32

Minimum polling interval, in minutes, for mailboxes that are associated with this email server profile.

Display Name: Minimum Polling Interval In Minutes

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
moveundeliveredemails Edm.Boolean

Indicates whether to move undelivered incoming emails to the Undeliverable folder in Microsoft Exchange.

Display Name: Move Undelivered Emails to the Undeliverable Folder

Default Options
Value Label
1 Yes
0 No
name Edm.String

Type a meaningful name for the email server profile. This name is displayed when you need to select an email server profile.

Display Name: Name

outgoingauthenticationprotocol Edm.Int32

Select the outgoing email authentication protocol that is used for connecting to the email server.

Display Name: Outgoing Authentication Protocol

Default Options
Value Label
0 Auto Detect
1 Negotiate
2 NTLM
3 Basic
outgoingautograntdelegateaccess Edm.Boolean

Indicates whether the email connector will grant delegate access permissions to the accessing user when required while processing outgoing emails.

Display Name: Auto Grant Delegate Access for Outgoing Email.

Default Options
Value Label
1 Yes
0 No
outgoingcredentialretrieval Edm.Int32

Select how credentials will be retrieved for outgoing email.

Display Name: Outgoing Email Credential Retrieval

Default Options
Value Label
0 Credentials Specified by a User or Queue
1 Credentials Specified in Email Server Profile
2 Server to Server Authentication
3 Windows Integrated Authentication
4 Without Credentials (Anonymous)
outgoingpassword Edm.String

Type the password for outgoing email.

Display Name: Outgoing Email Password

outgoingportnumber Edm.Int32

Type the Exchange port number for outgoing mail.

Display Name: Outgoing Email Port

outgoingserverlocation Edm.String

Type the location of the server for outgoing email.

Display Name: Outgoing Email Server Location

outgoinguseimpersonation Edm.Boolean

Select whether to use impersonation for accessing the mailbox to process outgoing emails.

Display Name: Use Impersonation for Outgoing Email

Default Options
Value Label
1 Yes
0 No
outgoingusername Edm.String

Type the user name for outgoing email.

Display Name: Outgoing Email User Name

outgoingusessl Edm.Boolean

Select whether to use the Secure Sockets Layer (SSL) protocol for outgoing email.

Display Name: Use SSL for Outgoing Email

Default Options
Value Label
1 Yes
0 No
owneremailaddress Edm.String

Email Server Profile Owner's email address

Display Name: Email Server Profile Owner's email address

processemailsreceivedafter Edm.DateTimeOffset

Shows the date and time after which email messages that are received will be processed for mailboxes associated with the email server profile.

Display Name: Process Emails Received After

sendemailalert Edm.Boolean

Select whether to send an email alert if more than 50% of the mailboxes in this email server profile failed to synchronize in an hour period.

Display Name: Send an alert email to the owner of the email server profile reporting on major events

Default Options
Value Label
1 Yes
0 No
servertype Edm.Int32

Select the profile's email server type.

Display Name: Email Server Type

Default Options
Value Label
0 Exchange Server
1 Other (POP3/SMTP)
2 Exchange Server (Hybrid)
3 Exchange Online (Hybrid)
statecode Edm.Int32

Shows whether the email server profile is active or inactive.

Display Name: Status

Default Options
Value Label
0 Active
1 Inactive
statuscode Edm.Int32

Select the email server profile's status.

Display Name: Status Reason

Default Options
Value Label
1 Active
2 Inactive
timeoutmailboxconnection Edm.Boolean

Select whether to timeout a single mailbox.

Display Name: Timeout Mailbox Connection to Exchange

Default Options
Value Label
1 Yes
0 No
timeoutmailboxconnectionafteramount Edm.Int32

Type the number of milliseconds to timeout a single mailbox. The upper limit is 100 seconds.

Display Name: Timeout a Single Mailbox Connection After this Amount of Milliseconds

timezoneruleversionnumber Edm.Int32

For internal use only.

Display Name: Time Zone Rule Version Number

useautodiscover Edm.Boolean

Select whether to automatically discover the server location

Display Name: Auto Discover Server Location

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

Select whether to use the Exchange Online Tenant ID obtained from running Microsoft Azure PowerShell cmdlets (highly recommended). If you select No, you can edit this field manually

Display Name: Use Default Tenant Id

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

Select whether to use the same settings for incoming and outgoing connections.

Display Name: Use Same Settings for Outgoing Connection

Default Options
Value Label
1 Yes
0 No
utcconversiontimezonecode Edm.Int32

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

Display Name: UTC Conversion Time Zone Code

versionnumber Edm.Int64

Version number of the email server profile.

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.

_incomingpartnerapplication_value createdby

Indicates the incoming partner application.

_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.

_outgoingpartnerapplication_value createdby

Indicates the outgoing partner application.

_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 createdby

Unique identifier for the user that owns the record.

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_emailserverprofile_createdby
createdonbehalfby systemuser lk_emailserverprofile_createdonbehalfby
modifiedby systemuser lk_emailserverprofile_modifiedby
modifiedonbehalfby systemuser lk_emailserverprofile_modifiedonbehalfby
organizationid organization organization_emailserverprofile
ownerid principal owner_emailserverprofile
owningbusinessunit businessunit business_unit_emailserverprofile
owningteam team team_emailserverprofile

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
EmailServerProfile_Annotation annotation objectid_emailserverprofile
emailserverprofile_asyncoperations asyncoperation regardingobjectid_emailserverprofile
emailserverprofile_bulkdeletefailures bulkdeletefailure regardingobjectid_emailserverprofile
emailserverprofile_duplicatebaserecord duplicaterecord baserecordid_emailserverprofile
emailserverprofile_duplicatematchingrecord duplicaterecord duplicaterecordid_emailserverprofile
emailserverprofile_mailbox mailbox emailserverprofile
EmailServerProfile_Organization organization defaultemailserverprofileid
EmailServerProfile_SyncErrors syncerror regardingobjectid_emailserverprofile_syncerror
tracelog_EmailServerProfile tracelog regardingobjectid_emailserverprofile

Operations

The following operations can be used with the emailserverprofile 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 emailserverprofile entity type.

Name Description
System Solution Internal CRM System Solution

See also