Identity

Required

Microsoft.Exchange.Configuration.Tasks.RemoteMailboxIdParameter

The Identity parameter specifies the mail-enabled user. You can use one of the following values:

• ADObjectID
  
  
• GUID
  
  
• Distinguished name (DN)
  
  
• Domain\SamAccountName
  
  
• User principal name (UPN)
  
  
• Legacy DN
  
  
• Email address
  
  
• User alias
  
  

AcceptMessagesOnlyFrom

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The AcceptMessagesOnlyFrom parameter specifies the mailbox users and mail-enabled users that can send email messages to this mail-enabled user. You can also specify Exchange as a valid recipient for this parameter. If you configure a mail-enabled user to accept messages only from the Exchange recipient, the mail-enabled user only receives system-generated messages.

You can use one of the following values for the valid senders:

• DN
  
  
• Canonical name
  
  
• GUID
  
  
• Name
  
  
• Display name
  
  
• Alias
  
  
• Exchange DN
  
  
• Primary SMTP email address
  
  

By default, this parameter is blank, which enables the mail-enabled user to accept messages from all senders.

AcceptMessagesOnlyFromDLMembers

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The AcceptMessagesOnlyFromDLMembers parameter specifies the distribution groups whose members are allowed to send email messages to this mail-enabled user. You can use any of the following values for the allowed distribution groups:

• DN
  
  
• Canonical name
  
  
• GUID
  
  
• Name
  
  
• Display name
  
  
• LegacyExchangeDN
  
  
• Primary SMTP email address
  
  

By default, this parameter is blank, which enables the mail-enabled user to accept messages from all senders.

AcceptMessagesOnlyFromSendersOrMembers

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The AcceptMessagesOnlyFromSendersOrMembers parameter specifies the recipients who are allowed to send email messages to this mail-enabled user. You can use any of the following values for the allowed recipients:

• Alias
  
  
• Canonical name
  
  
• Display name
  
  
• DN
  
  
• GUID
  
  
• Name
  
  
• LegacyExchangeDN
  
  
• Primary SMTP email address
  
  

By default, this parameter is blank, which enables the mail-enabled user to accept messages from all senders.

Alias

Optional

System.String

The Alias parameter specifies the alias (mail nickname) of the mail-enabled user. The alias can be a combination of characters separated by a period with no intervening spaces. Don't use special characters in the alias.

ArbitrationMailbox

Optional

Microsoft.Exchange.Configuration.Tasks.MailboxIdParameter

This parameter is reserved for internal Microsoft use.

ArchiveGuid

Optional

System.Guid

This parameter is reserved for internal Microsoft use.

ArchiveName

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The ArchiveName parameter specifies the name of the archive mailbox. Use this parameter to change the name of the archive.

ArchiveQuota

Optional

Microsoft.Exchange.Data.Unlimited

This parameter is reserved for internal Microsoft use.

ArchiveWarningQuota

Optional

Microsoft.Exchange.Data.Unlimited

This parameter is reserved for internal Microsoft use.

BypassModerationFromSendersOrMembers

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The BypassModerationFromSendersOrMembers parameter specifies the recipients whose messages bypass moderation when sending to this mail-enabled user. You can use any of the following values:

• Alias
  
  
• Canonical name
  
  
• Display name
  
  
• DN
  
  
• GUID
  
  
• Name
  
  
• LegacyExchangeDN
  
  
• Primary SMTP email address
  
  

This value makes sure that all messages are moderated when this mail-enabled user is configured for moderation.

Note:
Senders designated as moderators for this mail-enabled user are never moderated.

CalendarVersionStoreDisabled

Optional

System.Boolean

The CalendarVersionStoreDisabled parameter specifies whether calendar changes in a user's mailbox are logged. The two possible values for this parameter are $true or $false. The default value is $false. By default, all changes to a calendar item are recorded in the mailbox of a user to keep older versions of meeting items.

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.

CreateDTMFMap

Optional

System.Boolean

This parameter is reserved for internal Microsoft use.

CustomAttribute1

