CRMEmailTemplate.Update Method
The Update method updates a personal e-mail template.
Syntax
[Visual Basic .NET]
Public Sub Update(
ByVal Caller As CUserAuth,
ByVal TemplateId As String,
ByVal TemplateXml As String
)
[C#]
public void Update(
CUserAuth Caller,
string TemplateId,
string TemplateXml
);
[C++]
public: void Update(
CUserAuth* Caller,
String* TemplateId,
String* TemplateXml
);
Parameters
Caller
Specifies the identity of the caller. To perform this action, the caller must have the prvWriteEmailTemplate privilege and access rights on the object to be updated. See CUserAuth.
TemplateId
Specifies the ID of the template to be updated.
TemplateXml
Specifies an XML string describing the e-mail template. The XML schema is described by template.xsd.
Return Value
No return value.
Remarks
Create a value for the presentationxml field that is meaningful for your application.
Note These templates do not work with the Microsoft CRM application, which uses a proprietary e-mail template format.
If there is an error, SOAP throws an exception and the error message is reported in System.Web.Services.Protocols.SoapException.Detail.OuterXml.
All IDs passed to the platform are GUIDs wrapped in braces. For example: {6522D89A-A752-4455-A2B0-51494C6957C3}
Example
[C#]
// strServer should be set with the name of the platform Web server
string strServer = "myservername";
// virtualDirectory should be set with the name of the Microsoft CRM
// virtual directory on the platform Web server
string virtualDirectory = "mscrmservices";
string strDir = "https://" + strServer + "/" + virtualDirectory + "/";
// BizUser proxy object
Microsoft.Crm.Platform.Proxy.BizUser bizUser = new Microsoft.Crm.Platform.Proxy.BizUser ();
bizUser.Credentials = System.Net.CredentialCache.DefaultCredentials;
bizUser.Url = strDir + "BizUser.srf";
// CRMEmailTemplate proxy object
Microsoft.Crm.Platform.Proxy.CRMEmailTemplate emailtemplate = new Microsoft.Crm.Platform.Proxy.CRMEmailTemplate();
emailtemplate.Credentials = System.Net.CredentialCache.DefaultCredentials;
emailtemplate.Url = strDir + "CRMEmailTemplate.srf";
string strErrorMsg;
string strEmailTemplateId = "{586D80AA-3E9B-4936-ABCA-2C4EB37FBE82}";
try
{
Microsoft.Crm.Platform.Proxy.CUserAuth userAuth = bizUser.WhoAmI();
// Set up the updated XML string for the e-mail template
string strXmlTemplate = "<template>";
strXmlTemplate += "<subject>A New Template Subject</subject>";
strXmlTemplate += "<templatetypecode>2</templatetypecode>";
strXmlTemplate += "<ownerid type=\"" + Microsoft.Crm.Platform.Types.ObjectType.otSystemUser.ToString() +"\">";
strXmlTemplate += userAuth.UserId + "</ownerid>";
strXmlTemplate += "</template>";
// Update the e-mail template
emailtemplate.Update (userAuth, strEmailTemplateId, strXmlTemplate);
}
catch (System.Web.Services.Protocols.SoapException err)
{
// Process the platform error here
strErrorMsg = ("ErrorMessage: " + err.Message + " " + err.Detail.OuterXml + " Source: " + err.Source );
}
catch (Exception err)
{
// Process other errors here
strErrorMsg = ("ErrorMessage: " + err.Message );
}
Requirements
Namespace: Microsoft.Crm.Platform.Proxy
Assembly: Microsoft.Crm.Platform.Proxy.dll
See Also