Applies to: Exchange Server 2010 SP3, Exchange Server 2010 SP2
Topic Last Modified: 2012-11-16
Use the Set-MailUser cmdlet to modify the mail-related attributes of an existing user in Active Directory.
Syntax
set-MailUser -Identity <MailUserIdParameter>
[-AcceptMessagesOnlyFrom <MultiValuedProperty>]
[-AcceptMessagesOnlyFromDLMembers <MultiValuedProperty>]
[-AcceptMessagesOnlyFromSendersOrMembers
<MultiValuedProperty>] [-Alias <String>]
[-ArbitrationMailbox <MailboxIdParameter>] [-ArchiveGuid
<Guid>] [-ArchiveName <MultiValuedProperty>]
[-ArchiveQuota <Unlimited>] [-ArchiveWarningQuota
<Unlimited>] [-BypassLiveId <SwitchParameter>]
[-BypassModerationFromSendersOrMembers <MultiValuedProperty>]
[-CalendarVersionStoreDisabled <$true | $false>] [-Confirm
[<SwitchParameter>]] [-CreateDTMFMap <$true | $false>]
[-CustomAttribute1 <String>] [-CustomAttribute10
<String>] [-CustomAttribute11 <String>]
[-CustomAttribute12 <String>] [-CustomAttribute13
<String>] [-CustomAttribute14 <String>]
[-CustomAttribute15 <String>] [-CustomAttribute2
<String>] [-CustomAttribute3 <String>]
[-CustomAttribute4 <String>] [-CustomAttribute5
<String>] [-CustomAttribute6 <String>]
[-CustomAttribute7 <String>] [-CustomAttribute8
<String>] [-CustomAttribute9 <String>] [-DisplayName
<String>] [-DomainController <Fqdn>] [-EmailAddresses
<ProxyAddressCollection>] [-EmailAddressPolicyEnabled
<$true | $false>] [-EndDateForRetentionHold <DateTime>]
[-ExchangeGuid <Guid>] [-ExtensionCustomAttribute1
<MultiValuedProperty>] [-ExtensionCustomAttribute2
<MultiValuedProperty>] [-ExtensionCustomAttribute3
<MultiValuedProperty>] [-ExtensionCustomAttribute4
<MultiValuedProperty>] [-ExtensionCustomAttribute5
<MultiValuedProperty>] [-ExternalEmailAddress
<ProxyAddress>] [-FederatedIdentity <String>]
[-ForceUpgrade <SwitchParameter>] [-GrantSendOnBehalfTo
<MultiValuedProperty>] [-HiddenFromAddressListsEnabled
<$true | $false>] [-IgnoreDefaultScope
<SwitchParameter>] [-ImmutableId <String>]
[-LitigationHoldDate <DateTime>] [-LitigationHoldEnabled
<$true | $false>] [-LitigationHoldOwner <String>]
[-MacAttachmentFormat <BinHex | UuEncode | AppleSingle |
AppleDouble>] [-MailTip <String>] [-MailTipTranslations
<MultiValuedProperty>] [-MaxReceiveSize <Unlimited>]
[-MaxSendSize <Unlimited>] [-MessageBodyFormat <Text |
Html | TextAndHtml>] [-MessageFormat <Text | Mime>]
[-ModeratedBy <MultiValuedProperty>] [-ModerationEnabled
<$true | $false>] [-Name <String>] [-NetID
<NetID>] [-Password <SecureString>]
[-PrimarySmtpAddress <SmtpAddress>] [-RecipientLimits
<Unlimited>] [-RejectMessagesFrom
<MultiValuedProperty>] [-RejectMessagesFromDLMembers
<MultiValuedProperty>] [-RejectMessagesFromSendersOrMembers
<MultiValuedProperty>] [-RemovePicture
<SwitchParameter>] [-RemoveSpokenName
<SwitchParameter>] [-RequireSenderAuthenticationEnabled
<$true | $false>] [-ResetPasswordOnNextLogon <$true |
$false>] [-RetainDeletedItemsFor <EnhancedTimeSpan>]
[-RetentionComment <String>] [-RetentionHoldEnabled <$true
| $false>] [-RetentionUrl <String>] [-SamAccountName
<String>] [-SecondaryAddress <String>]
[-SecondaryDialPlan <UMDialPlanIdParameter>]
[-SendModerationNotifications <Never | Internal | Always>]
[-SimpleDisplayName <String>] [-SingleItemRecoveryEnabled
<$true | $false>] [-SKUAssigned <$true | $false>]
[-SKUCapability <None | BPOS_S_Deskless | BPOS_S_Standard |
BPOS_S_Enterprise | BPOS_S_Archive | BPOS_L_Standard |
BPOS_B_Standard | TOU_Signed | FederatedUser | Partner_Managed |
MasteredOnPremise | ResourceMailbox | ExcludedFromBackSync |
UMFeatureRestricted | RichCoexistence>]
[-StartDateForRetentionHold <DateTime>] [-UMDtmfMap
<MultiValuedProperty>] [-UsageLocation <CountryInfo>]
[-UseMapiRichTextFormat <Never | Always |
UseDefaultSettings>] [-UsePreferMessageFormat <$true |
$false>] [-UserPrincipalName <String>] [-WhatIf
[<SwitchParameter>]] [-WindowsEmailAddress
<SmtpAddress>] [-WindowsLiveID <SmtpAddress>]
|
Detailed Description
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.
Parameters
Parameter | Required | Type | Description | ||
---|---|---|---|---|---|
Identity |
Required |
Microsoft.Exchange.Configuration.Tasks.MailUserIdParameter |
The Identity parameter specifies the mail user. This parameter accepts the following values:
|
||
AcceptMessagesOnlyFrom |
Optional |
Microsoft.Exchange.Data.MultiValuedProperty |
The AcceptMessagesOnlyFrom parameter specifies the mailbox users and mail users that can send e-mail messages to this mail user. You can also specify Exchange as a valid recipient for this parameter. If you configure a mail user to accept messages only from the Exchange recipient, the mail user only receives system-generated messages. You can use one of the following values for the valid senders:
By default, this parameter is blank, which enables the mail 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 e-mail messages to this mail user. You can use any of the following values for the allowed distribution groups:
By default, this parameter is blank, which enables the mail user to accept messages from all senders. |
||
AcceptMessagesOnlyFromSendersOrMembers |
Optional |
Microsoft.Exchange.Data.MultiValuedProperty |
The AcceptMessagesOnlyFromSendersOrMembers parameter specifies the recipients who are allowed to send e-mail messages to this mail user. You can use any of the following values for the allowed distribution groups:
By default, this parameter is blank, which enables the mail user to accept messages from all senders. |
||
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:
|
||
ArbitrationMailbox |
Optional |
Microsoft.Exchange.Configuration.Tasks.MailboxIdParameter |
The ArbitrationMailbox parameter specifies the mailbox user who is used to manage the moderation process. |
||
ArchiveGuid |
Optional |
System.Guid |
This parameter is reserved for internal Microsoft use. |
||
ArchiveName |
Optional |
Microsoft.Exchange.Data.MultiValuedProperty |
This parameter is reserved for internal Microsoft use. |
||
ArchiveQuota |
Optional |
Microsoft.Exchange.Data.Unlimited |
The ArchiveQuota parameter specifies the archive mailbox size at which it no longer accepts messages. When you enter a value, qualify the value with one of the following units:
Unqualified values are treated as bytes. The value must be greater than the value of the ArchiveWarningQuota parameter. The valid input range for either parameter is from 1 through 9223372036854775807 bytes. |
||
ArchiveWarningQuota |
Optional |
Microsoft.Exchange.Data.Unlimited |
The ArchiveWarningQuota parameter specifies the archive mailbox size at which a warning message is sent to the user. When you enter a value, qualify the value with one of the following units:
Unqualified values are treated as bytes. The value must be less than the value of the ArchiveQuota parameter. The valid input range for either parameter is from 1 through 9223372036854775807 bytes. |
||
BypassLiveId |
Optional |
System.Management.Automation.SwitchParameter |
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 user. You can use any of the following values:
This value makes sure that all messages are moderated when this mail user is configured for moderation.
|
||
CalendarVersionStoreDisabled |
Optional |
System.Boolean |
This parameter is reserved for internal Microsoft use. |
||
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 |
The CreateDTMFMap parameter specifies that a dual tone multi-frequency (DTMF) map be created for the user. |
||
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 of the 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 e-mail alias of the mail user. All valid Exchange e-mail address types may be used. You can specify multiple values for the EmailAddresses parameter as a comma-delimited list.
|
||
EmailAddressPolicyEnabled |
Optional |
System.Boolean |
The EmailAddressPolicyEnabled parameter specifies whether
the e-mail addresses for the mailbox are automatically updated
based on the e-mail address policies defined. The two possible
values for this parameter are |
||
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 |
||
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 Understanding 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 Understanding 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 Understanding 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 Understanding 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 Understanding Custom Attributes. For more information about using multivalued properties, see Modifying Multivalued Properties. |
||
ExternalEmailAddress |
Optional |
Microsoft.Exchange.Data.ProxyAddress |
The ExternalEmailAddress parameter specifies an e-mail address outside the organization. E-mail messages sent to the user are sent to this external address. |
||
FederatedIdentity |
Optional |
System.String |
This parameter applies to objects in the cloud-based service. It isn’t available for on-premises deployments. The FederatedIdentity parameter associates an on-premises Active Directory user with a Microsoft Office user. |
||
ForceUpgrade |
Optional |
System.Management.Automation.SwitchParameter |
The ForceUpgrade parameter suppresses the following confirmation: "To save changes on object <object name>, the object must be upgraded to the current Exchange version. After the upgrade, this object cannot be managed by an earlier version of the Exchange Management Tools. Do you want to continue to upgrade and save the object?" This confirmation occurs when you upgrade a mail user that was created in Microsoft Exchange Server 2003. You can't manage an Exchange 2003 mail user by using the Exchange Management Console until you update the object's version. |
||
GrantSendOnBehalfTo |
Optional |
Microsoft.Exchange.Data.MultiValuedProperty |
The GrantSendOnBehalfTo parameter specifies the DN of recipients that can send messages on behalf of this user. |
||
HiddenFromAddressListsEnabled |
Optional |
System.Boolean |
The HiddenFromAddressListsEnabled parameter specifies
whether the user appears in the address list. The two possible
values for this parameter are |
||
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:
|
||
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 mailbox and you don't set this parameter when you create the mailbox, Exchange will create the value for the immutable ID 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 mailbox is 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.
|
||
LitigationHoldEnabled |
Optional |
System.Boolean |
The LitigationHoldEnabled parameter specifies that the
mailbox is under litigation hold and that messages can't be deleted
from the user's account. The two possible values for this parameter
are |
||
LitigationHoldOwner |
Optional |
System.String |
The LitigationHoldOwner parameter specifies the user who placed the mailbox on litigation hold. The parameter is populated automatically when placing a mailbox on litigation hold. This can be used for informational and reporting purposes.
|
||
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:
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. |
||
MailTip |
Optional |
System.String |
The MailTip parameter specifies the message displayed to senders when they start drafting an e-mail message to this recipient. 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 MailTipTranslations 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 e-mail messages that can be received by the mail 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 e-mail messages that can be sent by the mail user, from 1 KB through 2,097,151 KB. If not specified, there are no size restrictions. |
||
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:
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:
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. |
||
ModeratedBy |
Optional |
Microsoft.Exchange.Data.MultiValuedProperty |
The ModeratedBy parameter specifies the users responsible for moderating the messages sent to the distribution group. To designate more than one user, separate the users with commas. This parameter is required if you set the
ModerationEnabled parameter to |
||
ModerationEnabled |
Optional |
System.Boolean |
The ModerationEnabled parameter specifies whether to
enable moderation for the distribution group. The two possible
values for this parameter are The default value is |
||
Name |
Optional |
System.String |
The Name parameter specifies the name of the user. |
||
NetID |
Optional |
Microsoft.Exchange.Data.NetID |
This parameter is reserved for internal Microsoft use. |
||
Password |
Optional |
System.Security.SecureString |
This parameter applies to objects in the cloud-based service. It isn’t available for on-premises deployments. This parameter is available for multi-tenant deployments. It isn't available for on-premises deployments. For more information about multi-tenant deployments, see Multi-Tenant Support. The Password parameter resets the password of the user account associated with the cloud-based mailbox. |
||
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 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:
By default, this parameter is blank, which enables the mail 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:
By default, this parameter is blank, which enables the mail 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 e-mail messages to this mail user. You can use any of the following values to specify the recipients:
By default, this parameter is blank, which enables the mail user to accept messages from all senders. |
||
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
|
||
ResetPasswordOnNextLogon |
Optional |
System.Boolean |
This parameter applies to objects in the cloud-based service. It isn’t available for on-premises deployments. If the ResetPasswordOnNextLogon parameter is set to
|
||
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 Outlook regarding the user's retention hold status. This comment can be set only if the RetentionHoldEnabled
parameter is set to |
||
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 |
||
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 Web site 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 |
The SecondaryDialPlan parameter specifies a secondary UM dial plan to use. This parameter is provided to create a secondary proxy address. |
||
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 distribution group. You can use one of the following values:
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.
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 |
||
SKUAssigned |
Optional |
System.Boolean |
This parameter is reserved for internal Microsoft use. |
||
SKUCapability |
Optional |
Microsoft.Exchange.Data.Directory.Capability |
This parameter is reserved for internal Microsoft use. |
||
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
|
||
UMDtmfMap |
Optional |
Microsoft.Exchange.Data.MultiValuedProperty |
The UMDtmfMap parameter specifies whether you want to create a user-defined DTMF map for the UM-enabled user. |
||
UsageLocation |
Optional |
Microsoft.Exchange.Data.Directory.CountryInfo |
This parameter is reserved for internal Microsoft use. |
||
UseMapiRichTextFormat |
Optional |
Microsoft.Exchange.Data.Directory.Recipient.UseMapiRichTextFormat |
The UseMapiRichTextFormat parameter specifies how messages in MAPI rich text format (RTF) are handled for this mail user. You can use one of the following values:
To convert all messages sent to this user to plain text, set
this parameter to Never. To always send messages to this user in
MAPI RTF, set this parameter to Always. To have the format
determined based on the setting configured in the MAPI client that
sent the message, set this parameter to
|
||
UsePreferMessageFormat |
Optional |
System.Boolean |
The UsePreferMessageFormat parameter specifies whether
the message format settings configured for the mail user override
the global settings configured for the remote domain. The two
possible values for this parameter are |
||
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 e-mail address for this mailbox. This address isn't used by Exchange. |
||
WindowsLiveID |
Optional |
Microsoft.Exchange.Data.SmtpAddress |
This parameter applies to objects in the cloud-based service. It isn’t available for on-premises deployments. The WindowsLiveID parameter renames the Windows Live ID associated with the mail user. |
Input Types
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.
Return Types
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.
Examples
EXAMPLE 1
This example sets the e-mail address outside the organization to which mail-enabled user John Woods' (john) e-mail is sent.
Copy Code | |
---|---|
Set-MailUser john -ExternalEmailAddress john@tailspintoys.com |