[Index]

Model: device/exchangeonline/CASMailbox

Model Details

Title Description Details
DisplayName * This parameter is available only in on-premises Exchange 2016. The DisplayName parameter specifies the display name of the mailbox. The display name is visible in the Exchange admin center and in address lists. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks (").
  • Field Name: DisplayName
  • Type: String
ECPEnabled * This parameter is available only in on-premises Exchange 2016. The ECPEnabled parameter enables or disables access to the Exchange admin center (EAC) for the specified user. Valid input for this parameter is $true or $false. The default value is $true.
  • Field Name: ECPEnabled
  • Type: Boolean
ExternalPopSettings *
  • Field Name: ExternalPopSettings
  • Type: String
OrganizationId *
  • Field Name: OrganizationId
  • Type: String
UniversalOutlookEnabled * PARAMVALUE: $true | $false
  • Field Name: UniversalOutlookEnabled
  • Type: Boolean
EwsBlockList The EwsBlockList parameter specifies the Exchange Web Services applications (user agent strings) that aren't allowed to access the mailbox by using Exchange Web Services. To enter multiple values and overwrite any existing entries, use the following syntax: <value1>,<value2>.... If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "<value1>","<value2>".... To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="<value1>","<value2>"...; Remove="<value1>","<value2>"...}. This parameter is meaningful only when the EwsEnabled parameter is set to $true, and the EwsApplicationAccessPolicy parameter is set to EnforceBlockList.
  • Field Name: EwsBlockList.[n]
  • Type: Array
MAPIBlockOutlookRpcHttp * This parameter is available only in on-premises Exchange 2016. The MAPIBlockOutlookRpcHttp parameter enables or disables access to the mailbox in Outlook by using Outlook Anywhere. Valid values are: $true Access to the mailbox by using Outlook Anywhere is disabled. $false Access to the mailbox by using Outlook Anywhere is enabled. This is the default value.
  • Field Name: MAPIBlockOutlookRpcHttp
  • Type: Boolean
PopMessagesRetrievalMimeFormat * The PopMessagesRetrievalMimeFormat parameter specifies the message format for POP3 clients that access the mailbox. You can use an integer or a text value. Valid values are: 0: TextOnly 1: HtmlOnly 2: HtmlAndTextAlternative 3: TextEnrichedOnly 4: TextEnrichedAndTextAlternative 5: BestBodyFormat 6: Tnef The default value is BestBodyFormat. To change the value of this parameter, you also need to set the value of the PopUseProtocolDefaults parameter to $false.
  • Field Name: PopMessagesRetrievalMimeFormat
  • Type: String
ActiveSyncBlockedDeviceIDs The ActiveSyncBlockedDeviceIDs parameter specifies one or more Exchange ActiveSync device IDs that aren't allowed to synchronize with the mailbox. A device ID is a text string that uniquely identifies the device. Use the Get-MobileDevice cmdlet to see the devices that have Exchange ActiveSync partnerships with the mailbox. To enter multiple values and overwrite any existing entries, use the following syntax: <value1>,<value2>.... If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "<value1>","<value2>".... To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="<value1>","<value2>"...; Remove="<value1>","<value2>"...}. To clear the list of device IDs, use the value $null for this parameter.
  • Field Name: ActiveSyncBlockedDeviceIDs.[n]
  • Type: Array
ExternalSmtpSettings *
  • Field Name: ExternalSmtpSettings
  • Type: String
ObjectState *
  • Field Name: ObjectState
  • Type: String
InternalPopSettings *
  • Field Name: InternalPopSettings
  • Type: String
EwsApplicationAccessPolicy * The EwsApplicationAccessPolicy parameter controls access to the mailbox by using Exchange Web Services applications. Valid values for this parameter are: EnforceAllowList Only applications specified in the EwsAllowList parameter are allowed to access the mailbox. EnforceBlockList Applications specified in the EwsBlockList parameter aren't allowed to access the mailbox, but any other applications can access the mailbox. This parameter doesn't affect access to the mailbox by using Entourage, Outlook for Mac, and Outlook. Access to the mailbox by using these clients is controlled by the EwsAllowEntourage, EwsAllowMacOutlook and EwsAllowOutlook parameters.
  • Field Name: EwsApplicationAccessPolicy
  • Type: String
EmailAddresses This parameter is available only in on-premises Exchange 2016. The EmailAddresses parameter specifies all the email addresses (proxy addresses) for the recipient, including the primary SMTP address. In on-premises Exchange organizations, the primary SMTP address and other proxy addresses are typically set by email address policies. However, you can use this parameter to configure other proxy addresses for the recipient. For more information, see Email address policies in Exchange 2016. Valid syntax for this parameter is [<Type>]:<emailaddress1>,[<Type>]:<emailaddress2>.... The optional <Type> value specifies the type of email address. Some examples of valid values include: SMTP The primary SMTP address. You can use this value only once in a command. smtp Other SMTP email addresses. X400 X.400 addresses in on-premises Exchange. X500 X.500 addresses in on-premises Exchange. If you don't include a <Type> value for an email address, the value smtp is assumed. Note that Exchange doesn't validate the syntax of custom address types (including X.400 addresses). Therefore, you need to verify that any custom addresses are formatted correctly. To specify the primary SMTP email address, you can use any of the following methods: Use the <Type> value SMTP on the address. The first email address when you don't use any <Type> values, or when you use multiple <Type> values of smtp. If it's available, use the PrimarySmtpAddress parameter instead. You can't use the EmailAddresses parameter and the PrimarySmtpAddress parameter in the same command. To replace all existing proxy email addresses with the values you specify, use the following syntax: "[<Type>]:<emailaddress1>","[<Type>]:<emailaddress2>".... To add or remove specify proxy addresses without affecting other existing values, use the following syntax: @{Add="[<Type>]:<emailaddress1>","[<Type>]:<emailaddress2>"...; Remove="[<Type>]:<emailaddress2>","[<Type>]:<emailaddress2>"...}.
  • Field Name: EmailAddresses.[n]
  • Type: Array
ShowGalAsDefaultView * The ShowGalAsDefaultView parameter shows the global address list (GAL) as the default recipient picker for messages. Valid input for this parameter is $true or $false. The default value is $true.
  • Field Name: ShowGalAsDefaultView
  • Type: Boolean
PSShowComputerName
  • Field Name: PSShowComputerName
  • Type: Boolean
MapiHttpEnabled * This parameter is available only in on-premises Exchange 2016. The MapiHttpEnabled parameter enables or disables access to the mailbox in Outlook by using MAPI over HTTP. Valid values are: $true Access to the mailbox by using MAPI over HTTP is enabled. $false Access to the mailbox by using MAPI over HTTP is disabled. $null (blank) The setting isn't configured. The mailbox uses the organization setting for MAPI over HTTP (the MapiHttpEnabled parameter on the Set-OrganizationConfig cmdlet). This is the default value.
  • Field Name: MapiHttpEnabled
  • Type: Boolean
PopSuppressReadReceipt * The PopSuppressReadReceipt parameter controls the behavior of read receipts for POP3 clients that access the mailbox. Valid values for this parameter are: $true The user receives a read receipt when the recipient opens the message. $false The user receives two read receipts: one when the message is downloaded and another when the message is opened. The default value is $false. To change the value of this parameter, you also need to set the value of the PopUseProtocolDefaults parameter to $false.
  • Field Name: PopSuppressReadReceipt
  • Type: Boolean
ActiveSyncEnabled * The ActiveSyncEnabled parameter enables or disables Exchange ActiveSync for the mailbox. Valid input for this parameter is $true or $false. The default value is $true. When you set this parameter to $false, the other Exchange ActiveSync settings in this cmdlet are ignored.
  • Field Name: ActiveSyncEnabled
  • Type: Boolean
LinkedMasterAccount *
  • Field Name: LinkedMasterAccount
  • Type: String
PopForceICalForCalendarRetrievalOption * The PopForceICalForCalendarRetrievalOption parameter specifies how meeting requests are presented to POP3 clients that access the mailbox. Valid values for this parameter are: $true All meeting requests are in the iCal format. $false All meeting requests appear as Outlook on the web links. The default value is $false. To change the value of this parameter, you also need to set the value of the PopUseProtocolDefaults parameter to $false.
  • Field Name: PopForceICalForCalendarRetrievalOption
  • Type: Boolean
ObjectClass
  • Field Name: ObjectClass.[n]
  • Type: Array
PopMessageDeleteEnabled *
  • Field Name: PopMessageDeleteEnabled
  • Type: Boolean
PSComputerName
  • Field Name: PSComputerName
  • Type: String
WhenCreatedUTC *
  • Field Name: WhenCreatedUTC
  • Type: String
  • Format: date-time
InternalImapSettings *
  • Field Name: InternalImapSettings
  • Type: String
OWAEnabled * The OWAEnabled parameter enables or disables access to the mailbox by using Outlook on the web. Valid input for this parameter is $true or $false. The default value is $true. Note that when you set this parameter to $false, the other Outlook on the web settings in this cmdlet are ignored.
  • Field Name: OWAEnabled
  • Type: Boolean
MAPIBlockOutlookNonCachedMode * This parameter is available only in on-premises Exchange 2016. The MAPIBlockOutlookNonCachedMode parameter controls access to the mailbox by using Outlook in online or offline mode. Valid values for this parameter are: $true Only Outlook clients that are configured to use Cached Exchange Mode (offline mode) are allowed to access the mailbox. $false The state of the Cached Exchange Mode setting isn't checked before Outlook clients are allowed to access the mailbox (online mode and offline mode are allowed). The default value is $false.
  • Field Name: MAPIBlockOutlookNonCachedMode
  • Type: Boolean
ImapUseProtocolDefaults * The ImapUseProtocolDefaults parameter specifies whether to use the IMAP4 protocol defaults for the mailbox. Valid input for this parameter is $true or $false. The default value is $true. You need to set the ImapUseProtocolDefaults parameter to $false when you use any of the following IMAP4 parameters: ImapEnableExactRFC822Size ImapForceICalForCalendarRetrievalOption ImapMessagesRetrievalMimeFormat ImapSuppressReadReceipt
  • Field Name: ImapUseProtocolDefaults
  • Type: Boolean
ImapForceICalForCalendarRetrievalOption * The ImapForceICalForCalendarRetrievalOption parameter specifies how meeting requests are presented to IMAP4 clients that access the mailbox. Valid values for this parameter are: $true All meeting requests are in the iCal format. $false All meeting requests appear as Outlook on the web links. The default value is $false. To change the value of this parameter, you also need to set the value of the ImapUseProtocolDefaults parameter to $false.
  • Field Name: ImapForceICalForCalendarRetrievalOption
  • Type: Boolean
PopUseProtocolDefaults * The PopUseProtocolDefaults parameter specifies whether to use the POP3 protocol defaults for the mailbox. Valid input for this parameter is $true or $false. The default value is $true. You need to set the PopUseProtocolDefaults parameter to $false when you use any of following parameters: PopEnableExactRFC822Size PopForceICalForCalendarRetrievalOption PopMessagesRetrievalMimeFormat PopSuppressReadReceipt
  • Field Name: PopUseProtocolDefaults
  • Type: Boolean
EwsAllowEntourage * The EwsAllowEntourage parameter enables or disables access to the mailbox by Microsoft Entourage clients that use Exchange Web Services (for example, Entourage 2008 for Mac, Web Services Edition). Valid input for this parameter is $true or $false. The default value is $true.
  • Field Name: EwsAllowEntourage
  • Type: Boolean
PrimarySmtpAddress * This parameter is available only in on-premises Exchange 2016. The PrimarySmtpAddress parameter specifies the primary return email address that's used for the recipient. If it's available on this cmdlet, you can't use the EmailAddresses and PrimarySmtpAddress parameters in the same command.
  • Field Name: PrimarySmtpAddress
  • Type: String
ImapMessagesRetrievalMimeFormat * The ImapMessagesRetrievalMimeFormat parameter specifies the message format for IMAP4 clients that access the mailbox. You can use an integer or a text value. Valid values are: 0: TextOnly 1: HtmlOnly 2: HtmlAndTextAlternative 3: TextEnrichedOnly 4: TextEnrichedAndTextAlternative 5: BestBodyFormat 6: Tnef The default value is BestBodyFormat. To change the value of this parameter, you also need to set the value of the ImapUseProtocolDefaults parameter to $false.
  • Field Name: ImapMessagesRetrievalMimeFormat
  • Type: String
Identity * The Identity parameter specifies the mailbox that you want to view. 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
MAPIBlockOutlookExternalConnectivity * This parameter is available only in on-premises Exchange 2016. The MAPIBlockOutlookExternalConnectivity parameter enables or disables external access to the mailbox in Outlook by using Outlook Anywhere or MAPI over HTTP. Valid values are: $true External Outlook clients can't use Outlook Anywhere or MAPI over HTTP to access the mailbox. $false External Outlook clients can use Outlook Anywhere or MAPI over HTTP to access the mailbox.
  • Field Name: MAPIBlockOutlookExternalConnectivity
  • Type: Boolean
DistinguishedName *
  • Field Name: DistinguishedName
  • Type: String
InternalSmtpSettings *
  • Field Name: InternalSmtpSettings
  • Type: String
OriginatingServer *
  • Field Name: OriginatingServer
  • Type: String
ExchangeVersion *
  • Field Name: ExchangeVersion
  • Type: String
Name * This parameter is available only in on-premises Exchange 2016. The Name parameter specifies the unique name of the mailbox. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks (").
  • Field Name: Name
  • Type: String
IsOptimizedForAccessibility * PARAMVALUE: $true | $false
  • Field Name: IsOptimizedForAccessibility
  • Type: Boolean
ServerName *
  • Field Name: ServerName
  • Type: String
ImapEnabled * The ImapEnabled parameter enables or disables access to the mailbox by using IMAP4 clients. Valid input for this parameter is $true or $false. The default value is $true. Note that when you set this parameter to $false, the other IMAP4 settings in this cmdlet are ignored.
  • Field Name: ImapEnabled
  • Type: Boolean
MAPIBlockOutlookVersions * This parameter is available only in on-premises Exchange 2016. The MAPIBlockOutlookVersions parameter blocks access to the mailbox for specific versions of Outlook. For example, if you specify the value 15.0.4569.1503, only Outlook 2013 Service Pack 1 (SP1) or later clients are allowed to access the mailbox. Earlier versions of Outlook are blocked. The default value is blank. To reset this parameter, use the value $null.
  • Field Name: MAPIBlockOutlookVersions
  • Type: String
PopEnabled * The PopEnabled parameter enables or disables access to the mailbox by using POP3 clients. Valid input for this parameter is $true or $false. The default value is $true. Note that when you set this parameter to $false, the other POP3 settings in this cmdlet are ignored.
  • Field Name: PopEnabled
  • Type: Boolean
EwsEnabled * The EwsEnabled parameter enables or disables access to the mailbox by using Exchange Web Services clients. Valid input for this parameter is $true or $false. The default value is $true. Note that when you set this parameter to $false, the other Exchange Web Services settings in this cmdlet are ignored.
  • Field Name: EwsEnabled
  • Type: Boolean
ImapSuppressReadReceipt * The ImapSuppressReadReceipt parameter controls the behavior of read receipts for IMAP4 clients that access the mailbox. Valid values for this parameter are: $true The user receives a read receipt when the recipient opens the message. $false The user receives two read receipts: one when the message is downloaded and another when the message is opened. The default value is $false. To change the value of this parameter, you also need to set the value of the ImapUseProtocolDefaults parameter to $false.
  • Field Name: ImapSuppressReadReceipt
  • Type: Boolean
HasActiveSyncDevicePartnership *
  • Field Name: HasActiveSyncDevicePartnership
  • Type: Boolean
OwaMailboxPolicy * The OwaMailboxPolicy parameter specifies the Outlook on the web mailbox policy for the mailbox. You can use any value that uniquely identifies the Outlook on the web mailbox policy. For example: Name Distinguished name (DN) GUID The name of the default Outlook on the web mailbox policy is Default.
  • Field Name: OwaMailboxPolicy
  • Type: String
LegacyExchangeDN *
  • Field Name: LegacyExchangeDN
  • Type: String
ActiveSyncDebugLogging * The ActiveSyncDebugLogging switch shows the actual value of the ActiveSyncDebugLogging property for the mailbox. If you don't use this switch, the value always appears as $false. To see this value, you need to use a formatting cmdlet. For example, Get-CasMailbox [email protected] -ActiveSyncDebugLogging | Format-List.
  • Field Name: ActiveSyncDebugLogging
  • Type: Boolean
EwsAllowList The EwsAllowList parameter specifies the Exchange Web Services applications (user agent strings) that are allowed to access the mailbox. To enter multiple values and overwrite any existing entries, use the following syntax: <value1>,<value2>.... If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "<value1>","<value2>".... To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="<value1>","<value2>"...; Remove="<value1>","<value2>"...}. This parameter is meaningful only when the EwsEnabled parameter is set to $true, and the EwsApplicationAccessPolicy parameter is set to EnforceAllowList.
  • Field Name: EwsAllowList.[n]
  • Type: Array
ActiveSyncMailboxPolicyIsDefaulted *
  • Field Name: ActiveSyncMailboxPolicyIsDefaulted
  • Type: Boolean
MAPIEnabled * The MAPIEnabled parameter enables or disables access to the mailbox by using MAPI clients (for example, MicrosoftOutlook). Valid input for this parameter is $true or $false. The default value is $true. Note that when you set this parameter to $false, the other MAPI settings in this cmdlet are ignored.
  • Field Name: MAPIEnabled
  • Type: Boolean
ServerLegacyDN *
  • Field Name: ServerLegacyDN
  • Type: String
ActiveSyncAllowedDeviceIDs TheActiveSyncAllowedDeviceIDs parameter specifies one or more Exchange ActiveSync device IDs that are allowed to synchronize with the mailbox. A device ID is a text string that uniquely identifies the device. Use the Get-MobileDevice cmdlet to see the devices that have Exchange ActiveSync partnerships with the mailbox. To enter multiple values and overwrite any existing entries, use the following syntax: <value1>,<value2>.... If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "<value1>","<value2>".... To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="<value1>","<value2>"...; Remove="<value1>","<value2>"...}. To clear the list of device IDs, use the value $null for this parameter.
  • Field Name: ActiveSyncAllowedDeviceIDs.[n]
  • Type: Array
