CRMEmail.UpdateAndRetrieve Method
The UpdateAndRetrieve method updates an e-mail object and then retrieves it.
Syntax
[Visual Basic .NET]
Public Function UpdateAndRetrieve(
ByVal Caller As CUserAuth,
ByVal EmailId As String,
ByVal EmailXml As String,
ByVal RecipientsXml As String,
ByRef OutRecipientsXml As String
) As String
[C#]
public string UpdateAndRetrieve(
CUserAuth Caller,
string EmailId,
string EmailXml,
string RecipientsXml,
out string OutRecipientsXml
);
[C++]
public: String* UpdateAndRetrieve(
CUserAuth* Caller,
String* EmailId,
String* EmailXml,
String* RecipientsXml,
String** OutRecipientsXml
);
Parameters
Caller
Specifies the identity of the caller. To perform this action, the caller must have the prvWriteActivity and prvReadActivity privileges and access rights on the object to be updated. See CUserAuth.
EmailId
Specifies the ID of the e-mail object to be updated.
EmailXml
Specifies an XML string describing the e-mail object. The XML schema is described by emailactivity.xsd.
RecipientXml
Specifies an XML string describing the sender and the recipients of the e-mail object. The XML schema is described by activityparty.xsd.
OutRecipientsXml
[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
The XML string returned from this method does not contain elements for fields where the value is null or contains empty strings. This improves performance by not sending more XML data than is necessary from the server to the client.
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";
// CRMEmail proxy object
Microsoft.Crm.Platform.Proxy.CRMEmail email = new Microsoft.Crm.Platform.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.Platform.Proxy.CUserAuth userAuth = bizUser.WhoAmI();
// Set up the XML string for the activity
string strActivityXml = "<emailactivity>";
strActivityXml += "<messagesubject>Test Email 1</messagesubject>";
strActivityXml += "<messagebody>Test Email 1</messagebody>";
strActivityXml += "<ownerid type=\"" + Microsoft.Crm.Platform.Types.ObjectType.otSystemUser.ToString() +"\">";
strActivityXml += userAuth.UserId + "</ownerid>";
strActivityXml += "</emailactivity>";
// Set up the XML string for the activity parties
string strPartiesXml = "<activityparties>";
strPartiesXml += "<activityparty>";
strPartiesXml += "<addressused>rachel@adventure-works.com</addressused>";
strPartiesXml += "<partyobjecttypecode>" + Microsoft.Crm.Platform.Types.ObjectType.otContact.ToString() + "</partyobjecttypecode>";
strPartiesXml += "<participationtypemask>";
strPartiesXml += Microsoft.Crm.Platform.Types.ACTIVITY_PARTY_TYPE.ACTIVITY_PARTY_CC_RECIPIENT.ToString();
strPartiesXml += "</participationtypemask>";
strPartiesXml += "</activityparty>";
strPartiesXml += "</activityparties>";
// Now update the e-mail object
string strResultsXml = email.UpdateAndRetrieve(userAuth, strEmailId, strActivityXml, strPartiesXml, 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.Platform.Proxy
Assembly: Microsoft.Crm.Platform.Proxy.dll
See Also