Hosted Email 2007::Unsubscribe

Article
06/17/2010

This procedure unsubscribe to the Hosted Email 2007 service.

This procedure for Hosted Messaging and Collaboration version 4.5 is updated to accept a GUID as an override to the organization parameter. In the case where a GUID was supplied, this procedure also needs to bypass private procedures that rely on the organization object.

Arguments

Input Arguments for Hosted Messaging and Collaboration version 4.0

Input Arguments	Type	Required	Description
<organization>	string	Yes	The Lightweight Directory Access Protocol (LDAP) path of the organization.
<preferredDomainController>	string	Yes	The domain controller to use for Active Directory actions.

Input Arguments for Hosted Messaging and Collaboration version 4.5

Input Arguments	Type	Required	Description
<GUID>	string	Yes if <organization> is not specified	The GUID of the organization to unsubscribe. The GUID should only be specified when the organization object is no longer found in Active Directory. That is, organization has been orphaned.
<organization>	string	Yes if <GUID> is not specified	The LDAP path of the organization to query in Resource Manager (RM).
<preferredDomainController>	string	Yes	The domain controller to use for Active Directory operations. Use the fully qualified domain name (FQDN) of the domain controller that you want to use.

Output arguments

A successful request will mirror the input data.

Remarks

An exception is the call to Hosted Email 2007::DeleteSMTPDomain. This will still be called as we should only need the asset from the plans Database to determine which SMTP domain to delete for an orphaned Business Organization.

Notes for Hosted Messaging and Collaboration version 4.5

When a GUID is supplied, this procedure must assume that the Organization as well as the child objects do not exist in Active Directory. If a GUID is supplied, the procedure should avoid any calls to Active Directory.
When a GUID is supplied, a more restrictive permissions test should be performed for DomainAdmins because a GUID assumes that the organization is deleted so we can not really validate organization ownership.

Security

If organization is specified existing, test for OrgCreators. If GUID is specified, procedure must test for more restrictive DomainAdmins.

Error Handling

Error condition	Error text
Neither GUID nor organization is specified.	You must supply either a <GUID> or <organization> element.
Active Directory object referenced by GUID exists.	The object with GUID %GUID% was found in Active Directory. This GUID parameter should only be used when the corresponding Active Directory object has been deleted.

Schema Definition

Input

<executeData>  
<organization>01..1</organization> 
<GUID>0..1</GUID> 
<preferredDomainController>1..1</preferredDomainController> 
</executeData>

Output

<executeData>1..1 </executeData>

Sample Code

Example XML Request 1

<request> 
  <data> 
    <!--LDAP path of the organization. --> 
    <organization>LDAP://OU=AlpineSkiHouse,OU=ConsolidatedMessenger,OU=Hosting,DC=Fabrikam,DC=Com</organization> 
    <!--The domain controller to use for Active Directory actions.--> 
    <preferredDomainController>AD01.Fabrikam.Com</preferredDomainController> 
  </data> 
  <procedure> 
    <execute namespace="Hosted Email 2007" procedure="Unsubscribe" impersonate="1"> 
      <before source="data" sourcePath="GUID" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="organization" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="preferredDomainController" destination="executeData" mode="move" /> 
      <after source="executeData" destination="data" mode="merge" /> 
    </execute> 
  </procedure> 
</request>

Example XML Request 2

<request> 
  <data> 
    <!--GUID of the organization. Both of the two formats are supported: {08fd2bcd-dcd6-4d80-9cd4-1e88069e37f8} or cd2bfd08d6dc804d9cd41e88069e37f8.--> 
    <GUID>cd2bfd08d6dc804d9cd41e88069e37f8</GUID> 
    <!--The domain controller to use for Active Directory actions.--> 
    <preferredDomainController>AD01.Fabrikam.Com</preferredDomainController> 
  </data> 
  <procedure> 
    <execute namespace="Hosted Email 2007" procedure="Unsubscribe" impersonate="1"> 
      <before source="data" sourcePath="GUID" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="preferredDomainController" destination="executeData" mode="move" /> 
      <after source="executeData" destination="data" mode="merge" /> 
    </execute> 
  </procedure> 
</request>

Example XML Response

<response> 
  <data> 
    <!--GUID of the organization. --> 
    <GUID>cd2bfd08d6dc804d9cd41e88069e37f8</GUID> 
    <!--The domain controller to use for Active Directory actions.--> 
    <preferredDomainController>AD01.Fabrikam.Com</preferredDomainController> 
  </data> 
</response>

Applies To

Hosted Email 2007 Namespace for:

Hosted Messaging and Collaboration version 4.5
Hosted Messaging and Collaboration version 4.0

Hosted Email 2007::Unsubscribe

Arguments

Remarks

Schema Definition

Sample Code

Applies To

See also

Tasks

Additional resources