[Index]
Model ref.: device/exchangeonline/MailUser
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": { "WhenMailboxCreated": { "__type_requested": "", "required": false, "name": "WhenMailboxCreated", "title": "WhenMailboxCreated", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "UseMapiRichTextFormat": { "__type_requested": "System.String", "required": false, "name": "UseMapiRichTextFormat", "title": "UseMapiRichTextFormat", "__type_mapping_type": "String", "readonly": true, "type": "string", "description": "The UseMapiRichTextFormat parameter specifies what to do with messages that are sent to the mail user or mail contact in MAPI rich text format, also known as Outlook Rich Text or Transport Neutral Encapsulation Format (TNEF). Valid values are:\nAlways TNEF is used for all messages sent to the mail user or mail contact.\nNever TNEF is never used for any messages sent to the mail user or mail contact. TNEF messages are converted to plain text.\nUseDefaultSettings TNEF messages aren't specifically allowed or prevented for the mail user or mail contact. Whether TNEF messages are sent to the recipient depends on the remote domain TNEF settings (the default remote domain or a specific remote domain), or the Outlook Rich Text message settings specified by the sender in Outlook.\nThe default value is UseDefaultSettings." }, "WindowsLiveID": { "__type_requested": "System.String", "required": true, "description": "This parameter is available only in the cloud-based service.\nThe WindowsLiveID parameter creates a Microsoft account (formerly known as a Windows Live ID) for the mail user.", "title": "WindowsLiveID", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "WindowsLiveID" }, "RecipientLimits": { "__type_requested": "System.String", "required": false, "name": "RecipientLimits", "title": "RecipientLimits", "__type_mapping_type": "String", "readonly": true, "type": "string", "description": "This parameter is available only in on-premises Exchange 2016.\nThe RecipientLimits parameter specifies the maximum number of recipients allowed in messages sent by the mail user.\nA valid value is an integer or the value unlimited. The default value is unlimited.\nThe value unlimited indicates the maximum number of recipients per message for the mail user is controlled elsewhere (for example, organization, server, or connector limits)." }, "RequireSenderAuthenticationEnabled": { "__type_requested": "System.Boolean", "required": false, "name": "RequireSenderAuthenticationEnabled", "title": "RequireSenderAuthenticationEnabled", "__type_mapping_type": "Boolean", "readonly": true, "type": "boolean", "description": "The RequireSenderAuthenticationEnabled parameter specifies whether to accept messages only from authenticated (internal) senders. Valid values are:\n$true Messages are accepted only from authenticated (internal) senders. Messages from unauthenticated (external) senders are rejected.\n$false Messages are accepted from authenticated (internal) and unauthenticated (external) senders." }, "PSShowComputerName": { "__type_requested": "System.Boolean", "required": false, "name": "PSShowComputerName", "title": "PSShowComputerName", "__type_mapping_type": "Boolean", "readonly": true, "type": "boolean" }, "AdministrativeUnits": { "__type_requested": "Deserialized.Microsoft.Exchange.Data.Directory.ADMultiValuedProperty`1[[Microsoft.Exchange.Data.Directory.ADObjectId,", "required": false, "name": "AdministrativeUnits", "title": "AdministrativeUnits", "items": { "type": "string" }, "__type_mapping_type": "String[]", "readonly": true, "type": "array" }, "InPlaceHolds": { "__type_requested": "Deserialized.Microsoft.Exchange.Data.MultiValuedProperty`1[[System.String,", "required": false, "name": "InPlaceHolds", "title": "InPlaceHolds", "items": { "type": "string" }, "__type_mapping_type": "String[]", "readonly": true, "type": "array" }, "EvictLiveId": { "__type_requested": "SwitchParameter", "required": false, "description": "This parameter is available only in the cloud-based service.\nThe EvictLiveId switch specifies whether to remove an unmanaged Microsoft account (formerly known as a Windows Live ID) from the cloud-based domain. An unmanaged Microsoft account was created in the domain before the domain was enrolled in the cloud-based service. Evicting a Microsoft account from the domain lets you save any settings associated with the Microsoft account, like instant messaging contacts.\nYou don't need to specify a value with this switch.", "title": "EvictLiveId", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "EvictLiveId" }, "LastName": { "__type_requested": "String", "required": false, "description": "The LastName parameter specifies the user's last name.", "title": "LastName", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "LastName" }, "LastExchangeChangedTime": { "__type_requested": "", "required": false, "name": "LastExchangeChangedTime", "title": "LastExchangeChangedTime", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "Initials": { "__type_requested": "String", "required": false, "description": "The Initials parameter specifies the user's middle initials.", "title": "Initials", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "Initials" }, "OriginatingServer": { "__type_requested": "System.String", "required": false, "name": "OriginatingServer", "title": "OriginatingServer", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "CalendarVersionStoreDisabled": { "__type_requested": "System.Boolean", "required": false, "name": "CalendarVersionStoreDisabled", "title": "CalendarVersionStoreDisabled", "__type_mapping_type": "Boolean", "readonly": true, "type": "boolean", "description": "This parameter is reserved for internal Microsoft use." }, "HiddenFromAddressListsEnabled": { "__type_requested": "System.Boolean", "required": false, "name": "HiddenFromAddressListsEnabled", "title": "HiddenFromAddressListsEnabled", "__type_mapping_type": "Boolean", "readonly": true, "type": "boolean", "description": "The HiddenFromAddressListsEnabled parameter specifies whether this recipient is visible in address lists. Valid values are:\n$true The recipient isn't visible in address lists.\n$false The recipient is visible in address lists. This is the default value." }, "WindowsEmailAddress": { "__type_requested": "System.String", "required": false, "name": "WindowsEmailAddress", "title": "WindowsEmailAddress", "__type_mapping_type": "String", "readonly": true, "type": "string", "description": "The WindowsEmailAddress parameter specifies the Windows email address for this recipient. This is a common Active Directory attribute that's present in all environments, including environments without Exchange. Using the WindowsEmailAddress parameter on a recipient has one of the following results:\nIn on-premises environments where the recipient is subject to email address policies (the EmailAddressPolicyEnabled property is set to the value True for the recipient), the WindowsEmailAddress parameter has no effect on the WindowsEmailAddress property or the primary email address value.\nIn cloud environments or in on-premises environments where the recipient isn't subject to email address policies (the EmailAddressPolicyEnabled property is set to the value False for the recipient), the WindowsEmailAddress parameter updates the WindowsEmailAddress property and the primary email address to the same value.\nThe WindowsEmailAddress property is visible for the recipient in Active Directory Users and Computers in the E-mail attribute. The attribute common name is E-mail-Addresses, and the Ldap-Display-Name is mail. If you modify this attribute in Active Directory, the recipient's primary email address is not updated to the same value." }, "SendModerationNotifications": { "__type_requested": "System.String", "required": false, "description": "The SendModerationNotifications parameter specifies whether moderation status notification messages are sent to senders when they send a message to this moderated recipient. Valid values are:\nAlways Moderation status notifications are sent to all internal and external senders. This is the default value.\nInternal Moderation status notifications are sent to all internal senders, but not to external senders.\nNever Moderation status notifications are disabled.\nNote that senders are always notified if their message is rejected by a moderator, regardless of the value of this parameter.", "title": "SendModerationNotifications", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "SendModerationNotifications" }, "RecoverableItemsQuota": { "__type_requested": "System.String", "required": false, "name": "RecoverableItemsQuota", "title": "RecoverableItemsQuota", "__type_mapping_type": "String", "readonly": true, "type": "string", "description": "This parameter is available only in on-premises Exchange 2016.\nThe RecoverableItemsQuota parameter specifies the maximum size for the Recoverable Items folder for a mail user that has a corresponding remote mailbox or remote archive mailbox in the cloud-based service. If the Recoverable Items folder reaches or exceeds this size, it no longer accepts messages.\nWhen you enter a value, qualify the value with one of the following units:\nB (bytes)\nKB (kilobytes)\nMB (megabytes)\nGB (gigabytes)\nTB (terabytes)\nUnqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte.\nA valid value is number up to 1.999999999 terabytes (2199023254528 bytes) or the value unlimited. The default value is 30 gigabytes (32212254720 bytes).\nThe RecoverableItemsQuota value must be greater than or equal to the RecoverableItemsWarningQuota value." }, "IsSoftDeletedByRemove": { "__type_requested": "System.Boolean", "required": false, "name": "IsSoftDeletedByRemove", "title": "IsSoftDeletedByRemove", "__type_mapping_type": "Boolean", "readonly": true, "type": "boolean" }, "ArchiveRelease": { "__type_requested": "System.String", "required": false, "name": "ArchiveRelease", "title": "ArchiveRelease", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "Extensions": { "__type_requested": "Deserialized.Microsoft.Exchange.Data.MultiValuedProperty`1[[System.String,", "required": false, "name": "Extensions", "title": "Extensions", "items": { "type": "string" }, "__type_mapping_type": "String[]", "readonly": true, "type": "array" }, "LegacyExchangeDN": { "__type_requested": "System.String", "required": false, "name": "LegacyExchangeDN", "title": "LegacyExchangeDN", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "Organization": { "__type_requested": "OrganizationIdParameter", "required": false, "description": "This parameter is reserved for internal Microsoft use.", "title": "Organization", "__type_mapping_type": "Unknown", "name": "Organization", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "ExchangeVersion": { "__type_requested": "System.String", "required": false, "name": "ExchangeVersion", "title": "ExchangeVersion", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "ArbitrationMailbox": { "__type_requested": "", "required": false, "description": "This parameter is available only in on-premises Exchange 2016.\nThe ArbitrationMailbox parameter specifies the arbitration mailbox that's used to manage the moderation process for this recipient. You can use any value that uniquely identifies the arbitration 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)", "title": "ArbitrationMailbox", "__type_mapping_type": "Unknown", "name": "ArbitrationMailbox", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "MailboxProvisioningPreferences": { "__type_requested": "MultiValuedProperty", "required": false, "description": "This parameter is reserved for internal Microsoft use.", "title": "MailboxProvisioningPreferences", "items": { "type": "string" }, "__type_mapping_type": "String[]", "readonly": false, "type": "array", "name": "MailboxProvisioningPreferences" }, "UserPrincipalName": { "__type_requested": "String", "required": true, "description": "This parameter is available only in on-premises Exchange 2016.", "title": "UserPrincipalName", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "UserPrincipalName" }, "DisabledArchiveDatabase": { "__type_requested": "", "required": false, "name": "DisabledArchiveDatabase", "title": "DisabledArchiveDatabase", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "AcceptMessagesOnlyFromDLMembers": { "__type_requested": "Deserialized.Microsoft.Exchange.Data.Directory.ADMultiValuedProperty`1[[Microsoft.Exchange.Data.Directory.ADObjectId,", "required": false, "name": "AcceptMessagesOnlyFromDLMembers", "title": "AcceptMessagesOnlyFromDLMembers", "items": { "type": "string" }, "__type_mapping_type": "String[]", "readonly": true, "type": "array", "description": "The AcceptMessagesOnlyFromDLMembers parameter specifies who is allowed to send messages to this recipient. Messages from other senders are rejected.\nValid values for this parameter are groups in your organization (distribution groups, mail-enabled security groups, and dynamic distribution groups). Specifying a group means all members of the group are allowed to send messages to this recipient. You can use any value that uniquely identifies the group. For example:\nName\nDisplay name\nAlias\nDistinguished name (DN)\nCanonical DN\nEmail address\nGUID\nYou can enter multiple groups separated by commas. To overwrite any existing entries, use the following syntax: <group1>,<group2>.... If the values contain spaces or otherwise require quotation marks, use the following syntax: \"<group1>\",\"<group2>\"....\nTo add or remove groups without affecting other existing entries, use the following syntax: @{Add=\"<group1>\",\"<group2>\"...; Remove=\"<group1>\",\"<group2>\"...}.\nThe groups you specify for this parameter are automatically copied to the AcceptMessagesOnlyFromSendersOrMembers property. Therefore, you can't use the AcceptMessagesOnlyFromDLMembers and AcceptMessagesOnlyFromSendersOrMembers parameters in the same command.\nBy default, this parameter is blank ($null), which allows this recipient to accept messages from all groups." }, "RetainDeletedItemsFor": { "__type_requested": "System.String", "required": false, "name": "RetainDeletedItemsFor", "title": "RetainDeletedItemsFor", "__type_mapping_type": "String", "readonly": true, "type": "string", "description": "This parameter is reserved for internal Microsoft use." }, "ProtocolSettings": { "__type_requested": "Deserialized.Microsoft.Exchange.Data.MultiValuedProperty`1[[System.String,", "required": false, "name": "ProtocolSettings", "title": "ProtocolSettings", "items": { "type": "string" }, "__type_mapping_type": "String[]", "readonly": true, "type": "array" }, "RejectMessagesFromSendersOrMembers": { "__type_requested": "Deserialized.Microsoft.Exchange.Data.Directory.ADMultiValuedProperty`1[[Microsoft.Exchange.Data.Directory.ADObjectId,", "required": false, "name": "RejectMessagesFromSendersOrMembers", "title": "RejectMessagesFromSendersOrMembers", "items": { "type": "string" }, "__type_mapping_type": "String[]", "readonly": true, "type": "array", "description": "The RejectMessagesFromSendersOrMembers parameter specifies who isn't allowed to send messages to this recipient. Messages from these senders are rejected.\nValid values for this parameter are individual senders and groups in your organization. Individual senders are mailboxes, mail users, and mail contacts. Groups are distribution groups, mail-enabled security groups, and dynamic distribution groups. Specifying a group means all members of the group aren't allowed to send messages to this recipient.\nTo specify senders for this parameter, you can use any value that uniquely identifies the sender. For example:\nName\nDisplay name\nAlias\nDistinguished name (DN)\nCanonical DN\nEmail address\nGUID\nYou can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: <sender1>,<senter2>.... If the values contain spaces or otherwise require quotation marks, use the following syntax: \"<sender1>\",\"<sender2>\"....\nTo add or remove individual senders or groups without affecting other existing entries, use the RejectMessagesFrom and RejectMessagesFromDLMembers parameters.\nThe individual senders and groups you specify for this parameter are automatically copied to the RejectMessagesFrom and RejectMessagesFromDLMembers properties, respectively. Therefore, you can't use the RejectMessagesFromSendersOrMembers parameter and the RejectMessagesFrom or RejectMessagesFromDLMembers parameters in the same command.\nBy default, this parameter is blank ($null), which allows this recipient to accept messages from all senders." }, "RetentionHoldEnabled": { "__type_requested": "System.Boolean", "required": false, "name": "RetentionHoldEnabled", "title": "RetentionHoldEnabled", "__type_mapping_type": "Boolean", "readonly": true, "type": "boolean", "description": "This parameter is reserved for internal Microsoft use." }, "RunspaceId": { "__type_requested": "System.Guid", "required": false, "name": "RunspaceId", "title": "RunspaceId", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "Guid": { "__type_requested": "System.Guid", "required": false, "name": "Guid", "title": "Guid", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "RecipientTypeDetails": { "__type_requested": "System.String", "required": false, "name": "RecipientTypeDetails", "title": "RecipientTypeDetails", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "MailTipTranslations": { "__type_requested": "Deserialized.Microsoft.Exchange.Data.MultiValuedProperty`1[[System.String,", "required": false, "name": "MailTipTranslations", "title": "MailTipTranslations", "items": { "type": "string" }, "__type_mapping_type": "String[]", "readonly": true, "type": "array", "description": "The MailTipTranslations parameter specifies additional languages for the custom MailTip text that's defined by the MailTip parameter. HTML tags are automatically added to the MailTip translation, additional HTML tags aren't supported, and the length of the MailTip translation can't exceed 175 displayed characters.\nTo add or remove MailTip translations without affecting the default MailTip or other MailTip translations, use the following syntax:\n@{Add=\"<culture 1>:<localized text 1>\",\"<culture 2>:<localized text 2>\"...; Remove=\"<culture 3>:<localized text 3>\",\"<culture 4>:<localized text 4>\"...}\n<culture> is a valid ISO 639 two-letter culture code that's associated with the language.\nFor example, suppose this recipient currently has the MailTip text: \"This mailbox is not monitored.\" To add the Spanish translation, use the following value for this parameter: @{Add=\"ES:Esta caja no se supervisa.\"}." }, "DisplayName": { "__type_requested": "String", "required": false, "description": "The DisplayName parameter specifies the display name of the mail user. The display name is visible in the Exchange admin center, in address lists, and in Outlook. The maximum length is 256 characters. If the value contains spaces, enclose the value in quotation marks (\").\nIf you don't use the DisplayName parameter, the value of the Name parameter is used for the display name.", "title": "DisplayName", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "DisplayName" }, "OrganizationId": { "__type_requested": "System.String", "required": false, "name": "OrganizationId", "title": "OrganizationId", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "MessageFormat": { "__type_requested": "System.String", "required": false, "description": "The MessageFormat parameter specifies the message format for messages sent to the mail contact or mail user. Valid values are:\nText\nMime This is the default value.\nThe MessageFormat and MessageBodyFormat parameters are interdependent:\nMessageFormat is MimeMessageBodyFormat can be Text, Html, or TextAndHtml.\nMessageFormat is TextMessageBodyFormat can only be Text.\nTherefore, if you want to change the MessageFormat parameter from Mime to Text, you must also change the MessageBodyFormat parameter to Text.", "title": "MessageFormat", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "MessageFormat" }, "ExtensionCustomAttribute4": { "__type_requested": "Deserialized.Microsoft.Exchange.Data.MultiValuedProperty`1[[System.String,", "required": false, "name": "ExtensionCustomAttribute4", "title": "ExtensionCustomAttribute4", "items": { "type": "string" }, "__type_mapping_type": "String[]", "readonly": true, "type": "array", "description": "The ExtensionCustomAttribute1-5 parameters specify custom attributes that store additional information. You can specify multiple values for these parameters as a comma delimited list. Each ExtensionCustomAttribute parameter can hold up to 1,300 values.\nFor more information about custom attributes, see Custom attributes.\nFor more information about using multivalued properties, see Modifying multivalued properties." }, "ResetPasswordOnNextLogon": { "__type_requested": "$true | $false", "required": false, "description": "This parameter is available only in on-premises Exchange 2016.\nThe ResetPasswordOnNextLogon parameter specifies whether the user must change their password the next time they log on. Valid values are:\n$true The user is required to change their password the next time they log on.\n$false The user isn't required to change their password the next time they log on. This is the default value.", "title": "ResetPasswordOnNextLogon", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "ResetPasswordOnNextLogon" }, "ModeratedBy": { "__type_requested": "MultiValuedProperty", "required": false, "description": "The ModeratedBy parameter specifies one or more moderators for this recipient. A moderator approves messages sent to the recipient before the messages are delivered. A moderator must be a mailbox, mail user, or mail contact in your organization. You can use any value that uniquely identifies the moderator.\nFor example:\nName\nDisplay name\nAlias\nDistinguished name (DN)\nCanonical DN\nEmail address\nGUID\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>\"...}.\nYou need to use this parameter to specify at least one moderator when you set the ModerationEnabled parameter to the value $true.", "title": "ModeratedBy", "items": { "type": "string" }, "__type_mapping_type": "String[]", "readonly": false, "type": "array", "name": "ModeratedBy" }, "SimpleDisplayName": { "__type_requested": "System.String", "required": false, "name": "SimpleDisplayName", "title": "SimpleDisplayName", "__type_mapping_type": "String", "readonly": true, "type": "string", "description": "The SimpleDisplayName parameter is used to display an alternative description of the object when only a limited set of characters is permitted. Valid characters are:\na - z\nA - Z\n0 - 9\n\"<space>\", \"\"\", \"'\", \"(\", \")\", \"+\", \",\", \"-\", \".\", \"/\", \":\", and \"?\"." }, "ModerationEnabled": { "__type_requested": "$true | $false", "required": false, "description": "The ModerationEnabled parameter specifies whether moderation is enabled for this recipient. Valid value are:\n$true Moderation is enabled for this recipient. Messages sent to this recipient must be approved by a moderator before the messages are delivered.\n$false Moderation is disabled for this recipient. Messages sent to this recipient are delivered without the approval of a moderator. This is the default value.\nYou use the ModeratedBy parameter to specify the moderators.", "title": "ModerationEnabled", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "ModerationEnabled" }, "MaxSendSize": { "__type_requested": "System.String", "required": false, "name": "MaxSendSize", "title": "MaxSendSize", "__type_mapping_type": "String", "readonly": true, "type": "string", "description": "This parameter is available only in on-premises Exchange 2016.\nThe MaxSendSize parameter specifies the maximum size of a message that can be sent by the mail user.\nWhen you enter a value, qualify the value with one of the following units:\nB (bytes)\nKB (kilobytes)\nMB (megabytes)\nGB (gigabytes)\nTB (terabytes)\nUnqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte.\nA valid value is a number up to 1.999999 gigabytes (2147483647 bytes) or the value unlimited. The default value is unlimited.\nThe value unlimited indicates the maximum send size for the mail user is controlled elsewhere (for example, organization, server, or connector limits).\nFor any message size limit, you need to set a value that's larger than the actual size you want enforced. This accounts for the Base64 encoding of attachments and other binary data. Base64 encoding increases the size of the message by approximately 33%, so the value you specify should be approximately 33% larger than the actual message size you want enforced. For example, if you specify a maximum message size value of 64 MB, you can expect a realistic maximum message size of approximately 48 MB." }, "ArchiveGuid": { "__type_requested": "System.Guid", "required": false, "name": "ArchiveGuid", "title": "ArchiveGuid", "__type_mapping_type": "String", "readonly": true, "type": "string", "description": "This parameter is reserved for internal Microsoft use." }, "AggregatedMailboxGuids": { "__type_requested": "Deserialized.Microsoft.Exchange.Data.MultiValuedProperty`1[[System.Guid,", "required": false, "name": "AggregatedMailboxGuids", "title": "AggregatedMailboxGuids", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "ArchiveName": { "__type_requested": "Deserialized.Microsoft.Exchange.Data.MultiValuedProperty`1[[System.String,", "required": false, "name": "ArchiveName", "title": "ArchiveName", "items": { "type": "string" }, "__type_mapping_type": "String[]", "readonly": true, "type": "array", "description": "This parameter is reserved for internal Microsoft use." }, "HasSpokenName": { "__type_requested": "System.Boolean", "required": false, "name": "HasSpokenName", "title": "HasSpokenName", "__type_mapping_type": "Boolean", "readonly": true, "type": "boolean" }, "WhenSoftDeleted": { "__type_requested": "", "required": false, "name": "WhenSoftDeleted", "title": "WhenSoftDeleted", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "HasPicture": { "__type_requested": "System.Boolean", "required": false, "name": "HasPicture", "title": "HasPicture", "__type_mapping_type": "Boolean", "readonly": true, "type": "boolean" }, "RemotePowerShellEnabled": { "__type_requested": "$true | $false", "required": false, "description": "The RemotePowerShellEnabled parameter specifies whether the user can connect to Exchange using remote PowerShell. Remote PowerShell is required to open the Exchange Management Shell on Exchange servers, or to use Windows PowerShell open and import a remote PowerShell session to Exchange. Access to remote PowerShell is required even if you're trying to open the Exchange Management Shell on the local Exchange server. Valid values are:\n$true The user can use remote PowerShell. This is the default value.\n$false The user can't use remote PowerShell.", "title": "RemotePowerShellEnabled", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "RemotePowerShellEnabled" }, "AcceptMessagesOnlyFrom": { "__type_requested": "Deserialized.Microsoft.Exchange.Data.Directory.ADMultiValuedProperty`1[[Microsoft.Exchange.Data.Directory.ADObjectId,", "required": false, "name": "AcceptMessagesOnlyFrom", "title": "AcceptMessagesOnlyFrom", "items": { "type": "string" }, "__type_mapping_type": "String[]", "readonly": true, "type": "array", "description": "The AcceptMessagesOnlyFrom parameter specifies who is allowed to send messages to this recipient. Messages from other senders are rejected.\nValid values for this parameter are individual senders in your organization (mailboxes, mail users, and mail contacts). You can use any value that uniquely identifies the sender. For example:\nName\nDisplay name\nAlias\nDistinguished name (DN)\nCanonical DN\nEmail address\nGUID\nYou can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: <sender1>,<senter2>.... If the values contain spaces or otherwise require quotation marks, use the following syntax: \"<sender1>\",\"<sender2>\"....\nTo add or remove senders without affecting other existing entries, use the following syntax: @{Add=\"<sender1>\",\"<sender2>\"...; Remove=\"<sender1>\",\"<sender2>\"...}.\nThe senders you specify for this parameter are automatically copied to the AcceptMessagesOnlyFromSendersOrMembers property. Therefore, you can't use the AcceptMessagesOnlyFrom and AcceptMessagesOnlyFromSendersOrMembers parameters in the same command.\nBy default, this parameter is blank ($null), which allows this recipient to accept messages from all senders." }, "AccountDisabled": { "__type_requested": "System.Boolean", "required": false, "name": "AccountDisabled", "title": "AccountDisabled", "__type_mapping_type": "Boolean", "readonly": true, "type": "boolean" }, "DistinguishedName": { "__type_requested": "System.String", "required": false, "name": "DistinguishedName", "title": "DistinguishedName", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "BypassLiveId": { "__type_requested": "SwitchParameter", "required": false, "description": "This parameter is reserved for internal Microsoft use.", "title": "BypassLiveId", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "BypassLiveId" }, "UserCertificate": { "__type_requested": "MultiValuedProperty", "required": false, "name": "UserCertificate", "title": "UserCertificate", "items": { "type": "string" }, "__type_mapping_type": "String[]", "readonly": true, "type": "array", "description": "This parameter is reserved for internal Microsoft use." }, "ArchiveStatus": { "__type_requested": "System.String", "required": false, "name": "ArchiveStatus", "title": "ArchiveStatus", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "PoliciesExcluded": { "__type_requested": "Deserialized.Microsoft.Exchange.Data.MultiValuedProperty`1[[System.String,", "required": false, "name": "PoliciesExcluded", "title": "PoliciesExcluded", "items": { "type": "string" }, "__type_mapping_type": "String[]", "readonly": true, "type": "array" }, "MailboxMoveRemoteHostName": { "__type_requested": "System.String", "required": false, "name": "MailboxMoveRemoteHostName", "title": "MailboxMoveRemoteHostName", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "LitigationHoldEnabled": { "__type_requested": "System.Boolean", "required": false, "name": "LitigationHoldEnabled", "title": "LitigationHoldEnabled", "__type_mapping_type": "Boolean", "readonly": true, "type": "boolean", "description": "This parameter is reserved for internal Microsoft use." }, "MicrosoftOnlineServicesID": { "__type_requested": "System.String", "required": true, "description": "The MicrosoftOnlineServicesID parameter specifies the user ID for the object. This parameter only applies to objects in the cloud-based service. It isn't available for on-premises deployments.", "title": "MicrosoftOnlineServicesID", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "MicrosoftOnlineServicesID" }, "ArchiveQuota": { "__type_requested": "System.String", "required": false, "name": "ArchiveQuota", "title": "ArchiveQuota", "__type_mapping_type": "String", "readonly": true, "type": "string", "description": "This parameter is reserved for internal Microsoft use." }, "MailboxRegionLastUpdateTime": { "__type_requested": "", "required": false, "name": "MailboxRegionLastUpdateTime", "title": "MailboxRegionLastUpdateTime", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "ExchangeUserAccountControl": { "__type_requested": "System.String", "required": false, "name": "ExchangeUserAccountControl", "title": "ExchangeUserAccountControl", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "MaxReceiveSize": { "__type_requested": "System.String", "required": false, "name": "MaxReceiveSize", "title": "MaxReceiveSize", "__type_mapping_type": "String", "readonly": true, "type": "string", "description": "This parameter is available only in on-premises Exchange 2016.\nThe MaxReceiveSize parameter specifies the maximum size of a message that can be sent to the mail user. Messages larger than the maximum size are rejected.\nWhen you enter a value, qualify the value with one of the following units:\nB (bytes)\nKB (kilobytes)\nMB (megabytes)\nGB (gigabytes)\nTB (terabytes)\nUnqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte.\nA valid value is a number up to 1.999999 gigabytes (2147483647 bytes) or the value unlimited. The default value is unlimited.\nThe value unlimited indicates the maximum receive size for the mail user is controlled elsewhere (for example, organization, server, or connector limits).\nFor any message size limit, you need to set a value that's larger than the actual size you want enforced. This accounts for the Base64 encoding of attachments and other binary data. Base64 encoding increases the size of the message by approximately 33%, so the value you specify should be approximately 33% larger than the actual message size you want enforced. For example, if you specify a maximum message size value of 64 MB, you can expect a realistic maximum message size of approximately 48 MB." }, "AcceptMessagesOnlyFromSendersOrMembers": { "__type_requested": "Deserialized.Microsoft.Exchange.Data.Directory.ADMultiValuedProperty`1[[Microsoft.Exchange.Data.Directory.ADObjectId,", "required": false, "name": "AcceptMessagesOnlyFromSendersOrMembers", "title": "AcceptMessagesOnlyFromSendersOrMembers", "items": { "type": "string" }, "__type_mapping_type": "String[]", "readonly": true, "type": "array", "description": "The AcceptMessagesOnlyFromSendersOrMembers parameter specifies who is allowed to send messages to this recipient. Messages from other senders are rejected.\nValid values for this parameter are individual senders and groups in your organization. Individual senders are mailboxes, mail users, and mail contacts. Groups are distribution groups, mail-enabled security groups, and dynamic distribution groups. Specifying a group means all members of the group are allowed to send messages to this recipient.\nTo specify senders for this parameter, you can use any value that uniquely identifies the sender. For example:\nName\nDisplay name\nAlias\nDistinguished name (DN)\nCanonical DN\nEmail address\nGUID\nYou can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: <sender1>,<senter2>.... If the values contain spaces or otherwise require quotation marks, use the following syntax: \"<sender1>\",\"<sender2>\"....\nTo add or remove individual senders or groups without affecting other existing entries, use the AcceptMessagesOnlyFrom and AcceptMessageOnlyFromDLMembers parameters.\nThe individual senders and groups you specify for this parameter are automatically copied to the AcceptMessagesOnlyFrom and AcceptMessagesOnlyFromDLMembers properties, respectively. Therefore, you can't use the AcceptMessagesOnlyFromSendersOrMembers parameter and the AcceptMessagesOnlyFrom or AcceptMessagesOnlyFromDLMembers parameters in the same command.\nBy default, this parameter is blank ($null), which allows this recipient to accept messages from all senders." }, "DomainController": { "__type_requested": "Fqdn", "required": false, "description": "This parameter is available only in on-premises Exchange 2016.\nThe 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.", "title": "DomainController", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "DomainController" }, "SamAccountName": { "__type_requested": "String", "required": false, "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.", "title": "SamAccountName", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "SamAccountName" }, "UsePreferMessageFormat": { "__type_requested": "$true | $false", "required": false, "description": "The UsePreferMessageFormat specifies whether the message format settings configured for the mail user or mail contact override the global settings configured for the remote domain or configured by the message sender. Valid value are:\n$true Messages sent to the mail user or mail contact use the message format that's configured for the mail user or mail contact.\n$false Messages sent to the mail user or mail contact use the message format that's configured for the remote domain (the default remote domain or a specific remote domain) or configured by the message sender. This is the default value.", "title": "UsePreferMessageFormat", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "UsePreferMessageFormat" }, "IsValid": { "__type_requested": "System.Boolean", "required": false, "name": "IsValid", "title": "IsValid", "__type_mapping_type": "Boolean", "readonly": true, "type": "boolean" }, "ProhibitSendReceiveQuota": { "__type_requested": "System.String", "required": false, "name": "ProhibitSendReceiveQuota", "title": "ProhibitSendReceiveQuota", "__type_mapping_type": "String", "readonly": true, "type": "string", "description": "PARAMVALUE: Unlimited" }, "WhenChanged": { "__type_requested": "System.DateTime", "__type_mapping_type": "DateTime", "name": "WhenChanged", "title": "WhenChanged", "format": "date-time", "required": false, "readonly": true, "type": "string" }, "ImmutableId": { "__type_requested": "String", "required": false, "description": "The ImmutableId parameter is used by GAL synchronization (GALSync) and specifies a unique and immutable identifier in the form of an SMTP address for an Exchange mailbox used for federated delegation when requesting Security Assertion Markup Language (SAML) tokens. If federation is configured for this mailbox and you don't set this parameter when you create the mailbox, Exchange creates the value for the immutable ID based upon the mailbox's ExchangeGUID and the federated account namespace, for example, [email protected].\nYou need to set the ImmutableId parameter if Active Directory Federation Services (AD FS) is deployed to allow single sign-on into an off-premises mailbox and AD FS is configured to use a different attribute than ExchangeGUID for sign-on token requests. Both, Exchange and AD FS must request the same token for the same user to ensure proper functionality for a cross-premises Exchange deployment scenario.", "title": "ImmutableId", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "ImmutableId" }, "ComplianceTagHoldApplied": { "__type_requested": "System.Boolean", "required": false, "name": "ComplianceTagHoldApplied", "title": "ComplianceTagHoldApplied", "__type_mapping_type": "Boolean", "readonly": true, "type": "boolean" }, "ExternalEmailAddress": { "__type_requested": "System.String", "required": true, "description": "The ExternalEmailAddress parameter specifies the target email address of the mail contact or mail user. By default, this value is used as the primary email address of the mail contact or mail user.\nIn on-premises environments, you can use the PrimarySMTPAddress parameter to set the primary email address to a different value. However, we recommend this only in cross-forest environments.", "title": "ExternalEmailAddress", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "ExternalEmailAddress" }, "UseExistingLiveId": { "__type_requested": "SwitchParameter", "required": true, "description": "This parameter is available only in the cloud-based service.\nThe UseExistingLiveId switch specifies whether to use the specified Microsoft account (formerly known as a Windows Live ID) that already exists in the cloud-based domain. The specified Microsoft account can't have a mail user associated with it.\nYou don't need to specify a value with this switch.", "title": "UseExistingLiveId", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "UseExistingLiveId" }, "MailboxLocations": { "__type_requested": "Deserialized.System.Collections.Generic.List`1[[Microsoft.Exchange.Data.Directory.IMailboxLocationInfo,", "required": false, "name": "MailboxLocations", "title": "MailboxLocations", "items": { "type": "string" }, "__type_mapping_type": "String[]", "readonly": true, "type": "array" }, "IssueWarningQuota": { "__type_requested": "System.String", "required": false, "name": "IssueWarningQuota", "title": "IssueWarningQuota", "__type_mapping_type": "String", "readonly": true, "type": "string", "description": "PARAMVALUE: Unlimited" }, "ExchangeGuid": { "__type_requested": "System.Guid", "required": false, "name": "ExchangeGuid", "title": "ExchangeGuid", "__type_mapping_type": "String", "readonly": true, "type": "string", "description": "This parameter is reserved for internal Microsoft use." }, "FirstName": { "__type_requested": "String", "required": false, "description": "The FirstName parameter specifies the user's first name.", "title": "FirstName", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "FirstName" }, "NetID": { "__type_requested": "NetID", "required": false, "description": "This parameter is reserved for internal Microsoft use.", "title": "NetID", "__type_mapping_type": "Unknown", "name": "NetID", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "MailboxRelease": { "__type_requested": "System.String", "required": false, "name": "MailboxRelease", "title": "MailboxRelease", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "DataEncryptionPolicy": { "__type_requested": "", "required": false, "description": "PARAMVALUE: DataEncryptionPolicyIdParameter", "title": "DataEncryptionPolicy", "__type_mapping_type": "Unknown", "name": "DataEncryptionPolicy", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "EndDateForRetentionHold": { "__type_requested": "DateTime", "__type_mapping_type": "DateTime", "name": "EndDateForRetentionHold", "title": "EndDateForRetentionHold", "format": "date-time", "required": false, "readonly": true, "type": "string", "description": "This parameter is reserved for internal Microsoft use." }, "PersistedCapabilities": { "__type_requested": "Deserialized.Microsoft.Exchange.Data.Directory.ADMultiValuedProperty`1[[Microsoft.Exchange.Data.Directory.Capability,", "required": false, "name": "PersistedCapabilities", "title": "PersistedCapabilities", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "DisabledArchiveGuid": { "__type_requested": "System.Guid", "required": false, "name": "DisabledArchiveGuid", "title": "DisabledArchiveGuid", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "MailboxMoveFlags": { "__type_requested": "System.String", "required": false, "name": "MailboxMoveFlags", "title": "MailboxMoveFlags", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "EmailAddresses": { "__type_requested": "Deserialized.Microsoft.Exchange.Data.ProxyAddressCollection", "required": false, "name": "EmailAddresses", "title": "EmailAddresses", "items": { "type": "string" }, "__type_mapping_type": "String[]", "readonly": true, "type": "array", "description": "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.\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>\"...}." }, "SKUAssigned": { "__type_requested": "$true | $false", "required": false, "description": "This parameter is reserved for internal Microsoft use.", "title": "SKUAssigned", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "SKUAssigned" }, "JournalArchiveAddress": { "__type_requested": "System.String", "required": false, "name": "JournalArchiveAddress", "title": "JournalArchiveAddress", "__type_mapping_type": "String", "readonly": true, "type": "string", "description": "This parameter is reserved for internal Microsoft use." }, "MailboxMoveStatus": { "__type_requested": "System.String", "required": false, "name": "MailboxMoveStatus", "title": "MailboxMoveStatus", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "PSComputerName": { "__type_requested": "System.String", "required": false, "name": "PSComputerName", "title": "PSComputerName", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "RecoverableItemsWarningQuota": { "__type_requested": "System.String", "required": false, "name": "RecoverableItemsWarningQuota", "title": "RecoverableItemsWarningQuota", "__type_mapping_type": "String", "readonly": true, "type": "string", "description": "This parameter is available only in on-premises Exchange 2016.\nThe RecoverableItemsWarningQuota parameter specifies the warning threshold for the size of the Recoverable Items folder for a mail user that has a corresponding remote mailbox or remote archive mailbox in the cloud-based service. If the Recoverable Items folder reaches or exceeds this size, Exchange logs an event to the application event log.\nWhen you enter a value, qualify the value with one of the following units:\nB (bytes)\nKB (kilobytes)\nMB (megabytes)\nGB (gigabytes)\nTB (terabytes)\nUnqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte.\nA valid value is number up to 1.999999999 terabytes (2199023254528 bytes) or the value unlimited. The default value is 20 gigabytes (21474836480 bytes).\nThe RecoverableItemsQuota value must be greater than or equal to the RecoverableItemsWarningQuota value." }, "FederatedIdentity": { "__type_requested": "String", "required": true, "description": "This parameter is available only in the cloud-based service.\nThe FederatedIdentity parameter associates an on-premises Active Directory user with a user in the cloud.", "title": "FederatedIdentity", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "FederatedIdentity" }, "PrimarySmtpAddress": { "__type_requested": "System.String", "required": false, "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.\nBy default, the primary address is the same as the ExternalEmailAddress parameter value.\nIf you use the PrimarySmtpAddress parameter to specify the primary email address, the command sets the EmailAddressPolicyEnabled property of the mail user to False, which means the email addresses of the mail user aren't automatically updated by email address policies. We recommend that you don't set the primary email address to a value other than the ExternalEmailAddress unless you're in a cross-forest scenario.", "title": "PrimarySmtpAddress", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "PrimarySmtpAddress" }, "BypassModerationFromSendersOrMembers": { "__type_requested": "Deserialized.Microsoft.Exchange.Data.Directory.ADMultiValuedProperty`1[[Microsoft.Exchange.Data.Directory.ADObjectId,", "required": false, "name": "BypassModerationFromSendersOrMembers", "title": "BypassModerationFromSendersOrMembers", "items": { "type": "string" }, "__type_mapping_type": "String[]", "readonly": true, "type": "array", "description": "The BypassModerationFromSendersOrMembers parameter specifies who is allowed to send messages to this moderated recipient without approval from a moderator. Valid values for this parameter are individual senders and groups in your organization. Specifying a group means all members of the group are allowed to send messages to this recipient without approval from a moderator.\nTo specify senders for this parameter, you can use any value that uniquely identifies the sender. For example:\nName\nDisplay name\nAlias\nDistinguished name (DN)\nCanonical DN\nEmail address\nGUID\nTo enter multiple senders and overwrite any existing entries, use the following syntax: <sender1>,<sender2>.... If the values contain spaces or otherwise require quotation marks, use the following syntax: \"<sender1>\",\"<sender2>\"....\nTo add or remove one or more senders without affecting any existing entries, use the following syntax: @{Add=\"<sender1>\",\"<sender2>\"...; Remove=\"<sender3>\",\"<sender4>\"...}.\nThis parameter is meaningful only when moderation is enabled for the recipient. By default, this parameter is blank ($null), which means messages from all senders other than the designated moderators are moderated. When a moderator sends a message to this recipient, the message is isn't moderated. In other words, you don't need to use this parameter to include the moderators." }, "MailboxMoveTargetMDB": { "__type_requested": "", "required": false, "name": "MailboxMoveTargetMDB", "title": "MailboxMoveTargetMDB", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "MessageBodyFormat": { "__type_requested": "System.String", "required": false, "description": "The MessageBodyFormat parameter specifies the message body format for messages sent to the mail contact or mail user. Valid values are:\nText\nHtml\nTextAndHtml This is the default value.\nThe MessageFormat and MessageBodyFormat parameters are interdependent:\nMessageFormat is MimeMessageBodyFormat can be Text, Html, or TextAndHtml.\nMessageFormat is TextMessageBodyFormat can only be Text.", "title": "MessageBodyFormat", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "MessageBodyFormat" }, "UsageLocation": { "__type_requested": "", "required": false, "description": "This parameter is reserved for internal Microsoft use.", "title": "UsageLocation", "__type_mapping_type": "Unknown", "name": "UsageLocation", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "Identity": { "__type_requested": "System.String", "required": false, "name": "Identity", "title": "Identity", "__type_mapping_type": "String", "readonly": true, "type": "string", "description": "The Identity parameter specifies the mail user that you want to view. You can use any value that uniquely identifies the mail user.\nFor example:\nName\nDisplay name\nAlias\nDistinguished name (DN)\nCanonical DN\nEmail address\nGUID" }, "OverrideRecipientQuotas": { "__type_requested": "SwitchParameter", "required": false, "description": "This parameter is reserved for internal Microsoft use.", "title": "OverrideRecipientQuotas", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "OverrideRecipientQuotas" }, "MailboxProvisioningConstraint": { "__type_requested": "", "required": false, "description": "This parameter is reserved for internal Microsoft use.", "title": "MailboxProvisioningConstraint", "__type_mapping_type": "Unknown", "name": "MailboxProvisioningConstraint", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "StsRefreshTokensValidFrom": { "__type_requested": "System.DateTime", "__type_mapping_type": "DateTime", "name": "StsRefreshTokensValidFrom", "title": "StsRefreshTokensValidFrom", "format": "date-time", "required": false, "readonly": true, "type": "string" }, "CustomAttribute1": { "__type_requested": "System.String", "required": false, "name": "CustomAttribute1", "title": "CustomAttribute1", "__type_mapping_type": "String", "readonly": true, "type": "string", "description": "The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information." }, "CustomAttribute3": { "__type_requested": "System.String", "required": false, "name": "CustomAttribute3", "title": "CustomAttribute3", "__type_mapping_type": "String", "readonly": true, "type": "string", "description": "The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information." }, "CustomAttribute2": { "__type_requested": "System.String", "required": false, "name": "CustomAttribute2", "title": "CustomAttribute2", "__type_mapping_type": "String", "readonly": true, "type": "string", "description": "The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information." }, "CustomAttribute5": { "__type_requested": "System.String", "required": false, "name": "CustomAttribute5", "title": "CustomAttribute5", "__type_mapping_type": "String", "readonly": true, "type": "string", "description": "The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information." }, "CustomAttribute4": { "__type_requested": "System.String", "required": false, "name": "CustomAttribute4", "title": "CustomAttribute4", "__type_mapping_type": "String", "readonly": true, "type": "string", "description": "The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information." }, "CustomAttribute7": { "__type_requested": "System.String", "required": false, "name": "CustomAttribute7", "title": "CustomAttribute7", "__type_mapping_type": "String", "readonly": true, "type": "string", "description": "The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information." }, "CustomAttribute6": { "__type_requested": "System.String", "required": false, "name": "CustomAttribute6", "title": "CustomAttribute6", "__type_mapping_type": "String", "readonly": true, "type": "string", "description": "The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information." }, "CustomAttribute9": { "__type_requested": "System.String", "required": false, "name": "CustomAttribute9", "title": "CustomAttribute9", "__type_mapping_type": "String", "readonly": true, "type": "string", "description": "The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information." }, "CustomAttribute8": { "__type_requested": "System.String", "required": false, "name": "CustomAttribute8", "title": "CustomAttribute8", "__type_mapping_type": "String", "readonly": true, "type": "string", "description": "The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information." }, "ExternalDirectoryObjectId": { "__type_requested": "String", "required": false, "description": "This parameter is reserved for internal Microsoft use.", "title": "ExternalDirectoryObjectId", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "ExternalDirectoryObjectId" }, "GrantSendOnBehalfTo": { "__type_requested": "Deserialized.Microsoft.Exchange.Data.Directory.ADMultiValuedProperty`1[[Microsoft.Exchange.Data.Directory.ADObjectId,", "required": false, "name": "GrantSendOnBehalfTo", "title": "GrantSendOnBehalfTo", "items": { "type": "string" }, "__type_mapping_type": "String[]", "readonly": true, "type": "array", "description": "The GrantSendOnBehalfTo parameter specifies who can send on behalf of this mail user. Although messages sent on behalf of the mail user clearly show the sender in the From field (<Sender> on behalf of <Mail user>), replies to these messages are delivered to the mail user, not the sender.\nThe sender you specify for this parameter must a mailbox, mail user or mail-enabled security group (a mail-enabled security principal that can have permissions assigned). You can use any value that uniquely identifies the sender.\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)\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>\"...}.\nBy default, this parameter is blank, which means no one else has permission to send on behalf of this mail user." }, "RetentionUrl": { "__type_requested": "System.String", "required": false, "name": "RetentionUrl", "title": "RetentionUrl", "__type_mapping_type": "String", "readonly": true, "type": "string", "description": "This parameter is reserved for internal Microsoft use." }, "UserSMimeCertificate": { "__type_requested": "MultiValuedProperty", "required": false, "name": "UserSMimeCertificate", "title": "UserSMimeCertificate", "items": { "type": "string" }, "__type_mapping_type": "String[]", "readonly": true, "type": "array", "description": "This parameter is reserved for internal Microsoft use." }, "ImportLiveId": { "__type_requested": "SwitchParameter", "required": true, "description": "This parameter is available only in the cloud-based service.\nThe ImportLiveID switch specifies whether to import an unmanaged Microsoft account (formerly known as a Windows Live ID) into the cloud-based domain. You don't need to specify a value with this switch.\nAn unmanaged Microsoft account was created in the domain before the domain was enrolled in the cloud-based service. Importing a Microsoft account into the domain lets you save any settings associated with the Microsoft account, like instant messaging contacts. However, the Microsoft account is now subject to the security and privacy policies of the organization.", "title": "ImportLiveId", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "ImportLiveId" }, "PoliciesIncluded": { "__type_requested": "Deserialized.Microsoft.Exchange.Data.MultiValuedProperty`1[[System.String,", "required": false, "name": "PoliciesIncluded", "title": "PoliciesIncluded", "items": { "type": "string" }, "__type_mapping_type": "String[]", "readonly": true, "type": "array" }, "ArchiveWarningQuota": { "__type_requested": "System.String", "required": false, "name": "ArchiveWarningQuota", "title": "ArchiveWarningQuota", "__type_mapping_type": "String", "readonly": true, "type": "string", "description": "This parameter is reserved for internal Microsoft use." }, "WhenChangedUTC": { "__type_requested": "System.DateTime", "__type_mapping_type": "DateTime", "name": "WhenChangedUTC", "title": "WhenChangedUTC", "format": "date-time", "required": false, "readonly": true, "type": "string" }, "SKUCapability": { "__type_requested": "None | BPOS_S_Deskless | BPOS_S_Standard | BPOS_S_Enterprise | BPOS_S_Archive | BPOS_L_Standard | BPOS_B_Standard | BPOS_B_CustomDomain | BPOS_S_MidSize | BPOS_S_ArchiveAddOn | BPOS_S_EopStandardAddOn | BPOS_S_EopPremiumAddOn | BPOS_Unmanaged | BPOS_S_ATPAddOn | BPOS_S_Analytics | BPOS_S_Foundation | BPOS_S_EquivioAnalytics | BPOS_S_CustomerLockbox | TOU_Signed | FederatedUser | Partner_Managed | MasteredOnPremise | ResourceMailbox | ExcludedFromBackSync | UMFeatureRestricted | RichCoexistence | OrganizationCapabilityUMGrammar | OrganizationCapabilityUMDataStorage | OrganizationCapabilityOABGen | OrganizationCapabilityGMGen | OrganizationCapabilityClientExtensions | BEVDirLockdown | OrganizationCapabilityUMGrammarReady | OrganizationCapabilityMailRouting | OrganizationCapabilityManagement | OrganizationCapabilityTenantUpgrade | OrganizationCapabilityScaleOut | OrganizationCapabilityMessageTracking | OrganizationCapabilityPstProvider | OrganizationCapabilitySuiteServiceStorage | OrganizationCapabilityOfficeMessageEncryption | OrganizationCapabilityMigration | UMPlanAllowed | OrganizationCapabilityOABReplica | OrganizationCapabilityOfficeGraph", "required": false, "description": "This parameter is reserved for internal Microsoft use.", "title": "SKUCapability", "__type_mapping_type": "Unknown", "name": "SKUCapability", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "ArchiveDatabase": { "__type_requested": "DatabaseIdParameter", "required": false, "description": "This parameter is reserved for internal Microsoft use.", "title": "ArchiveDatabase", "__type_mapping_type": "Unknown", "name": "ArchiveDatabase", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "ForwardingAddress": { "__type_requested": "", "required": false, "name": "ForwardingAddress", "title": "ForwardingAddress", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "WhenCreatedUTC": { "__type_requested": "System.DateTime", "__type_mapping_type": "DateTime", "name": "WhenCreatedUTC", "title": "WhenCreatedUTC", "format": "date-time", "required": false, "readonly": true, "type": "string" }, "RejectMessagesFromDLMembers": { "__type_requested": "Deserialized.Microsoft.Exchange.Data.Directory.ADMultiValuedProperty`1[[Microsoft.Exchange.Data.Directory.ADObjectId,", "required": false, "name": "RejectMessagesFromDLMembers", "title": "RejectMessagesFromDLMembers", "items": { "type": "string" }, "__type_mapping_type": "String[]", "readonly": true, "type": "array", "description": "The RejectMessagesFromDLMembers parameter specifies who isn't allowed to send messages to this recipient. Messages from these senders are rejected.\nValid values for this parameter are groups in your organization (distribution groups, mail-enabled security groups, and dynamic distribution groups). Specifying a group means all members of the group aren't allowed to send messages to this recipient. You can use any value that uniquely identifies the group. For example:\nName\nDisplay name\nAlias\nDistinguished name (DN)\nCanonical DN\nEmail address\nGUID\nYou can enter multiple groups separated by commas. To overwrite any existing entries, use the following syntax: <group1>,<group2>.... If the values contain spaces or otherwise require quotation marks, use the following syntax: \"<group1>\",\"<group2>\"....\nTo add or remove groups without affecting other existing entries, use the following syntax: @{Add=\"<group1>\",\"<group2>\"...; Remove=\"<group1>\",\"<group2>\"...}.\nThe groups you specify for this parameter are automatically copied to the RejectMessagesFromSendersOrMembers property. Therefore, you can't use the RejectMessagesFromDLMembers and RejectMessagesFromSendersOrMembers parameters in the same command.\nBy default, this parameter is blank ($null), which allows this recipient to accept messages from all groups." }, "IsDirSynced": { "__type_requested": "System.Boolean", "required": false, "name": "IsDirSynced", "title": "IsDirSynced", "__type_mapping_type": "Boolean", "readonly": true, "type": "boolean" }, "ProhibitSendQuota": { "__type_requested": "System.String", "required": false, "name": "ProhibitSendQuota", "title": "ProhibitSendQuota", "__type_mapping_type": "String", "readonly": true, "type": "string", "description": "PARAMVALUE: Unlimited" }, "UMDtmfMap": { "__type_requested": "Deserialized.Microsoft.Exchange.Data.MultiValuedProperty`1[[System.String,", "required": false, "name": "UMDtmfMap", "title": "UMDtmfMap", "items": { "type": "string" }, "__type_mapping_type": "String[]", "readonly": true, "type": "array", "description": "The UMDtmfMap parameter specifies the dual-tone multiple-frequency (DTMF) map values for the recipient. This allows the recipient to be identified by using a telephone keypad in Unified Messaging (UM) environments. Typically, these DTMF values are automatically created and updated, but you can use this parameter to make changes manually. This parameter uses the following syntax:\nemailAddress:<integers>\nlastNameFirstName:<integers>\nfirstNameLastName:<integers>\nTo enter values that overwrite all existing entries, use the following syntax: emailAddress:<integers>,lastNameFirstName:<integers>,firstNameLastName:<integers>.\nIf you use this syntax and you omit any of the DTMF map values, those values are removed from the recipient. For example, if you specify only emailAddress:<integers>, all existing lastNameFirstName and firstNameLastName values are removed.\nTo add or remove values without affecting other existing entries, use the following syntax: @{Add=\"emailAddress:<integers>\",\"lastNameFirstName:<integers>\",\"firstNameLastName:<integers>\"; Remove=\"emailAddress:<integers>\",\"lastNameFirstName:<integers>\",\"firstNameLastName:<integers>\"}.\nIf you use this syntax, you don't need to specify all of the DTMF map values, and you can specify multiple DTMF map values. For example, you can use @{Add=\"emailAddress:<integers1>\",\"emailAddress:<intgers2>} to add two new values for emailAddress without affecting the existing lastNameFirstName and firstNameLastName values." }, "MailboxMoveBatchName": { "__type_requested": "System.String", "required": false, "name": "MailboxMoveBatchName", "title": "MailboxMoveBatchName", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "AddressListMembership": { "__type_requested": "Deserialized.Microsoft.Exchange.Data.Directory.ADMultiValuedProperty`1[[Microsoft.Exchange.Data.Directory.ADObjectId,", "required": false, "name": "AddressListMembership", "title": "AddressListMembership", "items": { "type": "string" }, "__type_mapping_type": "String[]", "readonly": true, "type": "array" }, "MailboxMoveSourceMDB": { "__type_requested": "", "required": false, "name": "MailboxMoveSourceMDB", "title": "MailboxMoveSourceMDB", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "ExtensionCustomAttribute3": { "__type_requested": "Deserialized.Microsoft.Exchange.Data.MultiValuedProperty`1[[System.String,", "required": false, "name": "ExtensionCustomAttribute3", "title": "ExtensionCustomAttribute3", "items": { "type": "string" }, "__type_mapping_type": "String[]", "readonly": true, "type": "array", "description": "The ExtensionCustomAttribute1-5 parameters specify custom attributes that store additional information. You can specify multiple values for these parameters as a comma delimited list. Each ExtensionCustomAttribute parameter can hold up to 1,300 values.\nFor more information about custom attributes, see Custom attributes.\nFor more information about using multivalued properties, see Modifying multivalued properties." }, "ExtensionCustomAttribute2": { "__type_requested": "Deserialized.Microsoft.Exchange.Data.MultiValuedProperty`1[[System.String,", "required": false, "name": "ExtensionCustomAttribute2", "title": "ExtensionCustomAttribute2", "items": { "type": "string" }, "__type_mapping_type": "String[]", "readonly": true, "type": "array", "description": "The ExtensionCustomAttribute1-5 parameters specify custom attributes that store additional information. You can specify multiple values for these parameters as a comma delimited list. Each ExtensionCustomAttribute parameter can hold up to 1,300 values.\nFor more information about custom attributes, see Custom attributes.\nFor more information about using multivalued properties, see Modifying multivalued properties." }, "ExtensionCustomAttribute1": { "__type_requested": "Deserialized.Microsoft.Exchange.Data.MultiValuedProperty`1[[System.String,", "required": false, "name": "ExtensionCustomAttribute1", "title": "ExtensionCustomAttribute1", "items": { "type": "string" }, "__type_mapping_type": "String[]", "readonly": true, "type": "array", "description": "The ExtensionCustomAttribute1-5 parameters specify custom attributes that store additional information. You can specify multiple values for these parameters as a comma delimited list. Each ExtensionCustomAttribute parameter can hold up to 1,300 values.\nFor more information about custom attributes, see Custom attributes.\nFor more information about using multivalued properties, see Modifying multivalued properties." }, "StartDateForRetentionHold": { "__type_requested": "DateTime", "__type_mapping_type": "DateTime", "name": "StartDateForRetentionHold", "title": "StartDateForRetentionHold", "format": "date-time", "required": false, "readonly": true, "type": "string", "description": "This parameter is reserved for internal Microsoft use." }, "ExtensionCustomAttribute5": { "__type_requested": "Deserialized.Microsoft.Exchange.Data.MultiValuedProperty`1[[System.String,", "required": false, "name": "ExtensionCustomAttribute5", "title": "ExtensionCustomAttribute5", "items": { "type": "string" }, "__type_mapping_type": "String[]", "readonly": true, "type": "array", "description": "The ExtensionCustomAttribute1-5 parameters specify custom attributes that store additional information. You can specify multiple values for these parameters as a comma delimited list. Each ExtensionCustomAttribute parameter can hold up to 1,300 values.\nFor more information about custom attributes, see Custom attributes.\nFor more information about using multivalued properties, see Modifying multivalued properties." }, "SkipMailboxProvisioningConstraintValidation": { "__type_requested": "SwitchParameter", "required": false, "description": "This parameter is reserved for internal Microsoft use.", "title": "SkipMailboxProvisioningConstraintValidation", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "SkipMailboxProvisioningConstraintValidation" }, "ObjectState": { "__type_requested": "System.String", "required": false, "name": "ObjectState", "title": "ObjectState", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "Password": { "__type_requested": "SecureString", "required": true, "description": "The Password parameter specifies the password for the user's account. Valid values for this parameter use the syntax (ConvertTo-SecureString -String '<password>' -AsPlainText -Force).", "title": "Password", "__type_mapping_type": "Unknown", "name": "Password", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "IsSoftDeletedByDisable": { "__type_requested": "System.Boolean", "required": false, "name": "IsSoftDeletedByDisable", "title": "IsSoftDeletedByDisable", "__type_mapping_type": "Boolean", "readonly": true, "type": "boolean" }, "LitigationHoldDate": { "__type_requested": "DateTime", "__type_mapping_type": "DateTime", "name": "LitigationHoldDate", "title": "LitigationHoldDate", "format": "date-time", "required": false, "readonly": true, "type": "string", "description": "This parameter is reserved for internal Microsoft use." }, "Name": { "__type_requested": "String", "required": true, "description": "The Name parameter specifies the unique name of the mail user. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks (\").\nThis value is also used for the DisplayName property if you don't use the DisplayName parameter.", "title": "Name", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "Name" }, "MailboxRegion": { "__type_requested": "String", "required": false, "description": "PARAMVALUE: String", "title": "MailboxRegion", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "MailboxRegion" }, "LitigationHoldOwner": { "__type_requested": "System.String", "required": false, "name": "LitigationHoldOwner", "title": "LitigationHoldOwner", "__type_mapping_type": "String", "readonly": true, "type": "string", "description": "This parameter is reserved for internal Microsoft use." }, "DeliverToMailboxAndForward": { "__type_requested": "System.Boolean", "required": false, "name": "DeliverToMailboxAndForward", "title": "DeliverToMailboxAndForward", "__type_mapping_type": "Boolean", "readonly": true, "type": "boolean" }, "Alias": { "__type_requested": "String", "required": false, "description": "The Alias parameter specifies the Exchange alias (also known as the mail nickname) for the recipient. This value identifies the recipient as a mail-enabled object, and shouldn't be confused with multiple email addresses for the same recipient (also known as proxy addresses). A recipient can have only one Alias value.\nThe value of Alias can contain letters, numbers and the characters !, #, $, %, &, ', *, +, -, /, =, ?, ^, _, `, {, |, } and ~. Periods (.) are allowed, but each period must be surrounded by other valid characters (for example, help.desk). Unicode characters from U+00A1 to U+00FF are also allowed. The maximum length of the Alias value is 64 characters.\nWhen you create a recipient without specifying an email address, the Alias value you specify is used to generate the primary email address (<alias>@<domain>). Supported Unicode characters are mapped to best-fit US-ASCII text characters. For example, U+00F6 (\u00f6) is changed to oe in the primary email address.\nIf you don't use the Alias parameter when you create a recipient, the value of a different required parameter is used for the Alias property value:\nRecipients with user accounts (for example, user mailboxes, and mail users) The left side of the MicrosoftOnlineServicesID or UserPrincipalName parameter is used. For example, [email protected] results in the Alias property value helpdesk.\nRecipeints without user accounts (for example, room mailboxes, mail contacts, and distribution groups) The value of the Name parameter is used. Spaces are removed and unsupported characters are converted to question marks (?).\nIf you modify the Alias value of an existing recipient, the primary email address is automatically updated only in on-premises environments where the recipient is subject to email address policies (the EmailAddressPolicyEnabled property is True for the recipient).\nThe Alias parameter never generates or updates the primary email address of a mail contact or a mail user.", "title": "Alias", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "Alias" }, "RetentionComment": { "__type_requested": "System.String", "required": false, "name": "RetentionComment", "title": "RetentionComment", "__type_mapping_type": "String", "readonly": true, "type": "string", "description": "This parameter is reserved for internal Microsoft use." }, "MailTip": { "__type_requested": "String", "required": false, "name": "MailTip", "title": "MailTip", "__type_mapping_type": "String", "readonly": true, "type": "string", "description": "The MailTip parameter specifies the custom MailTip text for this recipient. The MailTip is shown to senders when they start drafting an email message to this recipient. If the value contains spaces, enclose the value in quotation marks (\").\nWhen you add a MailTip to a recipient, two things happen:\nHTML tags are automatically added to the text. For example, if you enter the text: \"This mailbox is not monitored\", the MailTip automatically becomes: <html><body>This mailbox is not monitored</body></html>. Additional HTML tags aren't supported, and the length of the MailTip can't exceed 175 displayed characters.\nThe text is automatically added to the MailTipTranslations property of the recipient as the default value: default:<MailTip text>. If you modify the MailTip text, the default value is automatically updated in the MailTipTranslations property, and vice-versa." }, "RejectMessagesFrom": { "__type_requested": "Deserialized.Microsoft.Exchange.Data.Directory.ADMultiValuedProperty`1[[Microsoft.Exchange.Data.Directory.ADObjectId,", "required": false, "name": "RejectMessagesFrom", "title": "RejectMessagesFrom", "items": { "type": "string" }, "__type_mapping_type": "String[]", "readonly": true, "type": "array", "description": "The RejectMessagesFrom parameter specifies who isn't allowed to send messages to this recipient. Messages from these senders are rejected.\nValid values for this parameter are individual senders in your organization (mailboxes, mail users, and mail contacts). You can use any value that uniquely identifies the sender. For example:\nName\nDisplay name\nAlias\nDistinguished name (DN)\nCanonical DN\nEmail address\nGUID\nYou can enter multiple senders separated by commas. To overwrite any existing entries, use the following syntax: <sender1>,<senter2>.... If the values contain spaces or otherwise require quotation marks, use the following syntax: \"<sender1>\",\"<sender2>\"....\nTo add or remove senders without affecting other existing entries, use the following syntax: @{Add=\"<sender1>\",\"<sender2>\"...; Remove=\"<sender1>\",\"<sender2>\"...}.\nThe senders you specify for this parameter are automatically copied to the RejectMessagesFromSendersOrMembers property. Therefore, you can't use the RejectMessagesFrom and RejectMessagesFromSendersOrMembers parameters in the same command.\nBy default, this parameter is blank ($null), which allows this recipient to accept messages from all senders." }, "MailboxContainerGuid": { "__type_requested": "", "required": false, "name": "MailboxContainerGuid", "title": "MailboxContainerGuid", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "CustomAttribute11": { "__type_requested": "System.String", "required": false, "name": "CustomAttribute11", "title": "CustomAttribute11", "__type_mapping_type": "String", "readonly": true, "type": "string", "description": "The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information." }, "CustomAttribute10": { "__type_requested": "System.String", "required": false, "name": "CustomAttribute10", "title": "CustomAttribute10", "__type_mapping_type": "String", "readonly": true, "type": "string", "description": "The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information." }, "CustomAttribute13": { "__type_requested": "System.String", "required": false, "name": "CustomAttribute13", "title": "CustomAttribute13", "__type_mapping_type": "String", "readonly": true, "type": "string", "description": "The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information." }, "CustomAttribute12": { "__type_requested": "System.String", "required": false, "name": "CustomAttribute12", "title": "CustomAttribute12", "__type_mapping_type": "String", "readonly": true, "type": "string", "description": "The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information." }, "CustomAttribute15": { "__type_requested": "System.String", "required": false, "name": "CustomAttribute15", "title": "CustomAttribute15", "__type_mapping_type": "String", "readonly": true, "type": "string", "description": "The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information." }, "CustomAttribute14": { "__type_requested": "System.String", "required": false, "name": "CustomAttribute14", "title": "CustomAttribute14", "__type_mapping_type": "String", "readonly": true, "type": "string", "description": "The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information." }, "EmailAddressPolicyEnabled": { "__type_requested": "System.Boolean", "required": false, "name": "EmailAddressPolicyEnabled", "title": "EmailAddressPolicyEnabled", "__type_mapping_type": "Boolean", "readonly": true, "type": "boolean", "description": "This parameter is available only in on-premises Exchange 2016.\nThe EmailAddressPolicyEnabled parameter specifies whether to apply email address policies to this recipient. Valid values are:\n$true All applicable email address policies are applied to this recipient. This is the default value.\n$false No email address policies are applied to this recipient." }, "SingleItemRecoveryEnabled": { "__type_requested": "System.Boolean", "required": false, "name": "SingleItemRecoveryEnabled", "title": "SingleItemRecoveryEnabled", "__type_mapping_type": "Boolean", "readonly": true, "type": "boolean", "description": "This parameter is reserved for internal Microsoft use." }, "RecipientType": { "__type_requested": "System.String", "required": false, "name": "RecipientType", "title": "RecipientType", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "ObjectClass": { "__type_requested": "Deserialized.Microsoft.Exchange.Data.MultiValuedProperty`1[[System.String,", "required": false, "name": "ObjectClass", "title": "ObjectClass", "items": { "type": "string" }, "__type_mapping_type": "String[]", "readonly": true, "type": "array" }, "WhenCreated": { "__type_requested": "System.DateTime", "__type_mapping_type": "DateTime", "name": "WhenCreated", "title": "WhenCreated", "format": "date-time", "required": false, "readonly": true, "type": "string" }, "MacAttachmentFormat": { "__type_requested": "System.String", "required": false, "description": "The MacAttachmentFormat parameter specifies the Apple Macintosh operating system attachment format to use for messages sent to the mail contact or mail user. Valid values are:\nBinHex This is the default value.\nUuEncode\nAppleSingle\nAppleDouble\nThe MacAttachmentFormat and MessageFormat parameters are interdependent:\nMessageFormat is TextMacAttachmentFormat can be BinHex or UuEncode.\nMessageFormat is MimeMacAttachmentFormat can be BinHex, AppleSingle, or AppleDouble.", "title": "MacAttachmentFormat", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "MacAttachmentFormat" }, "Id": { "__type_requested": "System.String", "required": false, "name": "Id", "title": "Id", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "OrganizationalUnit": { "__type_requested": "System.String", "required": false, "description": "The OrganizationalUnit parameter specifies the location in Active Directory where the new mail user is created.\nValid input for this parameter is an organizational unit (OU) or domain that's visible using the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example:\nName\nCanonical name\nDistinguished name (DN)\nGUID", "title": "OrganizationalUnit", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "OrganizationalUnit" }, "ObjectCategory": { "__type_requested": "System.String", "required": false, "name": "ObjectCategory", "title": "ObjectCategory", "__type_mapping_type": "String", "readonly": true, "type": "string" } }, "schema_version": "2017.1" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the GUI Add form. | GET | /api/device/exchangeonline/MailUser/add/ |
|
The GUI Add form of device/exchangeonline/MailUser as JSON |
The API call to the /add/ URL can only be made from a hierarchy that allows the model type to be added. The actions in the response shows the url for the POST API call to create an instance.
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Create | POST | /api/device/exchangeonline/MailUser/ | hierarchy=[hierarchy] |
|
tool/Transaction/[trans pkid]to inspect the created resource and its instance pkid.
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk delete [pkid1],[pkid2]... | DELETE | /api/device/exchangeonline/MailUser/ | hierarchy=[hierarchy] | {"hrefs":["/api/device/exchangeonline/MailUser/[pkid1]", "/api/device/exchangeonline/MailUser/[pkid2]", ...]} |
GET http://[host-proxy]/api/device/exchangeonline/MailUser/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Bulk Modify | GET | /api/device/exchangeonline/MailUser/bulk_update/?schema=&schema_rules=true |
|
|
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk Modify | POST | /api/device/exchangeonline/MailUser/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/exchangeonline/MailUser/[pkid1]", "/api/v0/device/exchangeonline/MailUser/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/exchangeonline/MailUser/?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/MailUser |
|
{"hrefs": ["/api/device/exchangeonline/MailUser/[pkid]"]} |
Bulk Move | POST | /api/tool/DataMove/?model_type=device/exchangeonline/MailUser |
|
{"hrefs": ["/api/device/exchangeonline/MailUser/[pkid1]", "/api/device/exchangeonline/MailUser/[pkid2]",...]} |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/exchangeonline/MailUser; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/exchangeonline/MailUser/export/ |
|
{ "hrefs":["/api/device/exchangeonline/MailUser/[pkid1]", "/api/device/exchangeonline/MailUser/[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/MailUser and the JSON format can be used to import instances of device/exchangeonline/MailUser.
GET http://[host-proxy]/api/device/exchangeonline/MailUser/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for device/exchangeonline/MailUser | POST | /api/device/exchangeonline/MailUser/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/MailUser/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/MailUser/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/device/exchangeonline/MailUser/ |
|
The device/exchangeonline/MailUser schema and all instances as JSON. |
(The list will return 0 to 3 device/exchangeonline/MailUser instances)
{ "operations": [ "move" ], "pagination": { "direction": "asc", "order_by": "DisplayName", "maximum_limit": 2000, "skip": 0, "current": "/api/device/exchangeonline/MailUser/?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": [ { "add": { "support_async": false, "class": "add", "href": "/api/device/exchangeonline/MailUser/add/?hierarchy=[hierarchy]", "method": "GET", "title": "Add" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/device/exchangeonline/MailUser/?hierarchy=[hierarchy]", "method": "DELETE", "title": "Delete" } }, { "bulk_update_form": { "support_async": false, "class": "update", "href": "/api/device/exchangeonline/MailUser/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/MailUser", "method": "POST", "view": "/api/tool/DataMove/?auth_token=[authtoken] } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/exchangeonline/MailUser/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/MailUser/export_bulkload_template/?hierarchy=[hierarchy]", "method": "POST", "title": "Export Bulk Load Template" } }, { "configuration_template": { "support_async": false, "class": "config", "href": "/api/device/exchangeonline/MailUser/configuration_template/?hierarchy=[hierarchy]", "method": "GET", "title": "Configuration Template" } }, { "field_display_policy": { "support_async": false, "class": "display_policy", "href": "/api/device/exchangeonline/MailUser/field_display_policy/?hierarchy=[hierarchy]", "method": "GET", "title": "Field Display Policy" } }, { "list": { "support_async": false, "class": "list", "href": "/api/device/exchangeonline/MailUser/?hierarchy=[hierarchy]", "method": "GET", "title": "List" } }, { "help": { "support_async": false, "class": "help", "href": "/api/device/exchangeonline/MailUser/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } }, { "purge": { "support_async": false, "class": "purge", "href": "/api/device/exchangeonline/MailUser/purge/?hierarchy=[hierarchy]", "method": "POST", "title": "Purge" } } ], "model_type": "device/exchangeonline/MailUser", "model_specific_actions": [ "get", "list", "add", "remove", "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/MailUser. | GET | /api/device/exchangeonline/MailUser/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/exchangeonline/MailUser as HTML |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Modify | PUT | /api/device/exchangeonline/MailUser/[pkid]/ | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Delete | DELETE | /api/device/exchangeonline/MailUser/[pkid]/ | hierarchy=[hierarchy] |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/exchangeonline/MailUser/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/exchangeonline/MailUser/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/exchangeonline/MailUser | 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/MailUser; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/exchangeonline/MailUser/[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/MailUser and the JSON format can be used to import instances of device/exchangeonline/MailUser.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/device/exchangeonline/MailUser/[pkid]/ | hierarchy=[hierarchy] | The device/exchangeonline/MailUser instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/device/exchangeonline/MailUser/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/exchangeonline/MailUser. |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Purge | POST | /api/device/exchangeonline/MailUser/[pkid]/purge/ | hierarchy=[hierarchy] | If payload required: |