emailserverprofile EntityType

Dynamics CRM 2016
 

Updated: November 29, 2016

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

Description: Holds the Email Server Profiles of an organization

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

Base Type: crmbaseentity EntityType

Display Name: Email Server Profile

Primary Key: emailserverprofileid

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

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

defaultserverlocation

Edm.String

Description: Type the default location of the server.

Display Name: Default Email Server Location

description

Edm.String

Description: Type additional information that describes the email server profile.

Display Name: Description

emailserverprofileid

Edm.Guid

Description: Unique identifier of the email server profile.

Display Name: EmailServerProfile

emailservertypename

Edm.String

Description: Email Server Type Name

Display Name: Email Server Type Name

Read-only property

encodingcodepage

Edm.String

Description: Indicates the code page to use when encoding email content.

Display Name: Encoding Code Page

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

exchangeonlinetenantid

Edm.String

Description: Type the tenant ID of Exchange Online.

Display Name: Exchange Online Tenant Id

exchangeversion

Edm.Int32

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

Default Options:

0 : Exchange 2007
1 : Exchange 2007 SP1
2 : Exchange 2010
3 : Exchange 2010 SP1
4 : Exchange 2010 SP2
5 : Exchange 2013

Display Name: Exchange Version

incomingauthenticationprotocol

Edm.Int32

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

Default Options:

0 : Auto Detect
1 : Negotiate
2 : NTLM
3 : Basic

Display Name: Incoming Authentication Protocol

incomingcredentialretrieval

Edm.Int32

Description: Select how credentials will be retrieved for incoming email.

Default Options:

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)

Display Name: Incoming Email Credential Retrieval

incomingpassword

Edm.String

Description: Type the password for incoming email.

Display Name: Incoming Email Password

incomingportnumber

Edm.Int32

Description: Type the Exchange port number for incoming mail.

Display Name: Incoming Email Port

incomingserverlocation

Edm.String

Description: Type the location of the server for incoming email.

Display Name: Incoming Email Server Location

incominguseimpersonation

Edm.Boolean

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

Default Options:

1 : Yes
0 : No

Display Name: Use Impersonation for Incoming Email

incomingusername

Edm.String

Description: Type the user name for incoming email.

Display Name: Incoming Email User Name

incomingusessl

Edm.Boolean

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

Default Options:

1 : Yes
0 : No

Display Name: Use SSL for Incoming Email

isincomingpasswordset

Edm.Boolean

Description:

Default Options:

1 : Yes
0 : No

Read-only property

isoutgoingpasswordset

Edm.Boolean

Description:

Default Options:

1 : Yes
0 : No

Read-only property

lastauthorizationstatus

Edm.Int32

Description: Shows the last test authorization status of email server profile

Default Options:

0 : Failure
1 : Success

Display Name: Last Test Authorization Status

lastcrmmessage

Edm.String

Description: Shows the Dynamics 365 message obtained during the Last Test

Display Name: Last Dynamics 365 Message

lasttestexecutionstatus

Edm.Int32

Description: Shows the last test Execution status of email server profile

Default Options:

0 : Failure
1 : Success
2 : Warning

Display Name: Last Test Execution Status

lasttestrequest

Edm.String

Description: Shows the EWS Request created during the Last Test

Display Name: Last Test Request

lasttestresponse

Edm.String

Description: Shows the EWS Response obtained during the Last Test

Display Name: Last Test Response

lastteststarttime

Edm.DateTimeOffset

Description: Shows the Last Test Start date and time

Display Name: Last Test Time

lasttesttotalexecutiontime

Edm.Int64

Description: Shows the Time taken while running the last test

Display Name: Last Test Time Taken

lasttestvalidationstatus

Edm.Int32

Description: Shows the last test Validation status of email server profile

Default Options:

0 : Failure
1 : Success

Display Name: Last Test Validation Status

maxconcurrentconnections

Edm.Int32

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

Display Name: Maximum Concurrent Connections

minpollingintervalinminutes

Edm.Int32

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

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

moveundeliveredemails

Edm.Boolean

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

Default Options:

1 : Yes
0 : No

Display Name: Move Undelivered Emails to the Undeliverable Folder

name

Edm.String

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

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

Default Options:

0 : Auto Detect
1 : Negotiate
2 : NTLM
3 : Basic

Display Name: Outgoing Authentication Protocol

outgoingautograntdelegateaccess

