SendBulkMailRequest SendBulkMailRequest SendBulkMailRequest SendBulkMailRequest Class

Definition

Contains the data that is needed to send bulk email messages.

For the Web API use the SendBulkMail Action .

Web API support for this message was added with December 2016 update for Microsoft Dynamics 365 (online) and December 2016 Service Pack for Microsoft Dynamics 365 (on-premises) .

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

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(OrganizationRequest) method, which returns an instance of SendBulkMailResponse.

Privileges and Access Rights

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

Notes for Callers

To specify the tracking parameter, set the RequestId property as follows:

request.RequestId = trackingId;

Constructors

SendBulkMailRequest() SendBulkMailRequest() SendBulkMailRequest() SendBulkMailRequest()

Initializes a new instance of theSendBulkMailRequest class.

Properties

ExtensionData ExtensionData ExtensionData ExtensionData

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

(Inherited from OrganizationRequest)
Item[String] Item[String] Item[String] Item[String]

Gets or sets the indexer for the Parameters collection.

(Inherited from OrganizationRequest)
Parameters Parameters Parameters Parameters

Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.

(Inherited from OrganizationRequest)
Query Query Query Query

Gets or sets the query to retrieve the recipients for the email messages.

RegardingId RegardingId RegardingId RegardingId

Gets or sets the ID of the record with which the email messages are associated.

RegardingType RegardingType RegardingType RegardingType

Gets or sets the type of the record with which the email messages are associated.

RequestId RequestId RequestId RequestId

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

(Inherited from OrganizationRequest)
RequestName RequestName RequestName RequestName

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

(Inherited from OrganizationRequest)
Sender Sender Sender Sender

Gets or sets the sender of the email messages.

TemplateId TemplateId TemplateId TemplateId

Gets or sets the ID of the email template to use.

Applies to

See also