SendEmailFromTemplateRequest Class

Article
06/20/2014

Applies To: Microsoft Dynamics CRM 2013, Microsoft Dynamics CRM Online

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

Namespace: Microsoft.Crm.Sdk.Messages
Assembly: Microsoft.Crm.Sdk.Proxy (in Microsoft.Crm.Sdk.Proxy.dll)

Syntax

'Declaration
<DataContractAttribute(Namespace:="https://schemas.microsoft.com/crm/2011/Contracts")> _
Public NotInheritable Class SendEmailFromTemplateRequest
    Inherits OrganizationRequest

[DataContractAttribute(Namespace="https://schemas.microsoft.com/crm/2011/Contracts")] 
public sealed class SendEmailFromTemplateRequest : OrganizationRequest

Example

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.


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

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

Console.WriteLine("Created activity parties.");

// Create an e-mail message.
Email 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"

QueryExpression queryBuildInTemplates = new QueryExpression{
    EntityName = "template",
    ColumnSet = new ColumnSet("templateid", "templatetypecode"),
    Criteria = new FilterExpression()
};
queryBuildInTemplates.Criteria.AddCondition("templatetypecode",
    ConditionOperator.Equal, "contact");
EntityCollection templateEntityCollection = _serviceProxy.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
SendEmailFromTemplateRequest 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
};

SendEmailFromTemplateResponse emailUsingTemplateResp = (SendEmailFromTemplateResponse)_serviceProxy.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.");
}


' Create the 'From:' activity party for the email
Dim fromParty As ActivityParty = New ActivityParty With {.PartyId = New EntityReference(SystemUser.EntityLogicalName, _userId)}

' Create the 'To:' activity party for the email
Dim toParty As ActivityParty = New ActivityParty With {.PartyId = New EntityReference(Contact.EntityLogicalName, _contactId)}

Console.WriteLine("Created activity parties.")

' Create an e-mail message.
Dim email As Email = New Email With {.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"

Dim queryBuildInTemplates As QueryExpression = New QueryExpression With {.EntityName = "template", .ColumnSet = New ColumnSet("templateid", "templatetypecode"), .Criteria = New FilterExpression()}
queryBuildInTemplates.Criteria.AddCondition("templatetypecode", ConditionOperator.Equal, "contact")
Dim templateEntityCollection As EntityCollection = _serviceProxy.RetrieveMultiple(queryBuildInTemplates)

If templateEntityCollection.Entities.Count > 0 Then
    _templateId = CType(templateEntityCollection.Entities(0).Attributes("templateid"), Guid)
Else
    Throw New ArgumentException("Standard Email Templates are missing")
End If

' Create the request
Dim emailUsingTemplateReq As SendEmailFromTemplateRequest = New SendEmailFromTemplateRequest With {.Target = email, _
                .TemplateId = _templateId, .RegardingId = _contactId, _
                .RegardingType = Contact.EntityLogicalName}
' Use a built-in Email Template of type "contact".
' The regarding Id is required, and must be of the same type as the Email Template.

Dim emailUsingTemplateResp As SendEmailFromTemplateResponse = CType(_serviceProxy.Execute(emailUsingTemplateReq),  _
                SendEmailFromTemplateResponse)

' Verify that the e-mail has been created
_emailId = emailUsingTemplateResp.Id
If Not _emailId.Equals(Guid.Empty) Then
    Console.WriteLine("Successfully sent an e-mail message using the template.")
End If

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

Inheritance Hierarchy

System.Object
Microsoft.Xrm.Sdk.OrganizationRequest
Microsoft.Crm.Sdk.Messages.SendEmailFromTemplateRequest

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.

Platforms

Development Platforms

Windows Server 2008, Windows Server 2012, Windows 7 (All Versions), Windows 8 (All Versions)

Target Platforms

Windows Server 2008, ,Windows Server 2012, ,Windows 7 (All Versions),

SendEmailFromTemplateRequest Class

Syntax

Example

Remarks

Inheritance Hierarchy

Thread Safety

Platforms

Development Platforms

Target Platforms

Change History

See Also

Reference

Other Resources

Additional resources