CRMEmail.Retrieve Method
The Retrieve method retrieves an e-mail object.
Syntax
[Visual Basic .NET]
Public Function Retrieve(
ByVal Caller As CUserAuth,
ByVal EmailId As String,
ByVal ColumnsetXml As String,
ByRef RecipientsXml As String
) As String
[C#]
public string Retrieve(
CUserAuth Caller,
string EmailId,
string ColumnsetXml,
out string RecipientsXml
);
[C++]
public: String* Retrieve(
CUserAuth* Caller,
String* EmailId,
String* ColumnsetXml,
String** RecipientsXml
);
Parameters
Caller
Specifies the identity of the caller. The caller must have the prvReadActivity privilege to perform this action. See CUserAuth.
EmailId
Specifies the ID of the e-mail object that is to be retrieved.
ColumnsetXml
Specifies an XML string describing the set of columns that is to be retrieved. Passing "" or null returns all columns. You can find the valid column names in emailactivity.xsd. See also ColumnSetXML Schema.
RecipientsXml
[out] Specifies an XML string describing the sender and the recipients of the e-mail object. The XML schema is described by activityparty.xsd.
Return Value
Returns a String type that specifies the XML data describing the e-mail object. The XML schema is described by emailactivity.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";
// CRMEmail proxy object
Microsoft.CRM.Proxy.CRMEmail email = new Microsoft.CRM.Proxy.CRMEmail();
email.Credentials = System.Net.CredentialCache.DefaultCredentials;
email.Url = strDir + "CRMEmail.srf";
string strErrorMsg;
string strEmailId = "{391B302C-E2F8-4E19-83E2-3B2D291B4E31}";
try
{
Microsoft.CRM.Proxy.CUserAuth userAuth = bizUser.WhoAmI();
string strPartiesXml = "";
// Retrieve the XML data for the e-mail object
string strEmailActivityXml = email.Retrieve(userAuth, strEmailId, "", out strPartiesXml);
}
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