CRMEmail.RevokeAccess Method
The RevokeAccess method revokes access rights to the e-mail object for the specified security principal. This method also applies to all child objects of the e-mail object. For all child objects, if the caller does not have share privileges for those object types or share rights to the objects, access to the child objects is not revoked. As a result, the owner of the object or a user who shares the object with share rights automatically has share rights to all child objects of the e-mail object. In this case, only the lack of privileges to a particular object type prevents access to the child objects from being revoked.
Syntax
[Visual Basic .NET]
Public Sub RevokeAccess(
ByVal Caller As CUserAuth,
ByVal EmailId As String,
ByVal Revokee As CSecurityPrincipal
)
[C#]
public void RevokeAccess(
CUserAuth Caller,
string EmailId,
CSecurityPrincipal Revokee
);
[C++]
public: void RevokeAccess(
CUserAuth* Caller,
String* EmailId,
CSecurityPrincipal* Revokee
);
Parameters
Caller
Specifies the identity of the caller. The caller must have the prvShareActivity privilege to perform this action. See CUserAuth.
EmailId
Specifies the ID of the e-mail object for which access is to be revoked.
Revokee
Specifies the security principal (user or team) whose access is to be revoked. See CSecurityPrincipal.
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 strEmailId = "{391B302C-E2F8-4E19-83E2-3B2D291B4E31}";
string strUserId = "{ECF99EF1-3858-4E06-ABD9-EBFE526BF9FF}";
try
{
Microsoft.CRM.Proxy.CUserAuth userAuth = bizUser.WhoAmI();
// Create a new security principal
Microsoft.CRM.Proxy.CSecurityPrincipal securityPrincipal = new Microsoft.CRM.Proxy.CSecurityPrincipal();
securityPrincipal.Id = strUserId;
securityPrincipal.Type = Microsoft.CRM.Proxy.SecurityPrincipalType.sptUser;
// Revoke access to the e-mail object
email.RevokeAccess(userAuth, strEmailId, securityPrincipal);
}
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