[Index]

Model: device/exchangeonline/UMMailbox

Model Details: device/exchangeonline/UMMailbox

Title Description Details
NotifyEmail The NotifyEmail parameter specifies the email address where the Unified Messaging welcome message is sent. By default, the message is sent to the user's SMTP email address.
  • Field Name: NotifyEmail
  • Type: String
EnableCloudVoiceMail * PARAMVALUE: SwitchParameter
  • Field Name: EnableCloudVoiceMail
  • Type: Boolean
DisplayName
  • Field Name: DisplayName
  • Type: String
OrganizationId
  • Field Name: OrganizationId
  • Type: String
AirSyncNumbers
  • Field Name: AirSyncNumbers.[n]
  • Type: Array
TUIAccessToCalendarEnabled The TUIAccessToCalendarEnabled parameter specifies whether UM-enabled users can access and manage their individual calendar using the Microsoft Outlook Voice Access telephone user interface (TUI) or touchtone interface. The default value is $true.
  • Field Name: TUIAccessToCalendarEnabled
  • Type: Boolean
LegacyExchangeDN
  • Field Name: LegacyExchangeDN
  • Type: String
AllowUMCallsFromNonUsers The AllowUMCallsFromNonUsers parameter specifies whether to exclude the mailbox from directory searches.
  • Field Name: AllowUMCallsFromNonUsers
  • Type: String
SubscriberAccessEnabled The SubscriberAccessEnabled parameter specifies whether the users are allowed subscriber access to their individual mailboxes. If it's set to $true, after users are authenticated, they're able to retrieve voice mail over the telephone. The default value is $true.
  • Field Name: SubscriberAccessEnabled
  • Type: Boolean
OperatorNumber The OperatorNumber parameter specifies the string of digits for the personal operator.
  • Field Name: OperatorNumber
  • Type: String