Optional

System.String

The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information.

CustomAttribute10

Optional

System.String

The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information.

CustomAttribute11

Optional

System.String

The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information.

CustomAttribute12

Optional

System.String

The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information.

CustomAttribute13

Optional

System.String

The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information.

CustomAttribute14

Optional

System.String

The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information.

CustomAttribute15

Optional

System.String

The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information.

CustomAttribute2

Optional

System.String

The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information.

CustomAttribute3

Optional

System.String

The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information.

CustomAttribute4

Optional

System.String

The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information.

CustomAttribute5

Optional

System.String

The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information.

CustomAttribute6

Optional

System.String

The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information.

CustomAttribute7

Optional

System.String

The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information.

CustomAttribute8

Optional

System.String

The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information.

CustomAttribute9

Optional

System.String

The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information.

DisplayName

Optional

System.String

The DisplayName parameter specifies the display name for the user account associated with this mail-enabled user.

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.

EmailAddresses

Optional

Microsoft.Exchange.Data.ProxyAddressCollection

The EmailAddresses parameter specifies the email alias of the mail-enabled user. All valid Exchange email address types may be used. You can specify multiple values for the EmailAddresses parameter as a comma-delimited list.

Important:
Exchange doesn't validate custom addresses for proper formatting. You must ensure that the custom address you specify complies with the format requirements for that address type. Because X.400 addresses are considered custom addresses in Exchange, they're also not validated, and you must provide the correct syntax when specifying an X.400 address.

EmailAddressPolicyEnabled

Optional

System.Boolean

The EmailAddressPolicyEnabled parameter specifies whether the email addresses for the mail-enabled user are automatically updated based on the email address policies defined. The two possible values for this parameter are $true or $false. When this parameter is set to $true, you can't change the PrimarySmtpAddress or WindowsEmailAddress parameters.

EndDateForRetentionHold

Optional

System.DateTime

The EndDateForRetentionHold parameter specifies the end date for retention hold for messaging records management (MRM). To use this parameter, the RetentionHoldEnabled parameter must be set to $true.

ExchangeGuid

Optional

System.Guid

This parameter is reserved for internal Microsoft use.

ExtensionCustomAttribute1

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The ExtensionCustomAttribute1-5 parameters specify custom attributes that store additional information. You can specify multiple values for these parameters as a comma delimited list. Each ExtensionCustomAttribute parameter can hold up to 1,300 values.

For more information about custom attributes, see Custom Attributes.

For more information about using multivalued properties, see Modifying Multivalued Properties.

ExtensionCustomAttribute2

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The ExtensionCustomAttribute1-5 parameters specify custom attributes that store additional information. You can specify multiple values for these parameters as a comma delimited list. Each ExtensionCustomAttribute parameter can hold up to 1,300 values.

For more information about custom attributes, see Custom Attributes.

For more information about using multivalued properties, see Modifying Multivalued Properties.

ExtensionCustomAttribute3

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The ExtensionCustomAttribute1-5 parameters specify custom attributes that store additional information. You can specify multiple values for these parameters as a comma delimited list. Each ExtensionCustomAttribute parameter can hold up to 1,300 values.

For more information about custom attributes, see Custom Attributes.

For more information about using multivalued properties, see Modifying Multivalued Properties.

ExtensionCustomAttribute4

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The ExtensionCustomAttribute1-5 parameters specify custom attributes that store additional information. You can specify multiple values for these parameters as a comma delimited list. Each ExtensionCustomAttribute parameter can hold up to 1,300 values.

For more information about custom attributes, see Custom Attributes.

For more information about using multivalued properties, see Modifying Multivalued Properties.

ExtensionCustomAttribute5

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The ExtensionCustomAttribute1-5 parameters specify custom attributes that store additional information. You can specify multiple values for these parameters as a comma delimited list. Each ExtensionCustomAttribute parameter can hold up to 1,300 values.

For more information about custom attributes, see Custom Attributes.

For more information about using multivalued properties, see Modifying Multivalued Properties.

