ProcessInboundEmailRequest Class


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

Contains the data that is needed to process the email responses from a marketing campaign.

For the Web API use the ProcessInboundEmail Action.

Namespace:   Microsoft.Crm.Sdk.Messages
Assembly:  Microsoft.Crm.Sdk.Proxy (in Microsoft.Crm.Sdk.Proxy.dll)

Inheritance Hierarchy



[DataContractAttribute(Namespace = "")]
public sealed class ProcessInboundEmailRequest : OrganizationRequest
<DataContractAttribute(Namespace := "")>
Public NotInheritable Class ProcessInboundEmailRequest
    Inherits OrganizationRequest


Name Description
System_CAPS_pubmethod ProcessInboundEmailRequest()

Initializes a new instance of the ProcessInboundEmailRequest class.


Name Description
System_CAPS_pubproperty ExtensionData

Gets or sets the structure that contains extra data. Optional.(Inherited from OrganizationRequest.)

System_CAPS_pubproperty InboundEmailActivity

Gets or sets the ID of the inbound email activity.

System_CAPS_pubproperty Item[String]

Gets or sets the indexer for the Parameters collection.(Inherited from OrganizationRequest.)

System_CAPS_pubproperty Parameters

Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)

System_CAPS_pubproperty RequestId

Gets or sets the ID of an asynchronous operation (system job). Optional. (Inherited from OrganizationRequest.)

System_CAPS_pubproperty RequestName

Gets or sets the name of the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)


Name Description
System_CAPS_pubmethod Equals(Object)

(Inherited from Object.)

System_CAPS_pubmethod GetHashCode()

(Inherited from Object.)

System_CAPS_pubmethod GetType()

(Inherited from Object.)

System_CAPS_pubmethod ToString()

(Inherited from Object.)


Message Availability

For this message to work, the caller must be connected to the server.


Pass an instance of this class to the Execute method, which returns an instance of the ProcessInboundEmailResponse class.

Privileges and Access Rights

To perform this action, the caller must have privileges on the Email entity and access rights on the specified record in the InboundEmailActivity property. For a complete list of the required privileges, see ProcessInboundEmail message privileges.

Notes for Callers

This message is used in the following scenario:

  1. A user executes a marketing campaign.

  2. Email messages are generated and sent to a list of contacts. Optionally, the messages can contain an unsubscribe link.

  3. A customer (contact) replies to the generated email.

A call to this message does the following:

  1. Creates a campaign response record.

  2. If the response is an unsubscribe reply, the contact.donotbulkemail property for the contact is set to true.

  3. If the response is an unsubscribe reply and the organization.allow property is true, an unsubscribe confirmation email is sent.

Thread Safety

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Microsoft.Crm.Sdk.Messages Namespace
Email activity entities
Email entity messages and methods

Return to top

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright