ProcessInboundEmailRequest Class

Article
11/28/2016

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

System.Object
Microsoft.Xrm.Sdk.OrganizationRequest
Microsoft.Crm.Sdk.Messages.ProcessInboundEmailRequest

Syntax

[DataContractAttribute(Namespace = "https://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class ProcessInboundEmailRequest : OrganizationRequest

<DataContractAttribute(Namespace := "https://schemas.microsoft.com/crm/2011/Contracts")>
Public NotInheritable Class ProcessInboundEmailRequest
    Inherits OrganizationRequest

Constructors

	Name	Description
	ProcessInboundEmailRequest()	Initializes a new instance of the ProcessInboundEmailRequest class.

Properties

	Name	Description
	ExtensionData	Gets or sets the structure that contains extra data. Optional.(Inherited from OrganizationRequest.)
	InboundEmailActivity	Gets or sets the ID of the inbound email activity.
	Item[String]	Gets or sets the indexer for the Parameters collection.(Inherited from OrganizationRequest.)
	Parameters	Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)
	RequestId	Gets or sets the ID of an asynchronous operation (system job). Optional. (Inherited from OrganizationRequest.)
	RequestName	Gets or sets the name of the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)

Methods

	Name	Description
	Equals(Object)	(Inherited from Object.)
	GetHashCode()	(Inherited from Object.)
	GetType()	(Inherited from Object.)
	ToString()	(Inherited from Object.)

Remarks

Message Availability

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

Usage

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:

A user executes a marketing campaign.
Email messages are generated and sent to a list of contacts. Optionally, the messages can contain an unsubscribe link.
A customer (contact) replies to the generated email.

A call to this message does the following:

Creates a campaign response record.
If the response is an unsubscribe reply, the contact.donotbulkemail property for the contact is set to true.
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.