[Index]
Model ref.: device/exchangeonline/CASMailbox
The full URL would include the host-proxy name: https://[host-proxy].
Variables are enclosed in square brackets.
{
"$schema": "http://json-schema.org/draft-03/schema",
"type": "object",
"properties": {
"DisplayName": {
"__type_requested": "System.String",
"required": true,
"name": "DisplayName",
"title": "DisplayName",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"description": "This parameter is available only in on-premises Exchange 2016.\nThe 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 (\")."
},
"ECPEnabled": {
"__type_requested": "System.Boolean",
"required": true,
"name": "ECPEnabled",
"title": "ECPEnabled",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"description": "This parameter is available only in on-premises Exchange 2016.\nThe 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."
},
"ExternalPopSettings": {
"__type_requested": "",
"required": true,
"name": "ExternalPopSettings",
"title": "ExternalPopSettings",
"__type_mapping_type": "Unknown",
"readonly": true,
"type": "string",
"__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
},
"OrganizationId": {
"__type_requested": "System.String",
"required": true,
"name": "OrganizationId",
"title": "OrganizationId",
"__type_mapping_type": "String",
"readonly": false,
"type": "string"
},
"OWAforDevicesEnabled": {
"__type_requested": "System.Boolean",
"required": true,
"name": "OWAforDevicesEnabled",
"title": "OWAforDevicesEnabled",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"description": "The OWAforDevicesEnabled parameter enables or disables access to the mailbox by using Outlook on the web for devices.\nValid input for this parameter is $true or $false. The default value is $true."
},
"EwsBlockList": {
"__type_requested": "MultiValuedProperty",
"required": true,
"name": "EwsBlockList",
"title": "EwsBlockList",
"items": {
"type": "string"
},
"__type_mapping_type": "String[]",
"readonly": false,
"type": "array",
"description": "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.\nTo 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>\"....\nTo add or remove one or more values without affecting any existing entries, use the following syntax: @{Add=\"<value1>\",\"<value2>\"...; Remove=\"<value1>\",\"<value2>\"...}.\nThis parameter is meaningful only when the EwsEnabled parameter is set to $true, and the EwsApplicationAccessPolicy parameter is set to EnforceBlockList."
},
"MAPIBlockOutlookRpcHttp": {
"__type_requested": "System.Boolean",
"required": true,
"name": "MAPIBlockOutlookRpcHttp",
"title": "MAPIBlockOutlookRpcHttp",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"description": "This parameter is available only in on-premises Exchange 2016.\nThe MAPIBlockOutlookRpcHttp parameter enables or disables access to the mailbox in Outlook by using Outlook Anywhere. Valid values are:\n$true Access to the mailbox by using Outlook Anywhere is disabled.\n$false Access to the mailbox by using Outlook Anywhere is enabled. This is the default value."
},
"OWAEnabled": {
"__type_requested": "System.Boolean",
"required": true,
"name": "OWAEnabled",
"title": "OWAEnabled",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"description": "The OWAEnabled parameter enables or disables access to the mailbox by using Outlook on the web.\nValid 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."
},
"PopMessagesRetrievalMimeFormat": {
"__type_requested": "System.String",
"required": true,
"name": "PopMessagesRetrievalMimeFormat",
"title": "PopMessagesRetrievalMimeFormat",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"description": "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:\n0: TextOnly\n1: HtmlOnly\n2: HtmlAndTextAlternative\n3: TextEnrichedOnly\n4: TextEnrichedAndTextAlternative\n5: BestBodyFormat\n6: Tnef\nThe default value is BestBodyFormat.\nTo change the value of this parameter, you also need to set the value of the PopUseProtocolDefaults parameter to $false."
},
"ActiveSyncBlockedDeviceIDs": {
"__type_requested": "Deserialized.Microsoft.Exchange.Data.MultiValuedProperty`1[[System.String,",
"required": true,
"name": "ActiveSyncBlockedDeviceIDs",
"title": "ActiveSyncBlockedDeviceIDs",
"items": {
"type": "string"
},
"__type_mapping_type": "String[]",
"readonly": false,
"type": "array",
"description": "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.\nTo 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>\"....\nTo add or remove one or more values without affecting any existing entries, use the following syntax: @{Add=\"<value1>\",\"<value2>\"...; Remove=\"<value1>\",\"<value2>\"...}.\nTo clear the list of device IDs, use the value $null for this parameter."
},
"ExternalSmtpSettings": {
"__type_requested": "",
"required": true,
"name": "ExternalSmtpSettings",
"title": "ExternalSmtpSettings",
"__type_mapping_type": "Unknown",
"readonly": true,
"type": "string",
"__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
},
"ActiveSyncSuppressReadReceipt": {
"__type_requested": "System.Boolean",
"required": true,
"name": "ActiveSyncSuppressReadReceipt",
"title": "ActiveSyncSuppressReadReceipt",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"description": "PARAMVALUE: SwitchParameter"
},
"Guid": {
"__type_requested": "System.Guid",
"required": true,
"name": "Guid",
"title": "Guid",
"__type_mapping_type": "String",
"readonly": false,
"type": "string"
},
"InternalPopSettings": {
"__type_requested": "",
"required": true,
"name": "InternalPopSettings",
"title": "InternalPopSettings",
"__type_mapping_type": "Unknown",
"readonly": true,
"type": "string",
"__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
},
"EwsApplicationAccessPolicy": {
"__type_requested": "EnforceAllowList | EnforceBlockList",
"required": true,
"description": "The EwsApplicationAccessPolicy parameter controls access to the mailbox by using Exchange Web Services applications.\nValid values for this parameter are:\nEnforceAllowList Only applications specified in the EwsAllowList parameter are allowed to access the mailbox.\nEnforceBlockList Applications specified in the EwsBlockList parameter aren't allowed to access the mailbox, but any other applications can access the mailbox.\nThis 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.",
"title": "EwsApplicationAccessPolicy",
"__type_mapping_type": "Unknown",
"readonly": true,
"__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string",
"type": "string",
"name": "EwsApplicationAccessPolicy"
},
"EmailAddresses": {
"__type_requested": "Deserialized.Microsoft.Exchange.Data.ProxyAddressCollection",
"required": true,
"name": "EmailAddresses",
"title": "EmailAddresses",
"items": {
"type": "string"
},
"__type_mapping_type": "String[]",
"readonly": false,
"type": "array",
"description": "This parameter is available only in on-premises Exchange 2016.\nThe 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.\nValid 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:\nSMTP The primary SMTP address. You can use this value only once in a command.\nsmtp Other SMTP email addresses.\nX400 X.400 addresses in on-premises Exchange.\nX500 X.500 addresses in on-premises Exchange.\nIf 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.\nTo specify the primary SMTP email address, you can use any of the following methods:\nUse the <Type> value SMTP on the address.\nThe first email address when you don't use any <Type> values, or when you use multiple <Type> values of smtp.\nIf it's available, use the PrimarySmtpAddress parameter instead. You can't use the EmailAddresses parameter and the PrimarySmtpAddress parameter in the same command.\nTo replace all existing proxy email addresses with the values you specify, use the following syntax: \"[<Type>]:<emailaddress1>\",\"[<Type>]:<emailaddress2>\"....\nTo 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>\"...}."
},
"ShowGalAsDefaultView": {
"__type_requested": "System.Boolean",
"required": true,
"name": "ShowGalAsDefaultView",
"title": "ShowGalAsDefaultView",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"description": "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."
},
"PSShowComputerName": {
"__type_requested": "System.Boolean",
"required": false,
"name": "PSShowComputerName",
"title": "PSShowComputerName",
"__type_mapping_type": "Boolean",
"readonly": true,
"type": "boolean"
},
"MapiHttpEnabled": {
"__type_requested": "$true | $false",
"required": true,
"name": "MapiHttpEnabled",
"title": "MapiHttpEnabled",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"description": "This parameter is available only in on-premises Exchange 2016.\nThe MapiHttpEnabled parameter enables or disables access to the mailbox in Outlook by using MAPI over HTTP. Valid values are:\n$true Access to the mailbox by using MAPI over HTTP is enabled.\n$false Access to the mailbox by using MAPI over HTTP is disabled.\n$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."
},
"PopSuppressReadReceipt": {
"__type_requested": "System.Boolean",
"required": true,
"name": "PopSuppressReadReceipt",
"title": "PopSuppressReadReceipt",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"description": "The PopSuppressReadReceipt parameter controls the behavior of read receipts for POP3 clients that access the mailbox.\nValid values for this parameter are:\n$true The user receives a read receipt when the recipient opens the message.\n$false The user receives two read receipts: one when the message is downloaded and another when the message is opened.\nThe default value is $false.\nTo change the value of this parameter, you also need to set the value of the PopUseProtocolDefaults parameter to $false."
},
"ActiveSyncMailboxPolicy": {
"__type_requested": "System.String",
"required": true,
"name": "ActiveSyncMailboxPolicy",
"title": "ActiveSyncMailboxPolicy",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"description": "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:\nName\nDistinguished name (DN)\nGUID\nThe name of the default Exchange ActiveSync mailbox policy is Default."
},
"ServerName": {
"__type_requested": "System.String",
"required": true,
"name": "ServerName",
"title": "ServerName",
"__type_mapping_type": "String",
"readonly": false,
"type": "string"
},
"LinkedMasterAccount": {
"__type_requested": "System.String",
"required": true,
"name": "LinkedMasterAccount",
"title": "LinkedMasterAccount",
"__type_mapping_type": "String",
"readonly": false,
"type": "string"
},
"ObjectClass": {
"__type_requested": "Deserialized.Microsoft.Exchange.Data.MultiValuedProperty`1[[System.String,",
"required": true,
"name": "ObjectClass",
"title": "ObjectClass",
"items": {
"type": "string"
},
"__type_mapping_type": "String[]",
"readonly": false,
"type": "array"
},
"PopMessageDeleteEnabled": {
"__type_requested": "System.Boolean",
"required": true,
"name": "PopMessageDeleteEnabled",
"title": "PopMessageDeleteEnabled",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean"
},
"PSComputerName": {
"__type_requested": "System.String",
"required": false,
"name": "PSComputerName",
"title": "PSComputerName",
"__type_mapping_type": "String",
"readonly": true,
"type": "string"
},
"InternalImapSettings": {
"__type_requested": "",
"required": true,
"name": "InternalImapSettings",
"title": "InternalImapSettings",
"__type_mapping_type": "Unknown",
"readonly": true,
"type": "string",
"__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
},
"PopForceICalForCalendarRetrievalOption": {
"__type_requested": "System.Boolean",
"required": true,
"name": "PopForceICalForCalendarRetrievalOption",
"title": "PopForceICalForCalendarRetrievalOption",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"description": "The PopForceICalForCalendarRetrievalOption parameter specifies how meeting requests are presented to POP3 clients that access the mailbox.\nValid values for this parameter are:\n$true All meeting requests are in the iCal format.\n$false All meeting requests appear as Outlook on the web links.\nThe default value is $false.\nTo change the value of this parameter, you also need to set the value of the PopUseProtocolDefaults parameter to $false."
},
"MAPIBlockOutlookNonCachedMode": {
"__type_requested": "System.Boolean",
"required": true,
"name": "MAPIBlockOutlookNonCachedMode",
"title": "MAPIBlockOutlookNonCachedMode",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"description": "This parameter is available only in on-premises Exchange 2016.\nThe MAPIBlockOutlookNonCachedMode parameter controls access to the mailbox by using Outlook in online or offline mode.\nValid values for this parameter are:\n$true Only Outlook clients that are configured to use Cached Exchange Mode (offline mode) are allowed to access the mailbox.\n$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).\nThe default value is $false."
},
"ImapForceICalForCalendarRetrievalOption": {
"__type_requested": "System.Boolean",
"required": true,
"name": "ImapForceICalForCalendarRetrievalOption",
"title": "ImapForceICalForCalendarRetrievalOption",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"description": "The ImapForceICalForCalendarRetrievalOption parameter specifies how meeting requests are presented to IMAP4 clients that access the mailbox.\nValid values for this parameter are:\n$true All meeting requests are in the iCal format.\n$false All meeting requests appear as Outlook on the web links.\nThe default value is $false.\nTo change the value of this parameter, you also need to set the value of the ImapUseProtocolDefaults parameter to $false."
},
"EwsAllowEntourage": {
"__type_requested": "$true | $false",
"required": true,
"name": "EwsAllowEntourage",
"title": "EwsAllowEntourage",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"description": "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).\nValid input for this parameter is $true or $false. The default value is $true."
},
"EwsAllowList": {
"__type_requested": "MultiValuedProperty",
"required": true,
"name": "EwsAllowList",
"title": "EwsAllowList",
"items": {
"type": "string"
},
"__type_mapping_type": "String[]",
"readonly": false,
"type": "array",
"description": "The EwsAllowList parameter specifies the Exchange Web Services applications (user agent strings) that are allowed to access the mailbox.\nTo 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>\"....\nTo add or remove one or more values without affecting any existing entries, use the following syntax: @{Add=\"<value1>\",\"<value2>\"...; Remove=\"<value1>\",\"<value2>\"...}.\nThis parameter is meaningful only when the EwsEnabled parameter is set to $true, and the EwsApplicationAccessPolicy parameter is set to EnforceAllowList."
},
"PrimarySmtpAddress": {
"__type_requested": "System.String",
"required": true,
"name": "PrimarySmtpAddress",
"title": "PrimarySmtpAddress",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"description": "This parameter is available only in on-premises Exchange 2016.\nThe 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."
},
"ImapMessagesRetrievalMimeFormat": {
"__type_requested": "System.String",
"required": true,
"name": "ImapMessagesRetrievalMimeFormat",
"title": "ImapMessagesRetrievalMimeFormat",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"description": "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:\n0: TextOnly\n1: HtmlOnly\n2: HtmlAndTextAlternative\n3: TextEnrichedOnly\n4: TextEnrichedAndTextAlternative\n5: BestBodyFormat\n6: Tnef\nThe default value is BestBodyFormat.\nTo change the value of this parameter, you also need to set the value of the ImapUseProtocolDefaults parameter to $false."
},
"Identity": {
"__type_requested": "System.String",
"required": true,
"name": "Identity",
"title": "Identity",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"description": "The Identity parameter specifies the mailbox that you want to view. You can use any value that uniquely identifies the mailbox.\nFor example:\nName\nDisplay name\nAlias\nDistinguished name (DN)\nCanonical DN\n<domain name>\\<account name>\nEmail address\nGUID\nLegacyExchangeDN\nSamAccountName\nUser ID or user principal name (UPN)"
},
"ActiveSyncEnabled": {
"__type_requested": "System.Boolean",
"required": true,
"name": "ActiveSyncEnabled",
"title": "ActiveSyncEnabled",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"description": "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."
},
"DistinguishedName": {
"__type_requested": "System.String",
"required": true,
"name": "DistinguishedName",
"title": "DistinguishedName",
"__type_mapping_type": "String",
"readonly": false,
"type": "string"
},
"InternalSmtpSettings": {
"__type_requested": "",
"required": true,
"name": "InternalSmtpSettings",
"title": "InternalSmtpSettings",
"__type_mapping_type": "Unknown",
"readonly": true,
"type": "string",
"__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
},
"OriginatingServer": {
"__type_requested": "System.String",
"required": true,
"name": "OriginatingServer",
"title": "OriginatingServer",
"__type_mapping_type": "String",
"readonly": false,
"type": "string"
},
"Name": {
"__type_requested": "System.String",
"required": true,
"name": "Name",
"title": "Name",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"description": "This parameter is available only in on-premises Exchange 2016.\nThe 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 (\")."
},
"PopEnableExactRFC822Size": {
"__type_requested": "System.Boolean",
"required": true,
"name": "PopEnableExactRFC822Size",
"title": "PopEnableExactRFC822Size",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"description": "This parameter is available only in on-premises Exchange 2016.\nThe PopEnableExactRFC822Size parameter specifies how message sizes are presented to POP3 clients that access the mailbox.\nValid values for this parameter are:\n$true Calculate the exact message size.\n$false Use an estimated message size.\nThe default value is $false.\nWe 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."
},
"IsOptimizedForAccessibility": {
"__type_requested": "System.Boolean",
"required": true,
"name": "IsOptimizedForAccessibility",
"title": "IsOptimizedForAccessibility",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"description": "PARAMVALUE: $true | $false"
},
"WhenCreatedUTC": {
"__type_requested": "System.DateTime",
"__type_mapping_type": "DateTime",
"name": "WhenCreatedUTC",
"title": "WhenCreatedUTC",
"format": "date-time",
"required": true,
"readonly": false,
"type": "string"
},
"ImapEnabled": {
"__type_requested": "System.Boolean",
"required": true,
"name": "ImapEnabled",
"title": "ImapEnabled",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"description": "The ImapEnabled parameter enables or disables access to the mailbox by using IMAP4 clients.\nValid 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."
},
"MAPIBlockOutlookVersions": {
"__type_requested": "System.String",
"required": true,
"name": "MAPIBlockOutlookVersions",
"title": "MAPIBlockOutlookVersions",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"description": "This parameter is available only in on-premises Exchange 2016.\nThe MAPIBlockOutlookVersions parameter blocks access to the mailbox for specific versions of Outlook.\nFor 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.\nThe default value is blank. To reset this parameter, use the value $null."
},
"PopEnabled": {
"__type_requested": "System.Boolean",
"required": true,
"name": "PopEnabled",
"title": "PopEnabled",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"description": "The PopEnabled parameter enables or disables access to the mailbox by using POP3 clients.\nValid 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."
},
"ImapSuppressReadReceipt": {
"__type_requested": "System.Boolean",
"required": true,
"name": "ImapSuppressReadReceipt",
"title": "ImapSuppressReadReceipt",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"description": "The ImapSuppressReadReceipt parameter controls the behavior of read receipts for IMAP4 clients that access the mailbox.\nValid values for this parameter are:\n$true The user receives a read receipt when the recipient opens the message.\n$false The user receives two read receipts: one when the message is downloaded and another when the message is opened.\nThe default value is $false.\nTo change the value of this parameter, you also need to set the value of the ImapUseProtocolDefaults parameter to $false."
},
"HasActiveSyncDevicePartnership": {
"__type_requested": "System.Boolean",
"required": true,
"name": "HasActiveSyncDevicePartnership",
"title": "HasActiveSyncDevicePartnership",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean"
},
"OwaMailboxPolicy": {
"__type_requested": "System.String",
"required": true,
"name": "OwaMailboxPolicy",
"title": "OwaMailboxPolicy",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"description": "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:\nName\nDistinguished name (DN)\nGUID\nThe name of the default Outlook on the web mailbox policy is Default."
},
"LegacyExchangeDN": {
"__type_requested": "System.String",
"required": true,
"name": "LegacyExchangeDN",
"title": "LegacyExchangeDN",
"__type_mapping_type": "String",
"readonly": false,
"type": "string"
},
"ActiveSyncDebugLogging": {
"__type_requested": "System.Boolean",
"required": true,
"name": "ActiveSyncDebugLogging",
"title": "ActiveSyncDebugLogging",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"description": "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.\nTo see this value, you need to use a formatting cmdlet. For example, Get-CasMailbox [email protected] -ActiveSyncDebugLogging | Format-List."
},
"ExchangeVersion": {
"__type_requested": "System.String",
"required": true,
"name": "ExchangeVersion",
"title": "ExchangeVersion",
"__type_mapping_type": "String",
"readonly": false,
"type": "string"
},
"ActiveSyncMailboxPolicyIsDefaulted": {
"__type_requested": "System.Boolean",
"required": true,
"name": "ActiveSyncMailboxPolicyIsDefaulted",
"title": "ActiveSyncMailboxPolicyIsDefaulted",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean"
},
"MAPIEnabled": {
"__type_requested": "System.Boolean",
"required": true,
"name": "MAPIEnabled",
"title": "MAPIEnabled",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"description": "The MAPIEnabled parameter enables or disables access to the mailbox by using MAPI clients (for example, MicrosoftOutlook).\nValid 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."
},
"PopUseProtocolDefaults": {
"__type_requested": "System.Boolean",
"required": true,
"name": "PopUseProtocolDefaults",
"title": "PopUseProtocolDefaults",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"description": "The PopUseProtocolDefaults parameter specifies whether to use the POP3 protocol defaults for the mailbox.\nValid 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:\nPopEnableExactRFC822Size\nPopForceICalForCalendarRetrievalOption\nPopMessagesRetrievalMimeFormat\nPopSuppressReadReceipt"
},
"ActiveSyncAllowedDeviceIDs": {
"__type_requested": "Deserialized.Microsoft.Exchange.Data.MultiValuedProperty`1[[System.String,",
"required": true,
"name": "ActiveSyncAllowedDeviceIDs",
"title": "ActiveSyncAllowedDeviceIDs",
"items": {
"type": "string"
},
"__type_mapping_type": "String[]",
"readonly": false,
"type": "array",
"description": "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.\nTo 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>\"....\nTo add or remove one or more values without affecting any existing entries, use the following syntax: @{Add=\"<value1>\",\"<value2>\"...; Remove=\"<value1>\",\"<value2>\"...}.\nTo clear the list of device IDs, use the value $null for this parameter."
},
"EwsAllowMacOutlook": {
"__type_requested": "$true | $false",
"required": true,
"name": "EwsAllowMacOutlook",
"title": "EwsAllowMacOutlook",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"description": "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).\nValid input for this parameter is $true or $false. The default value is $true."
},
"ImapUseProtocolDefaults": {
"__type_requested": "System.Boolean",
"required": true,
"name": "ImapUseProtocolDefaults",
"title": "ImapUseProtocolDefaults",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"description": "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.\nYou need to set the ImapUseProtocolDefaults parameter to $false when you use any of the following IMAP4 parameters:\nImapEnableExactRFC822Size\nImapForceICalForCalendarRetrievalOption\nImapMessagesRetrievalMimeFormat\nImapSuppressReadReceipt"
},
"EwsEnabled": {
"__type_requested": "System.Boolean",
"required": true,
"name": "EwsEnabled",
"title": "EwsEnabled",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"description": "The EwsEnabled parameter enables or disables access to the mailbox by using Exchange Web Services clients.\nValid 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."
},
"SamAccountName": {
"__type_requested": "System.String",
"required": true,
"name": "SamAccountName",
"title": "SamAccountName",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"description": "This parameter is available only in on-premises Exchange 2016.\nThe 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 \u00f6 match). The maximum length is 20 characters."
},
"ExternalImapSettings": {
"__type_requested": "",
"required": true,
"name": "ExternalImapSettings",
"title": "ExternalImapSettings",
"__type_mapping_type": "Unknown",
"readonly": true,
"type": "string",
"__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
},
"IsValid": {
"__type_requested": "System.Boolean",
"required": true,
"name": "IsValid",
"title": "IsValid",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean"
},
"ServerLegacyDN": {
"__type_requested": "System.String",
"required": true,
"name": "ServerLegacyDN",
"title": "ServerLegacyDN",
"__type_mapping_type": "String",
"readonly": false,
"type": "string"
},
"UniversalOutlookEnabled": {
"__type_requested": "System.Boolean",
"required": true,
"name": "UniversalOutlookEnabled",
"title": "UniversalOutlookEnabled",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"description": "PARAMVALUE: $true | $false"
},
"ImapEnableExactRFC822Size": {
"__type_requested": "System.Boolean",
"required": true,
"name": "ImapEnableExactRFC822Size",
"title": "ImapEnableExactRFC822Size",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"description": "This parameter is available only in on-premises Exchange 2016.\nThe ImapEnableExactRFC822Size parameter specifies how message sizes are presented to IMAP4 clients that access the mailbox.\nValid values for this parameter are:\n$true Calculate the exact message size.\n$false Use an estimated message size.\nThe default value is $false.\nWe 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."
},
"WhenChanged": {
"__type_requested": "System.DateTime",
"__type_mapping_type": "DateTime",
"name": "WhenChanged",
"title": "WhenChanged",
"format": "date-time",
"required": true,
"readonly": false,
"type": "string"
},
"WhenChangedUTC": {
"__type_requested": "System.DateTime",
"__type_mapping_type": "DateTime",
"name": "WhenChangedUTC",
"title": "WhenChangedUTC",
"format": "date-time",
"required": true,
"readonly": false,
"type": "string"
},
"ObjectState": {
"__type_requested": "System.String",
"required": true,
"name": "ObjectState",
"title": "ObjectState",
"__type_mapping_type": "String",
"readonly": false,
"type": "string"
},
"WhenCreated": {
"__type_requested": "System.DateTime",
"__type_mapping_type": "DateTime",
"name": "WhenCreated",
"title": "WhenCreated",
"format": "date-time",
"required": true,
"readonly": false,
"type": "string"
},
"RunspaceId": {
"__type_requested": "System.Guid",
"required": false,
"name": "RunspaceId",
"title": "RunspaceId",
"__type_mapping_type": "String",
"readonly": true,
"type": "string"
},
"MAPIBlockOutlookExternalConnectivity": {
"__type_requested": "System.Boolean",
"required": true,
"name": "MAPIBlockOutlookExternalConnectivity",
"title": "MAPIBlockOutlookExternalConnectivity",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"description": "This parameter is available only in on-premises Exchange 2016.\nThe MAPIBlockOutlookExternalConnectivity parameter enables or disables external access to the mailbox in Outlook by using Outlook Anywhere or MAPI over HTTP. Valid values are:\n$true External Outlook clients can't use Outlook Anywhere or MAPI over HTTP to access the mailbox.\n$false External Outlook clients can use Outlook Anywhere or MAPI over HTTP to access the mailbox."
},
"EwsAllowOutlook": {
"__type_requested": "$true | $false",
"required": true,
"name": "EwsAllowOutlook",
"title": "EwsAllowOutlook",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"description": "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."
},
"Id": {
"__type_requested": "System.String",
"required": true,
"name": "Id",
"title": "Id",
"__type_mapping_type": "String",
"readonly": false,
"type": "string"
},
"ObjectCategory": {
"__type_requested": "System.String",
"required": true,
"name": "ObjectCategory",
"title": "ObjectCategory",
"__type_mapping_type": "String",
"readonly": false,
"type": "string"
}
},
"schema_version": "2017.1"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/device/exchangeonline/CASMailbox/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/device/exchangeonline/CASMailbox/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/exchangeonline/CASMailbox/[pkid1]", "/api/v0/device/exchangeonline/CASMailbox/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/exchangeonline/CASMailbox/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=device/exchangeonline/CASMailbox |
|
{"hrefs": ["/api/device/exchangeonline/CASMailbox/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=device/exchangeonline/CASMailbox |
|
{"hrefs": ["/api/device/exchangeonline/CASMailbox/[pkid1]", "/api/device/exchangeonline/CASMailbox/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/exchangeonline/CASMailbox; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/exchangeonline/CASMailbox/export/ |
|
{ "hrefs":["/api/device/exchangeonline/CASMailbox/[pkid1]", "/api/device/exchangeonline/CASMailbox/[pkid2]",...]}} |
For export_format=json, the response is a time stamped zip file of data in JSON as in the system database. Item properties such as strings that are empty or Boolean values that are not set, are not included. The filename in the response is of the format as the example:
Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip
Content-Language:en
Content-Type:application/x-zip
For export_format=raw_xlsx, the response is a MS Excel spreadsheet with columns corresponding to the JSON format export and a response filename format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=xlsx, the response is a MS Excel spreadsheet, arranged by any Field Display Policies that apply. The columns correspond with those of a Bulk Load Template export sheet. The response filename format is:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
The XLSX format can be used to bulk load instances of device/exchangeonline/CASMailbox and the JSON format can be used to import instances of device/exchangeonline/CASMailbox.
GET http://[host-proxy]/api/device/exchangeonline/CASMailbox/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for device/exchangeonline/CASMailbox | POST | /api/device/exchangeonline/CASMailbox/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Configuration Template | GET | /api/device/exchangeonline/CASMailbox/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/device/exchangeonline/CASMailbox/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/device/exchangeonline/CASMailbox/ |
|
The device/exchangeonline/CASMailbox schema and all instances as JSON. |
(The list will return 0 to 3 device/exchangeonline/CASMailbox instances)
{
"operations": [
"move"
],
"pagination": {
"direction": "asc",
"order_by": "DisplayName",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/device/exchangeonline/CASMailbox/?skip=0&limit=3&order_by=DisplayName&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 0
},
"meta": {
"tags": [],
"cached": true,
"title": "",
"business_key": {},
"schema_version": "2017.1",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"children": [],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": []
},
"actions": [
{
"bulk_update_form": {
"support_async": false,
"class": "update",
"href": "/api/device/exchangeonline/CASMailbox/bulk_update/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"method": "GET",
"title": "Bulk Modify"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=device/exchangeonline/CASMailbox",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/exchangeonline/CASMailbox/export/?hierarchy=[hierarchy]",
"method": "POST",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"export_bulkload_template": {
"support_async": false,
"class": "bulkload_template",
"href": "/api/device/exchangeonline/CASMailbox/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"configuration_template": {
"support_async": false,
"class": "config",
"href": "/api/device/exchangeonline/CASMailbox/configuration_template/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/device/exchangeonline/CASMailbox/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/device/exchangeonline/CASMailbox/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/exchangeonline/CASMailbox/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/exchangeonline/CASMailbox/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/exchangeonline/CASMailbox",
"model_specific_actions": [
"get",
"list",
"update",
"bulk_update_form",
"clone",
"configuration_template",
"export",
"export_bulkload_template",
"field_display_policy",
"help",
"move"
],
"summary_attrs": [
{
"name": "DisplayName",
"title": "DisplayName"
},
{
"name": "Name",
"title": "Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"resources": []
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for device/exchangeonline/CASMailbox. | GET | /api/device/exchangeonline/CASMailbox/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/exchangeonline/CASMailbox as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/device/exchangeonline/CASMailbox/[pkid]/ | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/exchangeonline/CASMailbox/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/exchangeonline/CASMailbox/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/exchangeonline/CASMailbox | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and a single instance with [pkid] of device/exchangeonline/CASMailbox; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/exchangeonline/CASMailbox/[pkid]/export/ |
|
The response is an attachment. Refer to the list below. |
For export_format=raw_xlsx, the response is a "raw" MS Excel spreadsheet with columns corresponding to the JSON format export and a response format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=xlsx, the response is a MS Excel spreadsheet, formatted to show all columns and a response format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=json, the response is a time stamped zip file of data in JSON and a response format:
Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip
Content-Language:en
Content-Type:application/x-zip
The XLSX format can be used to bulk load instances of device/exchangeonline/CASMailbox and the JSON format can be used to import instances of device/exchangeonline/CASMailbox.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/device/exchangeonline/CASMailbox/[pkid]/ | hierarchy=[hierarchy] | The device/exchangeonline/CASMailbox instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/device/exchangeonline/CASMailbox/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/exchangeonline/CASMailbox. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Purge | POST | /api/device/exchangeonline/CASMailbox/[pkid]/purge/ | hierarchy=[hierarchy] | If payload required: |