Export (0) Print
Expand All
Expand Minimize

Set-EOPMailUser

Exchange 2013
 

Applies to: Exchange Online Protection

Topic Last Modified: 2014-06-23

This cmdlet is available only in Exchange Online Protection.

Use the Set-EOPMailUser cmdlet to modify mail users, also known as mail-enabled users, in Microsoft Exchange Online Protection.

NoteNote:
Typically, Exchange Online Protection (EOP) customers that also have on-premises Active Directory organizations would use directory synchronization to create users and groups in EOP. However, if you can’t use directory synchronization, then you can use cmdlets to create and manage users and groups in EOP.

For information about the parameter sets in the Syntax section below, see Syntax.

Set-EOPMailUser [-Alias <String>] [-DisplayName <String>] [-EmailAddresses <ProxyAddressCollection>] [-ExternalDirectoryObjectId <String>] [-Identity <MailUserIdParameter>] [-MicrosoftOnlineServicesID <SmtpAddress>] [-Organization <OrganizationIdParameter>] [-Password <SecureString>]

This example changes the display name for the mail user Edward Meadows to "Ed Meadows."

Set-EOPMailUser -Identity "Edward Meadows" -DisplayName "Ed Meadows"

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 "Users, Contacts, and Role Groups" entry in the Feature permissions in EOP topic.

 

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.Configuration.Tasks.MailUserIdParameter

The Identity parameter specifies the mail user that you want to modify.

This parameter accepts the following values:

  • Alias

    Example: JPhillips

  • Canonical DN

    Example: Atlanta.Corp.Contoso.Com/Users/JPhillips

  • Display Name

    Example: Jeff Phillips

  • Distinguished Name (DN)

    Example: CN=JPhillips,CN=Users,DC=Atlanta,DC=Corp,DC=contoso,DC=com

  • Domain\Account

    Example: Atlanta\JPhillips

  • GUID

    Example: fb456636-fe7d-4d58-9d15-5af57d0354c2

  • Immutable ID

    Example: fb456636-fe7d-4d58-9d15-5af57d0354c2@contoso.com

  • Legacy Exchange DN

    Example: /o=Contoso/ou=AdministrativeGroup/cn=Recipients/cn=JPhillips

  • SMTP Address

    Example: Jeff.Phillips@contoso.com

  • User Principal Name

    Example: JPhillips@contoso.com

Alias

Optional

System.String

The Alias parameter specifies the alias of the mail user.

The value of Alias can contain letters, numbers and the characters !, #, $, %, &, ', *, +, -, /, =, ?, ^, _, `, {, |, } and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed, but they will be mapped to a best-fit US-ASCII text character if the Alias value is used to generate the email address.

DisplayName

Optional

System.String

The DisplayName parameter specifies the display name of the mail user in the Exchange admin center (EAC).

EmailAddresses

Optional

Microsoft.Exchange.Data.ProxyAddressCollection

The EmailAddresses parameter specifies the primary email address and other proxy addresses for the mail user. This parameter uses the syntax SMTP:<PrimaryEmailAddress>,<ProxyAddress>.

The values that you specify for this parameter overwrite any existing values.

ExternalDirectoryObjectId

Optional

System.String

This parameter is reserved for internal Microsoft use.

MicrosoftOnlineServicesID

Optional

Microsoft.Exchange.Data.SmtpAddress

The MicrosoftOnlineServicesID parameter specifies the user ID for the object. This parameter only applies to objects in the cloud-based service. It isn’t available for on-premises deployments.

Organization

Optional

Microsoft.Exchange.Configuration.Tasks.OrganizationIdParameter

The Organization parameter is reserved for internal Microsoft use.

Password

Optional

System.Security.SecureString

This parameter is reserved for internal Microsoft use.

To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types. If the Input Type field for a cmdlet is blank, the cmdlet doesn’t accept input data.

To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types. If the Output Type field is blank, the cmdlet doesn’t return data.

 
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft