emailserverprofile EntityType

Namespace:

Microsoft.Dynamics.CRM

Holds the Email Server Profiles of an organization

Entity set path: 

[organization URI]/api/data/v9.2/emailserverprofiles

Base type: 

crmbaseentity

Table type: 

Standard

Display name: 

Email Server Profile

Primary key: 

emailserverprofileid

Primary name column: 

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
aadresourceid	Edm.String	Microsoft Entra resource ID used for OAuth athentication scheme Display name: Microsoft Entra resource ID
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 Values 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 Values Label 0 Auto Detect 1 Negotiate 2 NTLM 3 Basic 4 OAuth
incomingcredentialretrieval	Edm.Int32	Select how credentials will be retrieved for incoming email. Display name: Incoming Email Credential Retrieval Default options Values 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) 5 Gmail OAuth 6 Exchange Hybrid Modern Auth (HMA) 7 OAuth with Microsoft Entra ID
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 Values 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 Values Label 1 Yes 0 No
isincomingpasswordset	Edm.Boolean	Read only Default options Values Label 1 Yes 0 No
isoauthclientsecretset	Edm.Boolean	Read only Default options Values Label 1 Yes 0 No
isoutgoingpasswordset	Edm.Boolean	Read only Default options Values 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 Values 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 Values 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 Values 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 Values 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
oauthclientid	Edm.String	ClientId used for OAuth athentication scheme Display name: Oauth ClientId
oauthclientsecret	Edm.String	Client secret used for the OAuth authentication scheme Display name: OAuth Client Secret
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 Values Label 0 Auto Detect 1 Negotiate 2 NTLM 3 Basic 4 OAuth
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 Values 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 Values 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) 5 Gmail OAuth 6 Exchange Hybrid Modern Auth (HMA) 7 OAuth with Microsoft Entra ID
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 Values 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 Values 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 Values Label 1 Yes 0 No
serverauthority	Edm.Int32	Select the authority for the email server. Display name: Email server authority Default options Values Label 0 Public (+GCC) (https://login.microsoftonline.com) 1 US Government (GCC High and DoD) (https://login.microsoftonline.us) 2 China (21Vianet) (https://login.chinacloudapi.cn) 3 Automatic (determined by Dynamics 365 cloud)
servertype	Edm.Int32	Select the profile's email server type. Display name: Email Server Type Default options Values Label 0 Exchange Server 1 Other (POP3/SMTP) 2 Exchange Server (Hybrid) 3 Exchange Online (Hybrid) 4 IMAP/SMTP
statecode	Edm.Int32	Shows whether the email server profile is active or inactive. Display name: Status Default options Values Label 0 Active 1 Inactive
statuscode	Edm.Int32	Select the email server profile's status. Display name: Status Reason Default options Values Label 1 Active 2 Inactive
timeoutmailboxconnection	Edm.Boolean	Select whether to timeout a single mailbox. Display name: Timeout Mailbox Connection to Exchange Default options Values 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 Values 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 Values 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 Values 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 Lookup property data.

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.
_keyvaultreferenceid_value	keyvaultreferenceid	The Azure Key Vault reference id
_managedidentityid_value	managedidentityid	The managed identity id
_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.

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
keyvaultreferenceid	keyvaultreference	keyvaultreference_emailserverprofile_keyvaultreferenceid
managedidentityid	managedidentity	managedidentity_emailserverprofile_managedidentityid
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

See also

• Use the Microsoft Dataverse Web API
• Web API Entity Type Reference
• Web API Action Reference
• Web API Function Reference
• Web API Query Function Reference
• Web API Complex Type Reference
• Web API Enum Type Reference
• Web API Metadata Entity Type Reference