Edm.Boolean

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

Default Options:

1 : Yes
0 : No

Display Name: Auto Grant Delegate Access for Outgoing Email.

outgoingcredentialretrieval

Edm.Int32

Description: Select how credentials will be retrieved for outgoing email.

Default Options:

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)

Display Name: Outgoing Email Credential Retrieval

outgoingpassword

Edm.String

Description: Type the password for outgoing email.

Display Name: Outgoing Email Password

outgoingportnumber

Edm.Int32

Description: Type the Exchange port number for outgoing mail.

Display Name: Outgoing Email Port

outgoingserverlocation

Edm.String

Description: Type the location of the server for outgoing email.

Display Name: Outgoing Email Server Location

outgoinguseimpersonation

Edm.Boolean

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

Default Options:

1 : Yes
0 : No

Display Name: Use Impersonation for Outgoing Email

outgoingusername

Edm.String

Description: Type the user name for outgoing email.

Display Name: Outgoing Email User Name

outgoingusessl

Edm.Boolean

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

Default Options:

1 : Yes
0 : No

Display Name: Use SSL for Outgoing Email

owneremailaddress

Edm.String

Description: Email Server Profile Owner's email address

Display Name: Email Server Profile Owner's email address

processemailsreceivedafter

Edm.DateTimeOffset

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

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

Default Options:

1 : Yes
0 : No

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

servertype

Edm.Int32

Description: Select the profile's email server type.

Default Options:

0 : Exchange Server
1 : Other (POP3/SMTP)
2 : Exchange Server (Hybrid)
3 : Exchange Online (Hybrid)

Display Name: Email Server Type

statecode

Edm.Int32

Description: Shows whether the email server profile is active or inactive.

Default Options:

0 : Active
1 : Inactive

Display Name: Status

statuscode

Edm.Int32

Description: Select the email server profile's status.

Default Options:

1 : Active
2 : Inactive

Display Name: Status Reason

timeoutmailboxconnection

Edm.Boolean

Description: Select whether to timeout a single mailbox.

Default Options:

1 : Yes
0 : No

Display Name: Timeout Mailbox Connection to Exchange

timeoutmailboxconnectionafteramount

Edm.Int32

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

Description: For internal use only.

Display Name: Time Zone Rule Version Number

useautodiscover

Edm.Boolean

Description: Select whether to automatically discover the server location

Default Options:

1 : Yes
0 : No

Display Name: Auto Discover Server Location

usedefaulttenantid

Edm.Boolean

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

Default Options:

1 : Yes
0 : No

Display Name: Use Default Tenant Id

usesamesettingsforoutgoingconnections

Edm.Boolean

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

Default Options:

1 : Yes
0 : No

Display Name: Use Same Settings for Outgoing Connection

utcconversiontimezonecode

Edm.Int32

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

Display Name: UTC Conversion Time Zone Code

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

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

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

Unique identifier for the user that owns the record.

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_emailserverprofile_createdby

createdonbehalfby

systemuser EntityType

lk_emailserverprofile_createdonbehalfby

modifiedby

systemuser EntityType

lk_emailserverprofile_modifiedby

modifiedonbehalfby

systemuser EntityType

lk_emailserverprofile_modifiedonbehalfby

organizationid

organization EntityType

organization_emailserverprofile

ownerid

principal EntityType

owner_emailserverprofile

owningbusinessunit

businessunit EntityType

business_unit_emailserverprofile

owningteam

team EntityType

team_emailserverprofile

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 EntityType

objectid_emailserverprofile

emailserverprofile_asyncoperations

asyncoperation EntityType

regardingobjectid_emailserverprofile

emailserverprofile_bulkdeletefailures

bulkdeletefailure EntityType

regardingobjectid_emailserverprofile

emailserverprofile_duplicatebaserecord

duplicaterecord EntityType

baserecordid_emailserverprofile

emailserverprofile_duplicatematchingrecord

duplicaterecord EntityType

duplicaterecordid_emailserverprofile

emailserverprofile_mailbox

mailbox EntityType

emailserverprofile

EmailServerProfile_Organization

organization EntityType

defaultemailserverprofileid

EmailServerProfile_SyncErrors

syncerror EntityType

regardingobjectid_emailserverprofile_syncerror

tracelog_EmailServerProfile

tracelog EntityType

regardingobjectid_emailserverprofile

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright

Community Additions

ADD
Show: