SendEmailFromTemplateRequest Class

Definition

Contains the data that is needed to send an email message using a template.

For the Web API use the SendEmailFromTemplate Action.

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

Examples

// Create the 'From:' activity party for the email
var fromParty = new ActivityParty
{
    PartyId = new EntityReference(SystemUser.EntityLogicalName, _userId)
};

// Create the 'To:' activity party for the email
var toParty = new ActivityParty
{
    PartyId = new EntityReference(Contact.EntityLogicalName, _contactId)
};
Console.WriteLine("Created activity parties.");

// Create an e-mail message.
var email = new Email
{
    To = new ActivityParty[] { toParty },
    From = new ActivityParty[] { fromParty },
    Subject = "SDK Sample e-mail",
    Description = "SDK Sample for SendEmailFromTemplate Message.",
    DirectionCode = true
};

//Create a query expression to get one of Email Template of type "contact"
var queryBuildInTemplates = new QueryExpression{
    EntityName = "template",
    ColumnSet = new ColumnSet("templateid", "templatetypecode"),
    Criteria = new FilterExpression()
};

queryBuildInTemplates.Criteria.AddCondition("templatetypecode",
    ConditionOperator.Equal, "contact");
EntityCollection templateEntityCollection = svc.RetrieveMultiple(queryBuildInTemplates);

  if (templateEntityCollection.Entities.Count > 0) 
{
    _templateId = (Guid)templateEntityCollection.Entities[0].Attributes["templateid"];
}
else
{
    throw new ArgumentException("Standard Email Templates are missing");
}             

// Create the request
var emailUsingTemplateReq = new SendEmailFromTemplateRequest
{
    Target = email,

    // Use a built-in Email Template of type "contact".
    TemplateId = _templateId,

    // The regarding Id is required, and must be of the same type as the Email Template.
    RegardingId = _contactId,
    RegardingType = Contact.EntityLogicalName
};
    var emailUsingTemplateResp = (SendEmailFromTemplateResponse)svc.Execute(emailUsingTemplateReq);

// Verify that the e-mail has been created
_emailId = emailUsingTemplateResp.Id;
if (!_emailId.Equals(Guid.Empty))
{
    Console.WriteLine("Successfully sent an e-mail message using the template.");
}

The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an IOrganizationService interface. For the complete sample, see the link later in this topic.

Activities#SendEmailUsingTemplate1 ActivitiesVB#SendEmailUsingTemplate1

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

Privileges and Access Rights

To perform this action, the caller must have privileges on the Email entity and access rights on the records specified in the Target, RegardingId and TemplateId properties. For a complete list of the privileges required, see SendEmailFromTemplate message privileges.

Constructors

SendEmailFromTemplateRequest()

Initializes a new instance of theSendEmailFromTemplateRequest 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)
RegardingId

Gets or sets the ID of the record with which the email message is associated.

RegardingType

Gets or sets the type of the record with which the email message is 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)
Target

Gets or sets the email record to send.

TemplateId

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

Applies to

See also