Email entity messages and methods

Article
11/28/2016

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

This entity represents an activity that’s delivered using email protocols. The schema name for this entity is Email. To view the entity metadata for your organization, install the Metadata Browser solution described in Browse the metadata for your organization. You can also view the metadata for an uncustomized organization in the Excel file called EntityMetadata.xlsx included in the top-level folder of the SDK download.

The following table describes the messages for this entity, which you use with the IOrganizationService.Execute method.

Message	Description
AssignRequest	Assigns an email message to another user or team.
AssociateRequest	Creates a link between a record and one or more records that participate in a relationship. You can also use the IOrganizationService.Associate method. For more information, see Actions on entity records. For a list of default relationships for this entity, see the Email entity metadata. You can find this information in the metadata for your organization. See the preceding metadata browser information.
BackgroundSendEmailRequest	Sends an email message asynchronously.
CheckIncomingEmailRequest	Checks whether the incoming email message should be tracked in Microsoft Dynamics 365.
CheckPromoteEmailRequest	Checks whether the incoming email message should be promoted to the Microsoft Dynamics 365 system.
CreateRequest	Creates an email. You can also call the IOrganizationService.Create method.
DeleteRequest	Deletes an email. You can also call the IOrganizationService.Delete method.
DeliverIncomingEmailRequest	Routes the email message to the appropriate system users or contacts.
DeliverPromoteEmailRequest	Creates an email activity instance from the specified email message.
DisassociateRequest	Removes a link between a record and one or more records that participate in a relationship. You can also use the IOrganizationService.Disassociate method. For more information, see Actions on entity records. For a list of default relationships for this entity, see the Email entity metadata. You can find this information in the metadata for your organization. See the preceding metadata browser information.
GetDecryptionKeyRequest	Obtains the key used for encrypting or decrypting a user's or queue's email credentials stored in the Microsoft Dynamics 365 database.
GetTrackingTokenEmailRequest	Gets a tracking token that can be passed in as a parameter to the SendEmailRequest message.
GrantAccessRequest	Shares an email with another security principal (user or team).
InitializeFromRequest	Initializes a new record from an existing record provided that an attribute map is defined for the two entities. For more information, see Customize entity and attribute mappings.
ProcessInboundEmailRequest	Processes marketing campaign email responses.
RetrieveDuplicatesRequest	Detects and retrieves duplicate records for the specified record provided that duplicate detection is enabled and there are published duplicate detection rules for the entity. For more information, see Detect duplicate data.
RetrieveRequest	Retrieves an email message. You can also call the IOrganizationService.Retrieve method.
RetrieveMultipleRequest	Retrieves a collection of emails. You can also call the IOrganizationService.RetrieveMultiple method.
RetrievePrincipalAccessRequest	Retrieves the access that the specified security principal (user or team) has to an email message.
RetrieveSharedPrincipalsAndAccessRequest	Retrieves all the security principals (users or teams) that have access to an email message, and their access rights to the message.
RevokeAccessRequest	Removes all access to an email message for the specified security principal (user or team).
SendBulkMailRequest	Sends bulk email messages.
SendEmailRequest	Sends an email message.
SendEmailFromTemplateRequest	Sends an email message using a template.
SetStateRequest	Sets the state of an email message. The possible states are defined in the Email.Statecode attribute. If you use early bound types, use the EmailState enumeration. For a list of possible states, see the Email entity metadata. You can find this information in the metadata for your organization. See the preceding metadata browser information.
UpdateRequest	Updates an email message. You can also call the IOrganizationService.Update method.

Share via

Email entity messages and methods

See Also

Additional resources