Share via

CRMEmail.DetachFromQueue Method

  • Article

The DetatchFromQueue method detaches the e-mail object from the specified queue.

Syntax

[Visual Basic .NET]
Public Sub DetachFromQueue(
  ByVal Caller As CUserAuth,
  ByVal EmailId As String,
  ByVal QueueId As String
)
[C#]
public void DetachFromQueue(
  CUserAuth  Caller,
  string  EmailId,
  string  QueueId
);
[C++]
public: void DetachFromQueue(
  CUserAuth*  Caller,
  String*  EmailId,
  String*  QueueId
);

Parameters

Caller

Specifies the identity of the caller. The caller must have the prvDeleteQueue privilege to perform this action. See CUserAuth.

EmailId

Specifies the ID of the e-mail object that is to be detached from its queue.

QueueId

Specifies the ID of the queue.

Return Value

No return value.

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 strQueueId = "{D985D31D-3C83-4FAD-BDE4-404565615CBA}";
string strEmailId = "{391B302C-E2F8-4E19-83E2-3B2D291B4E31}";

try
{
   Microsoft.CRM.Proxy.CUserAuth userAuth = bizUser.WhoAmI();

   // Detach the e-mail object from the queue
   email.DetachFromQueue(userAuth, strEmailId, strQueueId);

}
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

© 2003 Microsoft Corporation. All rights reserved.