CRMEmail.RetrieveByObject Method
The RetrieveByObject method retrieves the e-mail objects that are associated with the specified object (for example, an account).
Syntax
[Visual Basic .NET]
Public Function RetrieveByObject(
ByVal Caller As CUserAuth,
ByVal Object As CObjectName,
ByVal ColumnSetXml As String
) As String
[C#]
public string RetrieveByObject(
CUserAuth Caller,
CObjectName Object,
string ColumnSetXml
);
[C++]
public: String* RetrieveByObject(
CUserAuth* Caller,
CObjectName* Object,
String* ColumnSetXml
);
Parameters
Caller
Specifies the identity of the caller. The caller must have the prvReadActivity privilege to perform this action. See CUserAuth.
Object
Specifies the object for which e-mail objects are to be retrieved. See CObjectName.
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.
Return Value
Returns a String type that specifies the XML data describing the set of e-mail objects associated with the specified object. The fields that are returned depend on what fields are specified in the ColumnSetXml parameter. 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 strContactId = "{ECF99EF1-3858-4E06-ABD9-EBFE526BF9FF}";
try
{
Microsoft.CRM.Proxy.CUserAuth userAuth = bizUser.WhoAmI();
// Set up the columns that you want to retrieve
string strColumnSetXml = "<columnset>";
strColumnSetXml += "<column>activityid</column>";
strColumnSetXml += "<column>partyid</column>";
strColumnSetXml += "<column>addressused</column>";
strColumnSetXml += "</columnset>";
// Create a contact object
Microsoft.CRM.Proxy.CObjectName objName = new Microsoft.CRM.Proxy.CObjectName();
objName.Id = strContactId;
objName.Type = Microsoft.CRM.Proxy.ObjectType.otContact;
// Retrieve all of the e-mail objects for the specified object
string strResultsXml = email.RetrieveByObject(userAuth, objName, strColumnSetXml);
}
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