Applies to: Exchange Server 2007 SP3, Exchange Server
2007 SP2, Exchange Server 2007 SP1
Topic Last Modified: 2007-08-02
Use the Disable-MailContact cmdlet to remove the Exchange attributes of an existing mail-enabled contact in the Active Directory directory service. The contact object will remain in Active Directory but will no longer be mail-enabled.
Syntax
Disable-MailContact -Identity
<MailContactIdParameter> [-Confirm [<SwitchParameter>]]
[-DomainController <Fqdn>] [-IgnoreDefaultScope
<SwitchParameter>] [-WhatIf [<SwitchParameter>]]
|
Parameters
Parameter | Required | Type | Description |
---|---|---|---|
Identity |
Required |
Microsoft.Exchange.Configuration.Tasks.MailContactIdParameter |
The Identity parameter specifies the ADObjectID, distinguished name, GUID, or alias of the mail contact. |
DomainController |
Optional |
Microsoft.Exchange.Data.Fqdn |
To specify the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to Active Directory, include the DomainController parameter in the command. |
Confirm |
Optional |
System.Management.Automation.SwitchParameter |
The Confirm parameter causes the command to pause processing and requires you to acknowledge what the command will do before processing continues. You do not have to specify a value with the Confirm parameter. |
IgnoreDefaultScope |
Optional |
System.Management.Automation.SwitchParameter |
The IgnoreDefaultScope parameter instructs the command to ignore the default recipient scope setting for the Exchange Management Shell and use the entire forest as the scope. This allows the command to access Active Directory objects that are not currently in the default scope. Using the IgnoreDefaultScope parameter introduces the following restrictions:
|
WhatIf |
Optional |
System.Management.Automation.SwitchParameter |
The WhatIf parameter instructs the command to simulate the actions that it would take on the object. By using the WhatIf parameter, you can view what changes would occur without having to apply any of those changes. You don't have to specify a value with the WhatIf parameter. |
Detailed Description
The Disable-MailContact cmdlet mail-disables an existing contact by removing the Exchange attributes of the contact. The contact is not deleted.
To run the Disable-MailContact cmdlet, the account you use must be delegated the following:
- Exchange Recipient Administrator role
For more information about permissions, delegating roles, and the rights that are required to administer Exchange Server 2007, see Permission Considerations.
Input Types
Return Types
Errors
Error | Description |
---|---|
|
Exceptions
Exceptions | Description |
---|---|
|
Example
This example shows how to use the Disable-MailContact command to mail-disable a mail-enabled contact.
Copy Code | |
---|---|
Disable-MailContact -Identity TedBremer |