GetTrackingTokenEmailRequest Class

Definition

Contains the data that is needed to return a tracking token that can then be passed as a parameter to the SendEmailRequest message.

For the Web API use the GetTrackingTokenEmail Action.

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

Remarks

Message Availability

This message works regardless whether the caller is connected to the server or offline.

Usage

Pass an instance of this class to the Execute(OrganizationRequest) method, which returns an instance of the GetTrackingTokenEmailResponse class.

Privileges and Access Rights

To perform this action, the caller must have privileges on the Email entity. For a complete list of the required privileges, see GetTrackingTokenEmail message privileges.

Notes for Callers

The tracking token is used to correlate an email with a context that is specified in the Subject property.

This API is designed to return an auto incrementing tracking token when the caller is a regular user. The API returns a static token "1" formatted in the configured organization-level tracking token format when the caller is a special system user: SYSTEM, INTEGRATION USER.

Constructors

GetTrackingTokenEmailRequest()

Initializes a new instance of the GetTrackingTokenEmailRequest class.

Properties

ExtensionData

Gets or sets the structure that contains extra data. Optional.

(Inherited from OrganizationRequest)
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)
Subject

Gets or sets the context of the email. Required.

Applies to

See also