SendBulkMailRequest Class
Applies To: Dynamics CRM 2015
Contains the data that is needed to send bulk email messages.
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.SendBulkMailRequest
Syntax
[DataContractAttribute(Namespace = "https://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class SendBulkMailRequest : OrganizationRequest
[DataContractAttribute(Namespace = "https://schemas.microsoft.com/crm/2011/Contracts")]
public ref class SendBulkMailRequest sealed : OrganizationRequest
[<Sealed>]
[<DataContractAttribute(Namespace = "https://schemas.microsoft.com/crm/2011/Contracts")>]
type SendBulkMailRequest =
class
inherit OrganizationRequest
end
<DataContractAttribute(Namespace := "https://schemas.microsoft.com/crm/2011/Contracts")>
Public NotInheritable Class SendBulkMailRequest
Inherits OrganizationRequest
Constructors
Name | Description | |
---|---|---|
SendBulkMailRequest() | Initializes a new instance of theSendBulkMailRequest class. |
Properties
Name | Description | |
---|---|---|
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 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.) |
|
Sender | Gets or sets the sender of the email messages. |
|
TemplateId | Gets or sets the ID of the email template to use. |
Methods
Name | Description | |
---|---|---|
Equals(Object) | (Inherited from Object.) |
|
GetHashCode() | (Inherited from Object.) |
|
GetType() | (Inherited from Object.) |
|
ToString() | (Inherited from Object.) |
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 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;
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
SendBulkMailResponse
Microsoft.Crm.Sdk.Messages Namespace
Email activity entities
Email entity messages and methods
Return to top
© 2016 Microsoft. All rights reserved. Copyright