[Index]

Model: device/exchange/UMMailbox

Model Details

Title Description Details
NotifyEmail The NotifyEmail parameter specifies the email address to which the server sends the email message that contains the Unified Messaging welcome information. By default, the message is sent to the SMTP address of the enabled user.
  • Field Name: NotifyEmail
  • Type: String
AllowUMCallsFromNonUsers The AllowUMCallsFromNonUsers parameter specifies whether to exclude the mailbox from directory searches.
  • Field Name: AllowUMCallsFromNonUsers
  • Type: String
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
OrganizationId
  • Field Name: OrganizationId
  • Type: String
AirSyncNumbers The AirSyncNumbers parameter specifies whether to register a mobile phone number with a hosted voice mail service. Each UM mailbox can have up to three numbers defined, and numbers must be in E.164 format.
  • 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
OriginatingServer
  • Field Name: OriginatingServer
  • 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 a UM-enabled user's Microsoft Lync 2013 contact list has been successfully migrated from a user's Exchange mailbox to Lync 2013 servers and that the user's Microsoft Exchange Server 2013 mailbox can be migrated back to Exchange Server 2010. For Lync 2013, the contact list for a Lync user can be stored in an Exchange 2013 user's mailbox called a Unified Contact Store (UCS). By storing the contact list in a user's mailbox, it allows applications to show a consistent, up-to-date list of the user's contact list. If a user's mailbox is being migrated from Exchange 2013 to Exchange 2010, and the user is in UCS mode, the user's contact list must first be moved from their Exchange 2013 mailbox to Lync 2013 to preserve the user's contact list. This is the case because Exchange 2010 doesn't support the Exchange Web Services (EWS) methods used to support the UCS feature in Lync 2013. A setting of $false indicates that a Lync user's contacts haven't been migrated. The default is $false.
  • Field Name: ImListMigrationCompleted
  • Type: Boolean
DisplayName
  • Field Name: DisplayName
  • 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 name of the UM mailbox policy to be associated with the user.
  • 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 this parameter isn't included, a default telephone number value from Active Directory is used. If you're enabling a user for Unified Messaging using a Session Initiation Protocol (SIP) Uniform Resource Identifier (URI) or E.164 dial plan, you must also specify 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 specified on a dial plan object in Active Directory.
  • Field Name: PilotNumber
  • Type: String
PrimarySmtpAddress
  • Field Name: PrimarySmtpAddress
  • Type: String
ServerName
  • Field Name: ServerName
  • Type: String
Identity * The Identity parameter specifies the user to enable for Unified Messaging. The values for this parameter include the following: ADObjectID GUID Distinguished name (DN) Domain\Account user principal name (UPN) LegacyExchangeDN SmtpAddress Alias
  • Field Name: Identity
  • Type: String
DistinguishedName
  • Field Name: DistinguishedName
  • Type: String
UMDialPlan
  • Field Name: UMDialPlan
  • 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 this parameter is supplied and is set to $false, users aren't required to reset their PIN the next time they log on. 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.
  • 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
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 enables Automatic Speech Recognition (ASR) to be used with the UM mailbox. ASR is only available if the user's specified language preference is installed.
  • 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 applies to objects in the cloud-based service. It isn't available for on-premises deployments. 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 The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to Active Directory.
  • Field Name: DomainController
  • Type: String
SamAccountName
  • Field Name: SamAccountName
  • Type: String
Pin The PIN parameter specifies the value for the initial PIN to be used with 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 no PIN is specified, a PIN generated by the system is sent to the user. The PIN generated by the system contains six numeric characters, which is the default.
  • Field Name: Pin
  • Type: String
ObjectCategory
  • Field Name: ObjectCategory
  • Type: String
IsValid
  • Field Name: IsValid
  • Type: Boolean
PhoneProviderId This parameter applies to objects in the cloud-based service. It isn't available for on-premises deployments. 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
WhenChanged
  • Field Name: WhenChanged
  • 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, missed call notifications aren't available to users who have a mailbox located on an Exchange 2007 or Exchange 2010 Mailbox server. 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
UMDtmfMap
  • Field Name: UMDtmfMap.[n]
  • Type: Array
API reference for device/exchange/UMMailbox