ProcessInboundEmailRequest Class

  • Reference

Definition

Namespace:
Microsoft.Crm.Sdk.Messages
Assembly:
Microsoft.Crm.Sdk.Proxy.dll
Package:
Microsoft.PowerPlatform.Dataverse.Client v1.1.17

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

public ref class ProcessInboundEmailRequest sealed : Microsoft::Xrm::Sdk::OrganizationRequest
[System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class ProcessInboundEmailRequest : Microsoft.Xrm.Sdk.OrganizationRequest
[<System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/crm/2011/Contracts")>]
type ProcessInboundEmailRequest = class
    inherit OrganizationRequest
Public NotInheritable Class ProcessInboundEmailRequest
Inherits OrganizationRequest
Inheritance
Object
OrganizationRequest
ProcessInboundEmailRequest
Attributes
DataContractAttribute

Remarks

For the Web API use the ProcessInboundEmail action.

Usage

Pass an instance of this class to the Execute(OrganizationRequest) 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.

Constructors

ProcessInboundEmailRequest()

Initializes a new instance of the ProcessInboundEmailRequest class.

Properties

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 the request. Optional.

(Inherited from OrganizationRequest)
RequestName

Gets or sets the name of the request. Required, but is supplied by derived classes.

(Inherited from OrganizationRequest)

Applies to

See also