Enable-MailUser
Applies to: Exchange Server 2007 SP1, Exchange Server 2007 SP2, Exchange Server 2007 SP3
You can use the Enable-MailUser cmdlet to mail-enable an existing user in the Active Directory directory service.
Syntax
Enable-MailUser -Identity <UserIdParameter> -ExternalEmailAddress <ProxyAddress> [-Alias <String>] [-Confirm [<SwitchParameter>]] [-DisplayName <String>] [-DomainController <Fqdn>] [-MacAttachmentFormat <BinHex | UuEncode | AppleSingle | AppleDouble>] [-MessageBodyFormat <Text | Html | TextAndHtml>] [-MessageFormat <Text | Mime>] [-PrimarySmtpAddress <SmtpAddress>] [-UsePreferMessageFormat <$true | $false>] [-UseRusServer <String>] [-WhatIf [<SwitchParameter>]]
Detailed Description
The Enable-MailUser cmdlet mail-enables an existing user in Active Directory by adding the attributes that are required by Microsoft Exchange Server 2007. The user's identity and an external e-mail address are required. Mail-enabled users have an e-mail address at the Exchange organization (for example, john@contoso.com), but they do not have an Exchange mailbox. E-mail messages that are addressed to the mail-enabled user are sent instead to the specified external e-mail address.
For more information, see How to Create a New Mail-Enabled User.
To run the Enable-MailUser cmdlet, you must delegate the following role to the account that you use:
- Exchange Recipient Administrator role
For more information about permissions, about delegating roles, and about the rights that are required to administer Exchange Server 2007, see Permission Considerations.
Note
To create a new user who is mail-enabled at the time of creation, use the New-MailUser cmdlet.
Parameters
Parameter | Required | Type | Description | ||
---|---|---|---|---|---|
ExternalEmailAddress |
Required |
Microsoft.Exchange.Data.ProxyAddress |
The ExternalEmailAddress parameter specifies an e-mail address outside of the organization. By default, the email address that is specified in the ExternalEmailAddress parameter is set as the PrimarySMTPAddress. E-mail messages that are sent to the mail-enabled user are sent to this external address. |
||
Identity |
Required |
Microsoft.Exchange.Configuration.Tasks.UserIdParameter |
The Identity parameter takes one of the following values:
|
||
Alias |
Optional |
System.String |
The Alias parameter specifies the alias of the user. An alias can contain letters, numerals, and the following punctuation marks and symbols:
|
||
Confirm |
Optional |
System.Management.Automation.SwitchParameter |
The Confirm parameter causes the command to pause processing. It also requires you to acknowledge what the command will do before processing continues. You do not have to specify a value for the Confirm parameter. |
||
DisplayName |
Optional |
System.String |
The DisplayName parameter specifies the display name for the mail user. The DisplayName is the name that appears in the Exchange Management Console under Recipient Configuration. |
||
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. |
||
MacAttachmentFormat |
Optional |
Microsoft.Exchange.Data.Directory.Recipient.MacAttachmentFormat |
The MacAttachmentFormat parameter specifies the Apple Macintosh Operating System attachment format for messages that are sent to the mail user. The valid values for this parameter are:
By default, this parameter is set to BinHex.
|
||
MessageBodyFormat |
Optional |
Microsoft.Exchange.Data.Directory.Recipient.MessageBodyFormat |
The MessageBodyFormat parameter specifies the message body format for messages that are sent to the mail user. The valid values for this parameter are:
By default, this parameter is set to TextAndHtml. The MessageFormat and MessageBodyFormat parameters are interdependent. If the MessageFormat parameter is set to Mime, the MessageBodyFormat parameter can be set to any valid value. However, if the MessageFormat parameter is set to Text, the MessageBodyFormat parameter can be set only to Text. Therefore, if you want to set this parameter to Html or to TextAndHtml, you must also set the MessageFormat parameter to Mime. |
||
MessageFormat |
Optional |
Microsoft.Exchange.Data.Directory.Recipient.MessageFormat |
The MessageFormat parameter specifies the message format for messages that are sent to the mail user. The valid values for this parameter are:
By default, this parameter is set to Mime. The MessageFormat and MessageBodyFormat parameters are interdependent. If the MessageFormat parameter is set to Mime, the MessageBodyFormat parameter can be set to any valid value. However, if the MessageFormat parameter is set to Text, the MessageBodyFormat parameter can be set only to Text. Therefore, if you want to change the MessageFormat parameter from Mime to Text, you must also change the MessageBodyFormat parameter to Text. |
||
PrimarySmtpAddress |
Optional |
Microsoft.Exchange.Data.SmtpAddress |
Use this parameter to specify the primary SMTP address for the mail user. By default, the primary SMTP address is generated based on the default e-mail address policy. If you specify a primary SMTP address by using this parameter, the cmdlet sets the EmailAddressPolicyEnabled attribute of the mail user to |
||
UsePreferMessageFormat |
Optional |
System.Boolean |
The UsePreferMessageFormat parameter specifies whether the message format settings configured for the mailbox overrides the global settings configured for the domain. Set this parameter to |
||
UseRusServer |
Optional |
System.String |
The UseRusServer parameter instructs the command to use the specified Mailbox server on which the Address List service is running to obtain and then set mailbox and Active Directory user attributes. The Address List service is a component in the Exchange System Attendant service. The Address List service creates and maintains Exchange-specific attribute values in Active Directory. You can use the Address List service to update recipient objects in a domain by using specific information, such as address list membership and e-mail addresses. |
||
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 do not have to specify a value with the WhatIf parameter. |
Input Types
Return Types
Errors
Error | Description |
---|---|
|
Exceptions
Exceptions | Description |
---|---|
|
Example
In this example, the Enable-MailUser command is used to mail-enable user John with the external e-mail address john@contoso.com.
Enable-MailUser -Identity John -ExternalEmailAddress john@contoso.com