SendTemplateRequest Class

 

Applies To: Dynamics CRM 2015

Contains the data that is needed to send a bulk email message that is created from a template.

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.SendTemplateRequest

Syntax

[DataContractAttribute(Namespace = "http://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class SendTemplateRequest : OrganizationRequest
[DataContractAttribute(Namespace = "http://schemas.microsoft.com/crm/2011/Contracts")]
public ref class SendTemplateRequest sealed : OrganizationRequest
[<Sealed>]
[<DataContractAttribute(Namespace = "http://schemas.microsoft.com/crm/2011/Contracts")>]
type SendTemplateRequest = 
    class
        inherit OrganizationRequest
    end
<DataContractAttribute(Namespace := "http://schemas.microsoft.com/crm/2011/Contracts")>
Public NotInheritable Class SendTemplateRequest
    Inherits OrganizationRequest

Constructors

Name Description
System_CAPS_pubmethod SendTemplateRequest()

Initializes a new instance of the SendTemplateRequest class.

Properties

Name Description
System_CAPS_pubproperty DeliveryPriorityCode

Gets or sets the delivery priority code for the email.

System_CAPS_pubproperty ExtensionData

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

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 RecipientIds

Gets or sets the array that contains the list of recipients for the email. Required.

System_CAPS_pubproperty RecipientType

Gets or sets the type of entity that is represented by the list of recipients. Required.

System_CAPS_pubproperty RegardingId

Gets or sets the ID of a record that the email is regarding. Required.

System_CAPS_pubproperty RegardingType

Gets or sets the type of entity that is represented by the regarding ID. Required.

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.)

System_CAPS_pubproperty Sender

Gets or sets the sender of the email.

System_CAPS_pubproperty TemplateId

Gets or sets the ID of the template to be used for the email. Required.

Methods

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.)

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 method, which returns an instance of the SendTemplateResponse class.

Privileges and Access Rights

To perform this action, the caller must have privileges on the Template entity and access rights on the specified record in the TemplateId property. For a list of the required privileges, see SendTemplate message privileges.

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

SendTemplateResponse
Microsoft.Crm.Sdk.Messages Namespace
Email activity entities
Template (email template) entity messages and methods

Return to top

© 2016 Microsoft. All rights reserved. Copyright