Set-UMMailbox

 

Applies to: Exchange Server 2007 SP1, Exchange Server 2007 SP2, Exchange Server 2007 SP3

The Set-UMMailbox cmdlet sets the Unified Messaging (UM) properties for a user who is currently UM-enabled.

Syntax

Set-UMMailbox -Identity <MailboxIdParameter> [-AllowUMCallsFromNonUsers <None | SearchEnabled>] [-AnonymousCallersCanLeaveMessages <$true | $false>] [-AutomaticSpeechRecognitionEnabled <$true | $false>] [-CallAnsweringAudioCodec <G711 | Wma | Gsm>] [-Confirm [<SwitchParameter>]] [-DisplayName <String>] [-DomainController <Fqdn>] [-FaxEnabled <$true | $false>] [-IgnoreDefaultScope <SwitchParameter>] [-MissedCallNotificationEnabled <$true | $false>] [-Name <String>] [-OperatorNumber <String>] [-SubscriberAccessEnabled <$true | $false>] [-TUIAccessToAddressBookEnabled <$true | $false>] [-TUIAccessToCalendarEnabled <$true | $false>] [-TUIAccessToEmailEnabled <$true | $false>] [-UMMailboxPolicy <MailboxPolicyIdParameter>] [-UseRusServer <String>] [-WhatIf [<SwitchParameter>]]

Set-UMMailbox [-AllowUMCallsFromNonUsers <None | SearchEnabled>] [-AnonymousCallersCanLeaveMessages <$true | $false>] [-AutomaticSpeechRecognitionEnabled <$true | $false>] [-CallAnsweringAudioCodec <G711 | Wma | Gsm>] [-Confirm [<SwitchParameter>]] [-DisplayName <String>] [-DomainController <Fqdn>] [-FaxEnabled <$true | $false>] [-IgnoreDefaultScope <SwitchParameter>] [-Instance <UMMailbox>] [-MissedCallNotificationEnabled <$true | $false>] [-Name <String>] [-OperatorNumber <String>] [-SubscriberAccessEnabled <$true | $false>] [-TUIAccessToAddressBookEnabled <$true | $false>] [-TUIAccessToCalendarEnabled <$true | $false>] [-TUIAccessToEmailEnabled <$true | $false>] [-UMMailboxPolicy <MailboxPolicyIdParameter>] [-UseRusServer <String>] [-WhatIf [<SwitchParameter>]]

Detailed Description

The Set-UMMailbox cmdlet lets you set UM properties that are associated with a user who has been UM-enabled. Many of the UM properties for the user are stored on the user’s mailbox, and other UM properties for the user are stored in the Active Directory directory service. This cmdlet can be used to set UM properties individually by using either the Identity parameter or the Instance parameter.

To run the Set-UMMailbox cmdlet, the account you use must be delegated the Exchange Recipient Administrator role.

For more information about permissions, delegating roles, and the rights that are required to administer Microsoft Exchange Server 2007, see Permission Considerations.

Parameters

Parameter	Required	Type	Description
Identity	Required	Microsoft.Exchange.Configuration.Tasks.MailboxIdParameter	This parameter specifies the user to enable for Unified Messaging. The variables for this parameter include the following: ADObjectID GUID DN Domain\Account UPN LegacyExchangeDN SmtpAddress Alias This parameter is required if the Instance parameter is not used.
AllowUMCallsFromNonUsers	Optional	Microsoft.Exchange.Data.Directory.Recipient.AllowUMCallsFromNonUsersFlags	This parameter specifies whether to exclude the mailbox from directory searches.
AnonymousCallersCanLeaveMessages	Optional	System.Boolean	This parameter specifies whether diverted calls without a caller ID will be allowed to leave a message.
AutomaticSpeechRecognitionEnabled	Optional	System.Boolean	This parameter specifies whether the user can use Automatic Speech Recognition when they log on to their mailbox This parameter can only be set to $true if there is ASR support for the language selected by the user in Outlook Web Access Options.
CallAnsweringAudioCodec	Optional	Microsoft.Exchange.Data.Directory.SystemConfiguration.AudioCodecEnum	This parameter specifies the audio codec to use for call answering messages. The default for the user's mailbox is the audio codec that is configured on the UM dial plan.
Confirm	Optional	System.Management.Automation.SwitchParameter	This parameter causes the command to pause processing and requires the administrator to acknowledge what the command will do before processing continues. The default value is $true.
DisplayName	Optional	System.String	This parameter specifies the display name for the user.
DomainController	Optional	Microsoft.Exchange.Data.Fqdn	This parameter specifies the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to Active Directory.
FaxEnabled	Optional	System.Boolean	This parameter specifies whether a user is allowed to receive incoming faxes.
IgnoreDefaultScope	Optional	System.Management.Automation.SwitchParameter	This parameter instructs the command to ignore the default recipient scope setting for the Exchange Management Shell and use the entire forest as the scope. This allows the command to access Active Directory objects that are not currently in the default scope. Using the IgnoreDefaultScope parameter introduces the following restrictions: You cannot use the DomainController parameter. The command will use 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, are not accepted.
Instance	Optional	Microsoft.Exchange.Data.Directory.Management.UMMailbox	This parameter specifies the object input parameter. The Instance parameter is required if the Identity parameter is not used.
MissedCallNotificationEnabled	Optional	System.Boolean	This parameter specifies whether to send missed call notifications.
Name	Optional	System.String	This parameter specifies the display name for the user. The display name is limited to 64 characters.
OperatorNumber	Optional	System.String	This parameter specifies the string of digits for the personal operator.
SubscriberAccessEnabled	Optional	System.Boolean	This parameter specifies whether the user is allowed subscriber access to their individual mailbox. If it is set to $true, users, after they are authenticated, will be able to retrieve voice mail over the telephone.
TUIAccessToAddressBookEnabled	Optional	System.Boolean	This parameter specifies whether a user can access the directory and contact information over the telephone.
TUIAccessToCalendarEnabled	Optional	System.Boolean	This parameter specifies whether users can access their individual calendaring over the telephone.
TUIAccessToEmailEnabled	Optional	System.Boolean	This parameter specifies whether users can access their individual e-mail over the telephone.
UMMailboxPolicy	Optional	Microsoft.Exchange.Configuration.Tasks.MailboxPolicyIdParameter	This parameter specifies the UM mailbox policy that is associated with the UM-enabled user's mailbox.
UseRusServer	Optional	System.String	Note: This parameter is available only in Exchange 2007 SP2. 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	This parameter instructs the command to simulate the actions that it would take on the object. By using the WhatIf parameter, the administrator can view what changes would occur without having to apply any of those changes. The default value is $true.

Input Types

Type	Description

Return Types

Type	Description

Errors

Error	Description

Example

The first example modifies the secondary address and UM dial plan for yanli@contoso.com.

The second example prevents users from accessing their calendar and e-mail when they are using Outlook Voice Access.

The third example modifies the properties of a UM mailbox for yanli@contoso.com.

Set-UMMailbox -Identity yanli@contoso.com

Set-UMMailbox -Identity yanli@contoso.com -TUIAccessToCalendarEnabled $false -TUIAccessToEmailEnabled $false

Set-UMMailbox -Identity yanli@contoso.com -UMMailboxPolicy MyUMMailboxPolicy -FaxEnabled $true