GrantSendOnBehalfTo

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The GrantSendOnBehalfTo parameter specifies the DN of recipients that can send messages on behalf of this mail-enabled user.

HiddenFromAddressListsEnabled

Optional

System.Boolean

The HiddenFromAddressListsEnabled parameter specifies whether the mail-enabled user appears in the address list. The two possible values for this parameter are $true or $false. The default value is $false.

IgnoreDefaultScope

Optional

System.Management.Automation.SwitchParameter

The IgnoreDefaultScope parameter instructs the command to ignore the default recipient scope setting for the Exchange Management Shell session and use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently in the default scope. Using the IgnoreDefaultScope parameter introduces the following restrictions:

• You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically.
  
  
• You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted.
  
  

ImmutableId

Optional

System.String

The ImmutableId parameter is used by Outlook Live Directory Sync (OLSync) and specifies a unique and immutable identifier in the form of an SMTP address for an Exchange mailbox that's used for federated delegation when requesting Security Assertion Markup Language (SAML) tokens. If federation is configured for this mail-enabled user and you don't set this parameter when you create the mailbox, Exchange creates the value for the immutable identifier based upon the mailbox's ExchangeGUID and the federated account namespace, for example, 7a78e7c8-620e-4d85-99d3-c90d90f29699@mail.contoso.com. You must set the ImmutableId parameter if Active Directory Federation Services (AD FS) is deployed to allow single sign-on into off-premises mailboxes and AD FS is configured to use a different attribute than ExchangeGUID for sign-on token requests. Both, Exchange and AD FS must request the same token for the same user to ensure proper functionality for cross-premise Exchange organizations.

LitigationHoldDate

Optional

System.DateTime

The LitigationHoldDate parameter specifies the date when the mail-enabled user and its associated mailbox in the service are placed on litigation hold. The parameter is populated automatically when placing a mailbox on litigation hold. This can be used for informational or reporting purposes.

Note:
When using the Exchange Management Shell to place the mailbox on litigation hold, you can optionally specify any date as the LitigationHoldDate, but the mailbox is placed on litigation hold when the cmdlet is run.

LitigationHoldEnabled

Optional

System.Boolean

The LitigationHoldEnabled parameter specifies that the mail-enabled user and its associated mailbox in the service are under litigation hold and that messages can't be deleted from the mailbox. The two possible values for this parameter are $true or $false. The default value is $false. After a mailbox is placed on litigation hold, deleted items and all versions of changed items are retained in the Recoverable Items folder. Items that are purged from the dumpster are also retained and the items are held indefinitely. If you enable litigation hold, single-item recovery quotas aren't applied.

LitigationHoldOwner

Optional

System.String

The LitigationHoldOwner parameter specifies the user who placed the mail-enabled user and the associated mailbox in the service on litigation hold. The parameter is populated automatically when placing a mailbox on litigation hold. This can be used for informational and reporting purposes.

Note:
When using the Shell to place a mailbox on litigation hold, you can optionally specify a string value for this parameter.

MailTip

Optional

System.String

The MailTip parameter specifies the message displayed to senders when they start drafting an email message to this mail-enabled user. The MailTip parameter message must be less than or equal to 250 characters.

MailTipTranslations

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The MailTipTranslations parameter specifies additional languages when you want to provide the MailTip parameter information for this recipient in multiple languages. For each language, you must provide the locale, followed by a colon and the specific MailTip parameter message in that language. Each MailTip parameter message must be less than or equal to 250 characters. Multiple languages can be separated by commas.

MaxReceiveSize

Optional

Microsoft.Exchange.Data.Unlimited

The MaxReceiveSize parameter specifies the maximum size of email messages that can be received by the mail-enabled user, from 1 kilobyte (KB) through 2,097,151 KB.

If not specified, there are no size restrictions.

MaxSendSize

Optional

Microsoft.Exchange.Data.Unlimited

The MaxSendSize parameter specifies the maximum size of email messages that can be sent by the mail-enabled user, from 1 KB through 2,097,151 KB.

If not specified, there are no size restrictions.

