E-mail (email) Entity Capabilities

banner art

[Applies to: Microsoft Dynamics CRM 4.0]

Find the latest SDK documentation: CRM 2015 SDK

This entity represents an activity that is delivered using e-mail protocols.

The following illustration shows the entity relationships for this area. For more information, see Key to Entity Diagrams.

E-mail entity model

The class for this entity is email. For the e-mail entity, you can use the messages listed in the following table with the Execute method.

Message Description
BackgroundSendEmail Use this message to send an e-mail asynchronously.
CheckIncomingEmail Use this message to check whether the incoming e-mail message is relevant to the Microsoft Dynamics CRM system.
CheckPromoteEmail Use this message to check whether the incoming e-mail message should be promoted to the Microsoft Dynamics CRM system.
Create Use this message to create an e-mail.

The information that is used to create the entity instance is specified in the TargetCreateEmail class.

You can also call the Create method.

Delete Use this message to delete an e-mail.

The entity instance to delete is specified in the TargetDeleteEmail class.

You can also call the Delete method.

DeliverIncomingEmail Use this message to route the e-mail to the appropriate set of system users or contacts.
DeliverPromoteEmail Use this message to create an e-mail activity instance from the specified e-mail message.
DetachFromQueueEmail Use this message to detach the e-mail from the specified queue.
Handle Use this message to handle an e-mail that is in a queue.

The entity instance to retrieve is specified in the TargetQueuedEmail class.

ProcessInboundEmail Use this message to process marketing campaign e-mail responses.
Retrieve Use this message to retrieve an e-mail.

The entity instance to retrieve is specified in the TargetRetrieveEmail class.

You can also call the Retrieve method.

RetrieveMultiple Use this message to retrieve a collection of e-mails.

The query expression that describes the entity instances to retrieve is specified in the Query property of this request.

You can also call the RetrieveMultiple method.

RetrievePrincipalAccess Use this message to retrieve the access that the specified security principal (user or team) has to an e-mail.

The entity instance to retrieve is specified in the TargetOwnedEmail class.

Route Use this message to route an e-mail to a queue.

The entity instance to retrieve is specified in the TargetQueuedEmail class.

SendEmail Use this message to send an e-mail.
SetStateDynamicEntity Use this message to set the state of an e-mail using a DynamicEntity instance.

The possible states are defined in the EmailState enumeration.

SetStateEmail Use this message to set the state of an e-mail.

The possible states are defined in the EmailState enumeration.

Update Use this message to update an e-mail.

The entity instance to update is specified in the TargetUpdateEmail class.

You can also use the Update method.

See Also

Concepts

Other Resources

© 2010 Microsoft Corporation. All rights reserved.