EwsAllowMacOutlook * The EwsAllowMacOutlook parameter enables or disables access to the mailbox by MicrosoftOutlook for Mac clients that use Exchange Web Services (for example, Outlook for Mac 2011). Valid input for this parameter is $true or $false. The default value is $true.
  • Field Name: EwsAllowMacOutlook
  • Type: Boolean
ActiveSyncSuppressReadReceipt * PARAMVALUE: SwitchParameter
  • Field Name: ActiveSyncSuppressReadReceipt
  • Type: Boolean
ActiveSyncMailboxPolicy * The ActiveSyncMailboxPolicy parameter specifies the Exchange ActiveSync mailbox policy for the mailbox. You can use any value that uniquely identifies the Exchange ActiveSync mailbox policy. For example: Name Distinguished name (DN) GUID The name of the default Exchange ActiveSync mailbox policy is Default.
  • Field Name: ActiveSyncMailboxPolicy
  • Type: String
SamAccountName * This parameter is available only in on-premises Exchange 2016. The SamAccountName parameter (also known as the pre-Windows 2000 user account or group name) specifies an object identifier that's compatible with older versions of Microsoft Windows client and server operating systems. The value can contain letters, numbers, spaces, periods (.), and the characters !, #, $, %, ^, &, -, _, {, }, and ~. The last character can't be a period. Unicode characters are allowed, but accented characters may generate collisions (for example, o and รถ match). The maximum length is 20 characters.
  • Field Name: SamAccountName
  • Type: String