ImListMigrationCompleted The ImListMigrationCompleted parameter specifies whether the UM-enabled user's Lync or Skype for Business contact list is stored in their mailbox. Valid values are: $true The user's Lync or Skype for Business contact list is stored in their Exchange 2016 mailbox. This prevents you from migrating the mailbox back to an Exchange 2010 server. $false The user's Lync or Skype for Business contact list is stored on a Lync or Skype for Business server. This doesn't prevent you from migrating the mailbox back to an Exchange 2010 server. This is the default value. Lync Server 2013 and Skype for Business Server 2015 support storing the user's contact list in their Exchange 2016 mailbox. This feature is known as the unified contact store (UCS), and it allows applications to show a consistent, up-to-date contact list. However, Exchange 2010 doesn't support the unified contact store. Therefore, before you migrate a user's Exchange 2016 mailbox back to Exchange 2010, you need to move the user's Lync or Skype for Business contact list from the unified contact store back to a Lync 2013 or Skype for Business server. For more information, see Configuring Microsoft Lync Server 2013 to use the unified contact store (http://go.microsoft.com/fwlink/p/?LinkID=313550). If you migrate an Exchange 2013 mailbox back to Exchange 2010 while the user's Lync or Skype for Business contact list is stored in the unified contact store, the user could permanently lose access to those contacts. After you verify the user's Lync or Skype for Business contact list has been moved back to a Lync 2013 or Skype for Business server, you should be able to complete the mailbox migration. If you need to migrate the mailbox despite the potential for data loss, you can manually set the ImListMigrationCompleted parameter to $false.
  • Field Name: ImListMigrationCompleted
  • Type: Boolean
UMSMSNotificationOption The UMSMSNotificationOption parameter specifies whether a UM-enabled user gets SMS or text messaging notifications for voice mail only, voice mail and missed calls, or no notifications. The values for this parameter are: VoiceMail, VoiceMailAndMissedCalls, and None. The default value is None.
  • Field Name: UMSMSNotificationOption
  • Type: String
EmailAddresses
  • Field Name: EmailAddresses.[n]
  • Type: Array
PSShowComputerName
  • Field Name: PSShowComputerName
  • Type: Boolean
PinlessAccessToVoiceMailEnabled The PinlessAccessToVoiceMailEnabled parameter specifies whether UM-enabled users are required to use a PIN to access their voice mail. A PIN is still required to access email and the calendar. The default value is $false.
  • Field Name: PinlessAccessToVoiceMailEnabled
  • Type: Boolean
UMMailboxPolicy * The UMMailboxPolicy parameter specifies the UM mailbox policy that you want to associate with the mailbox. You can use any value that uniquely identifies the policy. For example: Name Distinguished name (DN) GUID
  • Field Name: UMMailboxPolicy
  • Type: String
LinkedMasterAccount
  • Field Name: LinkedMasterAccount
  • Type: String
TUIAccessToEmailEnabled The TUIAccessToEmailEnabled parameter specifies whether users can access their individual email messages over the telephone. The default value is $true.
  • Field Name: TUIAccessToEmailEnabled
  • Type: Boolean
ObjectClass
  • Field Name: ObjectClass.[n]
  • Type: Array
CallAnsweringRulesExtensions
  • Field Name: CallAnsweringRulesExtensions.[n]
  • Type: Array
PSComputerName
  • Field Name: PSComputerName
  • Type: String
VoiceMailAnalysisEnabled The VoiceMailAnalysisEnabled parameter specifies whether a copy of each voice mail left for a UM-enabled user will be forwarded to Microsoft for analysis and improvement of speech recognition features.
  • Field Name: VoiceMailAnalysisEnabled
  • Type: Boolean
Extensions The Extensions parameter specifies the extension number for the user. Either a single extension number or an array of telephone number extensions can be specified. The user's extension must be unique to the UM dial plan. If you don't use this parameter, the command attempts to use a default telephone number value for the user. If you're using a Session Initiation Protocol (SIP) Uniform Resource Identifier (URI) or E.164 dial plan, you also need to use the SIPResourceIdentifier parameter.
  • Field Name: Extensions.[n]
  • Type: Array
UMEnabled
  • Field Name: UMEnabled
  • Type: Boolean
PilotNumber The PilotNumber parameter specifies the subscriber access number users can dial to gain access to their mailboxes. The default value is the subscriber access number that's specified on the UM dial plan.
  • Field Name: PilotNumber
  • Type: String
PrimarySmtpAddress
  • Field Name: PrimarySmtpAddress
  • Type: String
ServerName
  • Field Name: ServerName
  • Type: String
Identity * The Identity parameter specifies the mailbox that you want to enable for Unified Messaging. You can use any value that uniquely identifies the mailbox. For example: Name Display name Alias Distinguished name (DN) Canonical DN <domain name>\<account name> Email address GUID LegacyExchangeDN SamAccountName User ID or user principal name (UPN)
  • Field Name: Identity
  • Type: String
DistinguishedName
  • Field Name: DistinguishedName
  • Type: String
OriginatingServer
  • Field Name: OriginatingServer
  • Type: String
Name The Name parameter specifies the display name for the user. The display name is limited to 64 characters.
  • Field Name: Name
  • Type: String
PinExpired The PINExpired parameter specifies whether the PIN is treated as expired. If the PIN isn't supplied, the PIN is treated as expired and users are prompted to reset their PIN the next time they log on. $true The user is required to reset their PIN the next time they log on. $false The user isn't required to reset their PIN the next time they log on.
  • Field Name: PinExpired
  • Type: Boolean
SIPResourceIdentifier The SIPResourceIdentifier parameter specifies the SIP address or E.164 address for the user. This property is compared to the URI type defined on the UM dial plan.
  • Field Name: SIPResourceIdentifier
  • Type: String
WhenCreatedUTC
  • Field Name: WhenCreatedUTC
  • Type: String
  • Format: date-time
SendWelcomeMail PARAMVALUE: $true | $false
  • Field Name: SendWelcomeMail
  • Type: Boolean
AnonymousCallersCanLeaveMessages The AnonymousCallersCanLeaveMessages parameter specifies whether diverted calls without a caller ID are allowed to leave a message.
  • Field Name: AnonymousCallersCanLeaveMessages
  • Type: Boolean
CallAnsweringAudioCodec The CallAnsweringAudioCodec parameter specifies the audio codec used to encode voice mail messages left for the user. The audio codec used is the audio codec set on the UM dial plan. The default value is Mp3.
  • Field Name: CallAnsweringAudioCodec
  • Type: String
WhenCreated
  • Field Name: WhenCreated
  • Type: String
  • Format: date-time
PlayOnPhoneEnabled The PlayOnPhoneEnabled parameter specifies whether a user can use the Play on Phone feature to listen to voice messages. The default value is $true.
  • Field Name: PlayOnPhoneEnabled
  • Type: Boolean
AutomaticSpeechRecognitionEnabled The AutomaticSpeechRecognitionEnabled parameter specifies whether to enable Automatic Speech Recognition (ASR) for the UM mailbox. Valid values are: $true ASR is enabled for the mailbox. This is the default value. ASR is available only if the user's specified preferred language is installed. $false ASR is disabled for the mailbox.
  • Field Name: AutomaticSpeechRecognitionEnabled
  • Type: Boolean
ServerLegacyDN
  • Field Name: ServerLegacyDN
  • Type: String
UMAddresses
  • Field Name: UMAddresses.[n]
  • Type: Array
ExchangeVersion
  • Field Name: ExchangeVersion
  • Type: String
AccessTelephoneNumbers
  • Field Name: AccessTelephoneNumbers.[n]
  • Type: Array
CallAnsweringRulesEnabled The CallAnsweringRulesEnabled parameter specifies whether users can configure or set up Call Answering Rules for their accounts. The default value is $true.
  • Field Name: CallAnsweringRulesEnabled
  • Type: Boolean
PhoneNumber This parameter is available only in the cloud-based service. The PhoneNumber parameter specifies whether to assign a phone number to a UM-enabled user. This is only used for E.164 consumer dial plans.
  • Field Name: PhoneNumber
  • Type: String
DomainController This parameter is available only in on-premises Exchange 2016. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com.
  • Field Name: DomainController
  • Type: String
SamAccountName
  • Field Name: SamAccountName
  • Type: String
Pin The PIN parameter specifies the value for the initial PIN that's used for the UM mailbox. The PIN is checked against the UM mailbox policy rules. The PIN value must be from 4 through 24 numeric characters. If you don't use this parameter, a system-generated PIN is sent to the user. By default, the PIN generated by the system contains six numeric characters.
  • Field Name: Pin
  • Type: String
ObjectCategory
  • Field Name: ObjectCategory
  • Type: String
IsValid
  • Field Name: IsValid
  • Type: Boolean
PhoneProviderId This parameter is available only in the cloud-based service. The PhoneProviderId parameter specifies the user's phone number and mobile service provider. This information is used to provide custom call forwarding and cancelling voice mail setup instructions based on the mobile phone provider.
  • Field Name: PhoneProviderId
  • Type: String
UMDialPlan
  • Field Name: UMDialPlan
  • Type: String
WhenChanged
  • Field Name: WhenChanged
  • Type: String
  • Format: date-time
WhenChangedUTC
  • Field Name: WhenChangedUTC
  • Type: String
  • Format: date-time
FaxEnabled The FaxEnabled parameter specifies whether a user is allowed to receive incoming faxes.
  • Field Name: FaxEnabled
  • Type: Boolean
ObjectState
  • Field Name: ObjectState
  • Type: String
MissedCallNotificationEnabled The MissedCallNotificationEnabled parameter specifies whether to send missed call notifications. When you're integrating Unified Messaging and Lync Server or Skype for Business Server, missed call notifications aren't available to users who have mailboxes located on Exchange 2010 Mailbox servers. A missed call notification is generated when a user disconnects before the call is sent to a Mailbox server.
  • Field Name: MissedCallNotificationEnabled
  • Type: Boolean
Guid
  • Field Name: Guid
  • Type: String
Id
  • Field Name: Id
  • Type: String
UMDtmfMap
  • Field Name: UMDtmfMap.[n]
  • Type: Array