SendBulkMailRequest Class

Reference

Definition

Namespace:: Microsoft.Crm.Sdk.Messages

Assembly:: Microsoft.Crm.Sdk.Proxy.dll

Package:: Microsoft.PowerPlatform.Dataverse.Client v1.1.17

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

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

[<System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/crm/2011/Contracts")>]
type SendBulkMailRequest = class
    inherit OrganizationRequest

Public NotInheritable Class SendBulkMailRequest
Inherits OrganizationRequest

Inheritance: Object

OrganizationRequest
SendBulkMailRequest

Attributes: DataContractAttribute

Remarks

For the Web API use the SendBulkMail action.

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.

Notes for Callers

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

request.RequestId = trackingId;

Constructors

SendBulkMailRequest()

Initializes a new instance of theSendBulkMailRequest 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)
Query	Gets or sets the query to retrieve the recipients for the email messages.
RegardingId	Gets or sets the ID of the record with which the email messages are associated.
RegardingType	Gets or sets the type of the record with which the email messages are associated.
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)
Sender	Gets or sets the sender of the email messages.
TemplateId	Gets or sets the ID of the email template to use.

Applies to