ModeratedBy

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The ModeratedBy parameter specifies the users responsible for moderating the messages sent to the mail-enabled user. To designate more than one user, separate the users with commas.

This parameter is required if you set the ModerationEnabled parameter to $true. If you leave this parameter blank and there's a user already specified as the manager of this mail-enabled user, the ModeratedBy parameter is automatically set by the ManagedBy parameter of the distribution group. Otherwise, an error is returned.

ModerationEnabled

Optional

System.Boolean

The ModerationEnabled parameter specifies whether to enable moderation for the mail-enabled user. The two possible values for this parameter are $true or $false. To enable moderation, set this parameter to $true. To disable moderation, set this parameter to $false.

The default value is $false.

Name

Optional

System.String

The Name parameter specifies the name of the mail-enabled user.

Password

Optional

System.Security.SecureString

This parameter is reserved for internal Microsoft use.

PrimarySmtpAddress

Optional

Microsoft.Exchange.Data.SmtpAddress

The PrimarySmtpAddress parameter specifies the primary SMTP address.

RecipientLimits

Optional

Microsoft.Exchange.Data.Unlimited

The RecipientLimits parameter specifies the maximum number of recipients for messages from this mail-enabled user.

RejectMessagesFrom

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The RejectMessagesFrom parameter specifies the recipients from which to reject messages. You can use any of the following values to specify the recipients:

• Alias
  
  
• Canonical name
  
  
• Display name
  
  
• DN
  
  
• GUID
  
  
• Name
  
  
• LegacyExchangeDN
  
  
• Primary SMTP email address
  
  

By default, this parameter is blank, which enables the mail-enabled user to accept messages from all senders.

RejectMessagesFromDLMembers

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The RejectMessagesFromDLMembers parameter specifies the distribution list members from which to reject messages. You can use any of the following values to specify the recipients:

• DN
  
  
• Alias
  
  
• Canonical name
  
  
• Display name
  
  
• GUID
  
  
• Name
  
  
• LegacyExchangeDN
  
  
• Primary SMTP email address
  
  

By default, this parameter is blank, which enables the mail-enabled user to accept messages from all senders.

RejectMessagesFromSendersOrMembers

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The RejectMessagesFromSendersOrMembers parameter specifies the recipients who aren't allowed to send email messages to this mail-enabled user. You can use any of the following values to specify the recipients:

• Alias
  
  
• Canonical name
  
  
• Display name
  
  
• DN
  
  
• GUID
  
  
• Name
  
  
• LegacyExchangeDN
  
  
• Primary SMTP email address
  
  

By default, this parameter is blank, which enables the mail-enabled user to accept messages from all senders.

RemoteRoutingAddress

Optional

Microsoft.Exchange.Data.ProxyAddress

The RemoteRoutingAddress parameter specifies the SMTP address of the mailbox in the service that's associated with this mail-enabled user.

You shouldn't have to change the remote routing address if the address was automatically configured by Exchange when the mail-enabled user and its associated mailbox in the service were created.

RemovePicture

Optional

System.Management.Automation.SwitchParameter

The RemovePicture parameter specifies whether to remove the picture that a user has added to a mailbox.

RemoveSpokenName

Optional

System.Management.Automation.SwitchParameter

The RemoveSpokenName parameter specifies whether to remove the spoken name that a user has added to a mailbox.

RequireSenderAuthenticationEnabled

Optional

System.Boolean

The RequireSenderAuthenticationEnabled parameter specifies whether to accept messages only from authenticated recipients. The two possible values for this parameter are $true or $false. The default value is $false.

ResetPasswordOnNextLogon

Optional

System.Boolean

The ResetPasswordOnNextLogon parameter specifies whether to require the mail-enabled users to change their password the next time they sign in to the cloud-based service. The two possible values for this parameter are $true or $false. If the ResetPasswordOnNextLogon parameter is set to $true, the mail-enabled users are required to change their password the next time they sign in to the cloud-based service.

RetainDeletedItemsFor

Optional

