CRMEmailTemplate.Retrieve Method
The Retrieve method retrieves a personal e-mail template.
Syntax
[Visual Basic .NET]
Public Function Retrieve(
ByVal Caller As CUserAuth,
ByVal TemplateId As String
) As String
[C#]
public string Retrieve(
CUserAuth Caller,
string TemplateId
);
[C++]
public: String* Retrieve(
CUserAuth* Caller,
String* TemplateId
);
Parameters
Caller
Specifies the identity of the caller. The caller must have the prvReadEmailTemplate privilege to perform this action. See CUserAuth.
TemplateId
Specifies the ID of the template that is to be retrieved.
Return Value
Returns a String type that specifies the XML data containing the template. The XML schema is described by template.xsd.
Remarks
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.Proxy.BizUser bizUser = new Microsoft.CRM.Proxy.BizUser ();
bizUser.Credentials = System.Net.CredentialCache.DefaultCredentials;
bizUser.Url = strDir + "BizUser.srf";
// CRMEmailTemplate proxy object
Microsoft.CRM.Proxy.CRMEmailTemplate emailtemplate = new Microsoft.CRM.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.Proxy.CUserAuth userAuth = bizUser.WhoAmI();
// Retrieve the XML data for the template
string strResultsXml = emailtemplate.Retrieve(userAuth, strEmailTemplateId);
}
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.Proxy
Assembly: microsoft.crm.proxy.dll
See Also