Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

Enable-MailUser

Applies to: Exchange Server 2010

Topic Last Modified: 2011-03-19

Use the Enable-MailUser cmdlet to mail-enable an existing user in Active Directory.


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>] [-WhatIf [<SwitchParameter>]]

Parameter Required Type Description

ExternalEmailAddress

Required

Microsoft.Exchange.Data.ProxyAddress

The ExternalEmailAddress parameter specifies an e-mail address outside the organization. E-mail messages 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:

  • ADObjectID
  • GUID
  • Distinguished name (DN)
  • Domain\SamAccountName
  • User principal name (UPN)
  • LegacyExchangeDN
  • User alias

Alias

Optional

System.String

The Alias parameter specifies the alias of the user. An alias can contain letters, numbers, and the following punctuation marks and symbols:

  • !
  • #
  • $
  • %
  • ^
  • &
  • *
  • +
  • -
  • .
  • /
  • =
  • ?
  • _
  • {
  • }
  • |
  • ~

Confirm

Optional

System.Management.Automation.SwitchParameter

The Confirm switch causes the command to pause processing and requires you to acknowledge what the command will do before processing continues. You don't have to specify a value with the Confirm switch.

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

The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to Active Directory.

MacAttachmentFormat

Optional

Microsoft.Exchange.Data.Directory.Recipient.MacAttachmentFormat

The MacAttachmentFormat parameter specifies the Apple Macintosh operating system attachment format for messages sent to the mail user. The valid values for this parameter are:

  • BinHex
  • UuEncode
  • AppleSingle
  • AppleDouble

By default, this parameter is set to BinHex.

  • The acceptable values for the MacAttachmentFormat parameter are dependent on the MessageFormat parameter. If the MessageFormat parameter is set to Text, you can only use BinHex or UuEncode values for this parameter. If the MessageFormat parameter is set to Mime, you can only use BinHex, AppleSingle, or AppleDouble values for this parameter.

MessageBodyFormat

Optional

Microsoft.Exchange.Data.Directory.Recipient.MessageBodyFormat

The MessageBodyFormat parameter specifies the message body format for messages sent to the mail user. The valid values for this parameter are:

  • Text
  • Html
  • TextAndHtml

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 only be set to Text. Therefore, if you want to set this parameter to Html or 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 sent to the mail user.

The valid values for this parameter are:

  • Text
  • Mime

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 only be set 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

The PrimarySmtpAddress parameter specifies 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 $false, and the e-mail addresses of this mail user aren't automatically updated based on e-mail address policies.

UsePreferMessageFormat

Optional

System.Boolean

The UsePreferMessageFormat parameter specifies whether the message format settings configured for the mailbox override the global settings configured for the domain. Set this parameter to $true to have the message format settings configured for the mailbox to override any global settings.

WhatIf

Optional

System.Management.Automation.SwitchParameter

The WhatIf switch instructs the command to simulate the actions that it would take on the object. By using the WhatIf switch, 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 switch.

The Enable-MailUser cmdlet mail-enables an existing user in Active Directory by adding the attributes that are required by Microsoft Exchange. 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 don't have an Exchange mailbox. E-mail messages addressed to the mail-enabled user are sent instead to the specified external e-mail address.

Aa996549.note(en-us,EXCHG.140).gifNote:
To create a user who is mail-enabled at the time of creation, use the New-MailUser cmdlet.

You need to be assigned permissions before you can run this cmdlet. Although all parameters for this cmdlet are listed in this topic, you may not have access to some parameters if they're not included in the permissions assigned to you. To see what permissions you need, see the "Recipient Provisioning Permissions" section in the Mailbox Permissions topic.

Error Description

 

Exceptions Description

 

This example mail-enables user John with the external e-mail address john@contoso.com.

Enable-MailUser -Identity John -ExternalEmailAddress john@contoso.com
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.