Microsoft.Exchange.Data.EnhancedTimeSpan

The RetainDeletedItemsFor parameter specifies the length of time to keep deleted items.

To specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes, and s = seconds.

For example, to specify a 15-hour interval, enter 15:00:00.

RetentionComment

Optional

System.String

The RetentionComment parameter specifies a comment displayed in Microsoft Outlook regarding the user's retention hold status.

This comment can be set only if the RetentionHoldEnabled parameter is set to $true. This comment should be localized to the user's preferred language.

RetentionHoldEnabled

Optional

System.Boolean

The RetentionHoldEnabled parameter specifies whether retention hold is enabled for messaging retention policies. The two possible values for this parameter are $true or $false. To set the start date for retention hold, use the StartDateForRetentionHold parameter.

RetentionUrl

Optional

System.String

The RetentionUrl parameter specifies the URL or an external web page with additional details about the organization's messaging retention policies.

This URL can be used to expose details regarding retention policies in general, which is usually a customized legal or IT website for the company.

SamAccountName

Optional

System.String

The SamAccountName parameter specifies the logon name used to support clients and servers running older versions of the operating system, such as Microsoft Windows NT 4.0, Windows 98, Windows 95, and LAN Manager. This attribute must contain fewer than 20 characters. An account name can contain letters, numbers, and the following punctuation marks and symbols:

• !
  
  
• #
  
  
• $
  
  
• %
  
  
• ^
  
  
• &
  
  
• -
  
  
• .
  
  
• _
  
  
• {
  
  
• }
  
  
• |
  
  
• ~
  
  

SecondaryAddress

Optional

System.String

The SecondaryAddress parameter specifies the secondary address used by the Unified Messaging (UM)-enabled user.

SecondaryDialPlan

Optional

Microsoft.Exchange.Configuration.Tasks.UMDialPlanIdParameter

This parameter is reserved for internal Microsoft use.

SendModerationNotifications

Optional

Microsoft.Exchange.Data.Directory.Recipient.TransportModerationNotificationFlags

The SendModerationNotifications parameter specifies whether status notifications are sent to users when they send a message to the moderated mail-enabled user. You can use one of the following values:

• Always
  
  
• Internal
  
  
• Never
  
  

If you want notifications to be sent to all senders, set this parameter to Always.

If you want notifications to be sent only to the senders who are internal to your organization, set this parameter to Internal.

To disable all status notifications, set this parameter to Never.

Note:
The sender is always notified if the message is rejected by the moderators, regardless of the value of this parameter.

The default value is Never.

SimpleDisplayName

Optional

System.String

The SimpleDisplayName parameter is used to display an alternative description of the object when only a limited set of characters is permitted. This limited set of characters consists of ASCII characters 26 through 126, inclusively.

SingleItemRecoveryEnabled

Optional

System.Boolean

The SingleItemRecoveryEnabled parameter specifies whether to prevent the Recovery Items folder from being purged. When this parameter is set to $true, it prevents the Recovery Items folder from being purged. It also prevents any items from being removed that have been deleted or edited. The possible values for this parameter are $true or $false. The default value is $false.

StartDateForRetentionHold

Optional

System.DateTime

The StartDateForRetentionHold parameter specifies the start date for retention hold for MRM. To use this parameter, the RetentionHoldEnabled parameter must be set to $true.

Type

Optional

Microsoft.Exchange.Management.RecipientTasks.ConvertibleRemoteMailboxSubType

The Type parameter specifies the type for the mailbox in the service. You can use the following values:

• Regular
  
  
• Room
  
  
• Equipment
  
  

UMDtmfMap

Optional

Microsoft.Exchange.Data.MultiValuedProperty

This parameter is reserved for internal Microsoft use.

UserPrincipalName

Optional

System.String

The UserPrincipalName parameter specifies a UPN for the user.

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.

WindowsEmailAddress

Optional

Microsoft.Exchange.Data.SmtpAddress

The WindowsEmailAddress parameter specifies the Windows email address for this mail-enabled user. This address isn't used by Exchange.