Sample: Create an email using a template
Applies To: Dynamics CRM 2013
This sample code is for Microsoft Dynamics CRM 2013 and Microsoft Dynamics CRM Online. Download the Microsoft Dynamics CRM SDK package. It can be found in the following location in the download package:
SampleCode\CS\BusinessDataModel\Templates\CreateEmailUsingTemplate.cs
SampleCode\VB\BusinessDataModel\Templates\CreateEmailUsingTemplate.vb
Requirements
For more information about the requirements for running the sample code provided in this SDK, see Use the sample and helper code.
Demonstrates
This sample shows how to instantiate an email record using the InstantiateTemplateRequest message.
Example
using System;
using System.IO;
using System.Text;
using System.ServiceModel;
using System.Xml.Serialization;
using System.ServiceModel.Description;
// These namespaces are found in the Microsoft.Xrm.Sdk.dll assembly
// located in the SDK\bin folder of the SDK download.
using Microsoft.Xrm.Sdk;
using Microsoft.Xrm.Sdk.Query;
using Microsoft.Xrm.Sdk.Client;
using Microsoft.Xrm.Sdk.Messages;
// This namespace is found in Microsoft.Crm.Sdk.Proxy.dll assembly
// found in the SDK\bin folder.
using Microsoft.Crm.Sdk.Messages;
namespace Microsoft.Crm.Sdk.Samples
{
public class CreateEmailUsingTemplate
{
#region Class Level Members
// Define the IDs needed for this sample.
private Guid _accountId;
private Guid _templateId;
private OrganizationServiceProxy _serviceProxy;
#endregion Class Level Members
#region How To Sample Code
/// <summary>
/// Create an e-mail using a template.
/// </summary>
/// <param name="serverConfig">Contains server connection information.</param>
/// <param name="promptforDelete">When True, the user will be prompted to delete all
/// created entities.</param>
public void Run(ServerConnection.Configuration serverConfig, bool promptforDelete)
{
try
{
// Connect to the Organization service.
// The using statement assures that the service proxy will be properly disposed.
using (_serviceProxy = ServerConnection.GetOrganizationProxy(serverConfig))
{
// This statement is required to enable early-bound type support.
_serviceProxy.EnableProxyTypes();
CreateRequiredRecords();
// Use the InstantiateTemplate message to create an e-mail message using a template.
InstantiateTemplateRequest instTemplateReq = new InstantiateTemplateRequest
{
TemplateId = _templateId,
ObjectId = _accountId,
ObjectType = Account.EntityLogicalName
};
InstantiateTemplateResponse instTemplateResp = (InstantiateTemplateResponse)_serviceProxy.Execute(instTemplateReq);
// Serialize the email message to XML, and save to a file.
XmlSerializer serializer = new XmlSerializer(typeof(InstantiateTemplateResponse));
string filename = "email-message.xml";
using (StreamWriter writer = new StreamWriter(filename))
{
serializer.Serialize(writer, instTemplateResp);
}
Console.WriteLine("Created e-mail using the template.");
DeleteRequiredRecords(promptforDelete);
}
}
// Catch any service fault exceptions that Microsoft Dynamics CRM throws.
catch (FaultException<Microsoft.Xrm.Sdk.OrganizationServiceFault>)
{
// You can handle an exception here or pass it back to the calling method.
throw;
}
}
/// <summary>
/// Creates any entity records that this sample requires.
/// </summary>
public void CreateRequiredRecords()
{
// Create an account.
Account account = new Account
{
Name = "Fourth Coffee",
};
_accountId = _serviceProxy.Create(account);
Console.WriteLine("Created a sample account: {0}.", account.Name);
// Define the body and subject of the email template in XML format.
string bodyXml =
"<?xml version=\"1.0\" ?>"
+ "<xsl:stylesheet xmlns:xsl=\"http://www.w3.org/1999/XSL/Transform\" version=\"1.0\">"
+ "<xsl:output method=\"text\" indent=\"no\"/><xsl:template match=\"/data\">"
+ "<![CDATA["
+ "This message is to notify you that a new account has been created."
+ "]]></xsl:template></xsl:stylesheet>";
string subjectXml =
"<?xml version=\"1.0\" ?>"
+ "<xsl:stylesheet xmlns:xsl=\"http://www.w3.org/1999/XSL/Transform\" version=\"1.0\">"
+ "<xsl:output method=\"text\" indent=\"no\"/><xsl:template match=\"/data\">"
+ "<![CDATA[New account notification]]></xsl:template></xsl:stylesheet>";
string presentationXml =
"<template><text><![CDATA["
+ "This message is to notify you that a new account has been created."
+ "]]></text></template>";
string subjectPresentationXml =
"<template><text><![CDATA[New account notification]]></text></template>";
// Create an e-mail template.
Template template = new Template
{
Title = "Sample E-mail Template for Account",
Body = bodyXml,
Subject = subjectXml,
PresentationXml = presentationXml,
SubjectPresentationXml = subjectPresentationXml,
TemplateTypeCode = Account.EntityLogicalName,
LanguageCode = 1033, // For US English.
IsPersonal = false
};
_templateId = _serviceProxy.Create(template);
Console.WriteLine("Created {0}.", template.Title);
}
/// <summary>
/// Deletes any entity records that were created for this sample.
/// <param name="prompt">Indicates whether to prompt the user
/// to delete the records created in this sample.</param>
/// </summary>
public void DeleteRequiredRecords(bool prompt)
{
bool toBeDeleted = true;
if (prompt)
{
// Ask the user if the created entities should be deleted.
Console.Write("\nDo you want these entity records deleted? (y/n) [y]: ");
String answer = Console.ReadLine();
if (answer.StartsWith("y") ||
answer.StartsWith("Y") ||
answer == String.Empty)
{
toBeDeleted = true;
}
else
{
toBeDeleted = false;
}
}
if (toBeDeleted)
{
// Delete all records created in this sample.
_serviceProxy.Delete(Template.EntityLogicalName, _templateId);
_serviceProxy.Delete(Account.EntityLogicalName, _accountId); ;
Console.WriteLine("Entity record(s) have been deleted.");
}
}
#endregion How To Sample Code
#region Main method
/// <summary>
/// Main. Runs the sample and provides error output.
/// <param name="args">Array of arguments to Main method.</param>
/// </summary>
static public void Main(string[] args)
{
try
{
// Obtain the target organization's Web address and client logon
// credentials from the user.
ServerConnection serverConnect = new ServerConnection();
ServerConnection.Configuration config = serverConnect.GetServerConfiguration();
CreateEmailUsingTemplate app = new CreateEmailUsingTemplate();
app.Run(config, true);
}
catch (FaultException<Microsoft.Xrm.Sdk.OrganizationServiceFault> ex)
{
Console.WriteLine("The application terminated with an error.");
Console.WriteLine("Timestamp: {0}", ex.Detail.Timestamp);
Console.WriteLine("Code: {0}", ex.Detail.ErrorCode);
Console.WriteLine("Message: {0}", ex.Detail.Message);
Console.WriteLine("Plugin Trace: {0}", ex.Detail.TraceText);
Console.WriteLine("Inner Fault: {0}",
null == ex.Detail.InnerFault ? "No Inner Fault" : "Has Inner Fault");
}
catch (System.TimeoutException ex)
{
Console.WriteLine("The application terminated with an error.");
Console.WriteLine("Message: {0}", ex.Message);
Console.WriteLine("Stack Trace: {0}", ex.StackTrace);
Console.WriteLine("Inner Fault: {0}",
null == ex.InnerException.Message ? "No Inner Fault" : ex.InnerException.Message);
}
catch (System.Exception ex)
{
Console.WriteLine("The application terminated with an error.");
Console.WriteLine(ex.Message);
// Display the details of the inner exception.
if (ex.InnerException != null)
{
Console.WriteLine(ex.InnerException.Message);
FaultException<Microsoft.Xrm.Sdk.OrganizationServiceFault> fe =
ex.InnerException
as FaultException<Microsoft.Xrm.Sdk.OrganizationServiceFault>;
if (fe != null)
{
Console.WriteLine("Timestamp: {0}", fe.Detail.Timestamp);
Console.WriteLine("Code: {0}", fe.Detail.ErrorCode);
Console.WriteLine("Message: {0}", fe.Detail.Message);
Console.WriteLine("Plugin Trace: {0}", fe.Detail.TraceText);
Console.WriteLine("Inner Fault: {0}",
null == fe.Detail.InnerFault ? "No Inner Fault" : "Has Inner Fault");
}
}
}
// Additonal exceptions to catch: SecurityTokenValidationException, ExpiredSecurityTokenException,
// SecurityAccessDeniedException, MessageSecurityException, and SecurityNegotiationException.
finally
{
Console.WriteLine("Press <Enter> to exit.");
Console.ReadLine();
}
}
#endregion Main method
}
}
Imports System.IO
Imports System.Text
Imports System.ServiceModel
Imports System.Xml.Serialization
Imports System.ServiceModel.Description
' These namespaces are found in the Microsoft.Xrm.Sdk.dll assembly
' located in the SDK\bin folder of the SDK download.
Imports Microsoft.Xrm.Sdk
Imports Microsoft.Xrm.Sdk.Query
Imports Microsoft.Xrm.Sdk.Client
Imports Microsoft.Xrm.Sdk.Messages
' This namespace is found in Microsoft.Crm.Sdk.Proxy.dll assembly
' found in the SDK\bin folder.
Imports Microsoft.Crm.Sdk.Messages
Namespace Microsoft.Crm.Sdk.Samples
Public Class CreateEmailUsingTemplate
#Region "Class Level Members"
' Define the IDs needed for this sample.
Private _accountId As Guid
Private _templateId As Guid
Private _serviceProxy As OrganizationServiceProxy
#End Region ' Class Level Members
#Region "How To Sample Code"
''' <summary>
''' Create an e-mail using a template.
''' </summary>
''' <param name="serverConfig">Contains server connection information.</param>
''' <param name="promptforDelete">When True, the user will be prompted to delete all
''' created entities.</param>
Public Sub Run(ByVal serverConfig As ServerConnection.Configuration, ByVal promptforDelete As Boolean)
Try
' Connect to the Organization service.
' The using statement assures that the service proxy will be properly disposed.
_serviceProxy = ServerConnection.GetOrganizationProxy(serverConfig)
Using _serviceProxy
' This statement is required to enable early-bound type support.
_serviceProxy.EnableProxyTypes()
CreateRequiredRecords()
' Use the InstantiateTemplate message to create an e-mail message using a template.
Dim instTemplateReq As InstantiateTemplateRequest = New InstantiateTemplateRequest With { _
.TemplateId = _templateId, .ObjectId = _accountId, .ObjectType = Account.EntityLogicalName}
Dim instTemplateResp As InstantiateTemplateResponse = _
CType(_serviceProxy.Execute(instTemplateReq), InstantiateTemplateResponse)
' Serialize the email message to XML, and save to a file.
Dim serializer As New XmlSerializer(GetType(InstantiateTemplateResponse))
Dim filename As String = "email-message.xml"
Using writer As New StreamWriter(filename)
serializer.Serialize(writer, instTemplateResp)
End Using
Console.WriteLine("Created e-mail using the template.")
DeleteRequiredRecords(promptforDelete)
End Using
' Catch any service fault exceptions that Microsoft Dynamics CRM throws.
Catch fe As FaultException(Of Microsoft.Xrm.Sdk.OrganizationServiceFault)
' You can handle an exception here or pass it back to the calling method.
Throw
End Try
End Sub
''' <summary>
''' Creates any entity records that this sample requires.
''' </summary>
Public Sub CreateRequiredRecords()
' Create an account.
Dim account As Account = New Account With {.Name = "Fourth Coffee"}
_accountId = _serviceProxy.Create(account)
Console.WriteLine("Created a sample account: {0}.", account.Name)
' Define the body and subject of the email template in XML format.
Dim bodyXml As String = "<?xml version=""1.0"" ?>" & _
"<xsl:stylesheet xmlns:xsl=""http://www.w3.org/1999/XSL/Transform"" version=""1.0"">" & _
"<xsl:output method=""text"" indent=""no""/><xsl:template match=""/data"">" & _
"<![CDATA[" & "This message is to notify you that a new account has been created." & _
"]]></xsl:template></xsl:stylesheet>"
Dim subjectXml As String = "<?xml version=""1.0"" ?>" & _
"<xsl:stylesheet xmlns:xsl=""http://www.w3.org/1999/XSL/Transform"" version=""1.0"">" & _
"<xsl:output method=""text"" indent=""no""/><xsl:template match=""/data"">" & _
"<![CDATA[New account notification]]></xsl:template></xsl:stylesheet>"
Dim presentationXml As String = "<template><text><![CDATA[" & _
"This message is to notify you that a new account has been created." & "]]></text></template>"
Dim subjectPresentationXml As String = "<template><text><![CDATA[New account notification]]></text></template>"
' Create an e-mail template.
Dim template As Template = New Template With {.Title = "Sample E-mail Template for Account", .Body = bodyXml, _
.Subject = subjectXml, .PresentationXml = presentationXml, .SubjectPresentationXml = subjectPresentationXml, _
.TemplateTypeCode = account.EntityLogicalName, .LanguageCode = 1033, .IsPersonal = False}
_templateId = _serviceProxy.Create(template)
Console.WriteLine("Created {0}.", template.Title)
End Sub
''' <summary>
''' Deletes any entity records that were created for this sample.
''' <param name="prompt">Indicates whether to prompt the user
''' to delete the records created in this sample.</param>
''' </summary>
Public Sub DeleteRequiredRecords(ByVal prompt As Boolean)
Dim toBeDeleted As Boolean = True
If prompt Then
' Ask the user if the created entities should be deleted.
Console.Write(vbLf & "Do you want these entity records deleted? (y/n) [y]: ")
Dim answer As String = Console.ReadLine()
If answer.StartsWith("y") OrElse answer.StartsWith("Y") OrElse answer = String.Empty Then
toBeDeleted = True
Else
toBeDeleted = False
End If
End If
If toBeDeleted Then
' Delete all records created in this sample.
_serviceProxy.Delete(Template.EntityLogicalName, _templateId)
_serviceProxy.Delete(Account.EntityLogicalName, _accountId)
Console.WriteLine("Entity record(s) have been deleted.")
End If
End Sub
#End Region ' How To Sample Code
#Region "Main method"
''' <summary>
''' Main. Runs the sample and provides error output.
''' <param name="args">Array of arguments to Main method.</param>
''' </summary>
Public Shared Sub Main(ByVal args() As String)
Try
' Obtain the target organization's Web address and client logon
' credentials from the user.
Dim serverConnect As New ServerConnection()
Dim config As ServerConnection.Configuration = serverConnect.GetServerConfiguration()
Dim app As New CreateEmailUsingTemplate()
app.Run(config, True)
Catch ex As FaultException(Of Microsoft.Xrm.Sdk.OrganizationServiceFault)
Console.WriteLine("The application terminated with an error.")
Console.WriteLine("Timestamp: {0}", ex.Detail.Timestamp)
Console.WriteLine("Code: {0}", ex.Detail.ErrorCode)
Console.WriteLine("Message: {0}", ex.Detail.Message)
Console.WriteLine("Plugin Trace: {0}", ex.Detail.TraceText)
Console.WriteLine("Inner Fault: {0}", If(Nothing Is ex.Detail.InnerFault, "No Inner Fault", "Has Inner Fault"))
Catch ex As TimeoutException
Console.WriteLine("The application terminated with an error.")
Console.WriteLine("Message: {0}", ex.Message)
Console.WriteLine("Stack Trace: {0}", ex.StackTrace)
Console.WriteLine("Inner Fault: {0}", If(Nothing Is ex.InnerException.Message, "No Inner Fault", ex.InnerException.Message))
Catch ex As Exception
Console.WriteLine("The application terminated with an error.")
Console.WriteLine(ex.Message)
' Display the details of the inner exception.
If ex.InnerException IsNot Nothing Then
Console.WriteLine(ex.InnerException.Message)
Dim fe As FaultException(Of Microsoft.Xrm.Sdk.OrganizationServiceFault) = _
TryCast(ex.InnerException, FaultException(Of Microsoft.Xrm.Sdk.OrganizationServiceFault))
If fe IsNot Nothing Then
Console.WriteLine("Timestamp: {0}", fe.Detail.Timestamp)
Console.WriteLine("Code: {0}", fe.Detail.ErrorCode)
Console.WriteLine("Message: {0}", fe.Detail.Message)
Console.WriteLine("Plugin Trace: {0}", fe.Detail.TraceText)
Console.WriteLine("Inner Fault: {0}", If(Nothing Is fe.Detail.InnerFault, "No Inner Fault", "Has Inner Fault"))
End If
End If
' Additonal exceptions to catch: SecurityTokenValidationException, ExpiredSecurityTokenException,
' SecurityAccessDeniedException, MessageSecurityException, and SecurityNegotiationException.
Finally
Console.WriteLine("Press <Enter> to exit.")
Console.ReadLine()
End Try
End Sub
#End Region ' Main method
End Class
End Namespace
See Also
IOrganizationService
InstantiateTemplateRequest
Sample code for activity entities
Email activity entities
Email entity messages and methods
Template (email template) entity messages and methods
Sample: Work with activity party records
Helper code: ServerConnection class