ExternalImapSettings *
  • Field Name: ExternalImapSettings
  • Type: String
IsValid *
  • Field Name: IsValid
  • Type: Boolean
ObjectCategory *
  • Field Name: ObjectCategory
  • Type: String
OWAforDevicesEnabled * The OWAforDevicesEnabled parameter enables or disables access to the mailbox by using Outlook on the web for devices. Valid input for this parameter is $true or $false. The default value is $true.
  • Field Name: OWAforDevicesEnabled
  • Type: Boolean
ImapEnableExactRFC822Size * This parameter is available only in on-premises Exchange 2016. The ImapEnableExactRFC822Size parameter specifies how message sizes are presented to IMAP4 clients that access the mailbox. Valid values for this parameter are: $true Calculate the exact message size. $false Use an estimated message size. The default value is $false. We don't recommend changing this value unless you determine that the default setting causes problems for IMAP4 clients. To change the value of this parameter, you also need to set the value of the ImapUseProtocolDefaults parameter to $false.
  • Field Name: ImapEnableExactRFC822Size
  • Type: Boolean
WhenChanged *
  • Field Name: WhenChanged
  • Type: String
  • Format: date-time
WhenChangedUTC *
  • Field Name: WhenChangedUTC
  • Type: String
  • Format: date-time
WhenCreated *
  • Field Name: WhenCreated
  • Type: String
  • Format: date-time
PopEnableExactRFC822Size * This parameter is available only in on-premises Exchange 2016. The PopEnableExactRFC822Size parameter specifies how message sizes are presented to POP3 clients that access the mailbox. Valid values for this parameter are: $true Calculate the exact message size. $false Use an estimated message size. The default value is $false. We don't recommend changing this value unless you determine that the default setting causes problems for POP3 clients. To change the value of this parameter, you also need to set the value of the PopUseProtocolDefaults parameter to $false.
  • Field Name: PopEnableExactRFC822Size
  • Type: Boolean
RunspaceId
  • Field Name: RunspaceId
  • Type: String
Guid *
  • Field Name: Guid
  • Type: String
EwsAllowOutlook * The EwsAllowOutlook parameter enables or disables access to the mailbox by MicrosoftOutlook clients that use Exchange Web Services. Outlook uses Exchange Web Services for free/busy, out-of-office settings, and calendar sharing.
  • Field Name: EwsAllowOutlook
  • Type: Boolean
Id *
  • Field Name: Id
  • Type: String
API reference for device/exchangeonline/CASMailbox