netFramework/Microsoft.Exchange.Management.RestApiClient.dll-Help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-EXOCasMailbox</command:name> <command:verb>Get</command:verb> <command:noun>EXOCasMailbox</command:noun> <maml:description> <maml:para>This cmdlet is available only in the Exchange Online PowerShell V2 module. For more information, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell).</maml:para> <maml:para>Use the Get-EXOCasMailbox cmdlet to view the Client Access settings that are configured on mailboxes.</maml:para> <maml:para>For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet returns a variety of client access settings for one or more mailboxes. These settings include options for Outlook on the web, Exchange ActiveSync, POP3, and IMAP4.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-EXOCasMailbox</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Identity</maml:name> <maml:Description> <maml:para>The Identity parameter specifies the mailbox you want to view. For the best performance, we recommend using the following values to identify the mailbox:</maml:para> <maml:para>- User ID or user principal name (UPN)</maml:para> <maml:para>- GUID</maml:para> <maml:para>Otherwise, you can use any other value that uniquely identifies the mailbox. For example:</maml:para> <maml:para>- Name</maml:para> <maml:para>- Alias</maml:para> <maml:para>- Distinguished name (DN)</maml:para> <maml:para>- <domain name>\<account name></maml:para> <maml:para>- Email address</maml:para> <maml:para>- LegacyExchangeDN</maml:para> <maml:para>- SamAccountName</maml:para> <maml:para>You can't use this parameter with the Anr parameter.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>ExternalDirectoryObjectId</maml:name> <maml:Description> <maml:para>The ExternalDirectoryObjectId parameter identifies the mailbox you want to view by using the ObjectId of the mailbox in Azure Active Directory. You can use this value instead of the Identity parameter.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:Description> <maml:para>The Filter parameter uses OPath syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`.</maml:para> <maml:para>- Enclose the whole OPath filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables.</maml:para> <maml:para>- Property is a filterable property. For more information about the filterable properties, see Get-EXOCasMailbox property sets (https://docs.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exocasmailbox-property-sets) and [Filterable properties for the Filter parameter](https://docs.microsoft.com/powershell/exchange/filter-properties).</maml:para> <maml:para>- ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see about_Comparison_Operators (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators).</maml:para> <maml:para>- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values (for example, `500`, `$true`, `$false`, or `$null`).</maml:para> <maml:para>You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example, `"Criteria1 -and Criteria2"` or `"(Criteria1 -and Criteria2) -or Criteria3"`.</maml:para> <maml:para>For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrganizationalUnit</maml:name> <maml:Description> <maml:para>The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid 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:</maml:para> <maml:para>- Name</maml:para> <maml:para>- Canonical name</maml:para> <maml:para>- Distinguished name (DN)</maml:para> <maml:para>- GUID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Properties</maml:name> <maml:Description> <maml:para>The Properties parameter specifies the properties that are returned in the output of this cmdlet. You can specify multiple values separated by commas.</maml:para> <maml:para>For more information about the available properties, see Get-EXOCasMailbox property sets (https://docs.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exocasmailbox-property-sets).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PropertySets</maml:name> <maml:Description> <maml:para>The PropertySets parameter specifies a logical grouping of properties that are returned in the output of this cmdlet. Valid values are:</maml:para> <maml:para>- Minimum (this is the default value)</maml:para> <maml:para>- ActiveSync</maml:para> <maml:para>- Ews</maml:para> <maml:para>- Imap</maml:para> <maml:para>- Mapi</maml:para> <maml:para>- Pop</maml:para> <maml:para>- ProtocolSettings</maml:para> <maml:para>- All</maml:para> <maml:para>You can specify multiple values separated by commas.</maml:para> <maml:para>For more information about the properties that are included in each property set, see Get-EXOCasMailbox property sets (https://docs.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exocasmailbox-property-sets).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PropertySet[]</command:parameterValue> <dev:type> <maml:name>PropertySet[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ProtocolSettings</maml:name> <maml:Description> <maml:para>The ProtocolSettings switch returns the server names, TCP ports and encryption methods for the following settings:</maml:para> <maml:para>- ExternalImapSettings</maml:para> <maml:para>- InternalImapSettings</maml:para> <maml:para>- ExternalPopSettings</maml:para> <maml:para>- InternalPopSettings</maml:para> <maml:para>- ExternalSmtpSettings</maml:para> <maml:para>- InternalSmtpSettings</maml:para> <maml:para>To see these values, you need to use a formatting cmdlet. For example, Get-CasMailbox laura@contoso.com -ProtocolSettings | Format-List.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResultSize</maml:name> <maml:Description> <maml:para>The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Unlimited</command:parameterValue> <dev:type> <maml:name>Unlimited</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>UserPrincipalName</maml:name> <maml:Description> <maml:para>The UserPrincipalName parameter specifies the UPN for the mailbox you want to view (for example, navin.contoso.com).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-EXOCasMailbox</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Anr</maml:name> <maml:Description> <maml:para>The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are:</maml:para> <maml:para>- CommonName (CN)</maml:para> <maml:para>- DisplayName</maml:para> <maml:para>- FirstName</maml:para> <maml:para>- LastName</maml:para> <maml:para>- Alias</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:Description> <maml:para>The Filter parameter uses OPath syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`.</maml:para> <maml:para>- Enclose the whole OPath filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables.</maml:para> <maml:para>- Property is a filterable property. For more information about the filterable properties, see Get-EXOCasMailbox property sets (https://docs.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exocasmailbox-property-sets) and [Filterable properties for the Filter parameter](https://docs.microsoft.com/powershell/exchange/filter-properties).</maml:para> <maml:para>- ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see about_Comparison_Operators (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators).</maml:para> <maml:para>- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values (for example, `500`, `$true`, `$false`, or `$null`).</maml:para> <maml:para>You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example, `"Criteria1 -and Criteria2"` or `"(Criteria1 -and Criteria2) -or Criteria3"`.</maml:para> <maml:para>For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrganizationalUnit</maml:name> <maml:Description> <maml:para>The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid 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:</maml:para> <maml:para>- Name</maml:para> <maml:para>- Canonical name</maml:para> <maml:para>- Distinguished name (DN)</maml:para> <maml:para>- GUID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Properties</maml:name> <maml:Description> <maml:para>The Properties parameter specifies the properties that are returned in the output of this cmdlet. You can specify multiple values separated by commas.</maml:para> <maml:para>For more information about the available properties, see Get-EXOCasMailbox property sets (https://docs.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exocasmailbox-property-sets).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PropertySets</maml:name> <maml:Description> <maml:para>The PropertySets parameter specifies a logical grouping of properties that are returned in the output of this cmdlet. Valid values are:</maml:para> <maml:para>- Minimum (this is the default value)</maml:para> <maml:para>- ActiveSync</maml:para> <maml:para>- Ews</maml:para> <maml:para>- Imap</maml:para> <maml:para>- Mapi</maml:para> <maml:para>- Pop</maml:para> <maml:para>- ProtocolSettings</maml:para> <maml:para>- All</maml:para> <maml:para>You can specify multiple values separated by commas.</maml:para> <maml:para>For more information about the properties that are included in each property set, see Get-EXOCasMailbox property sets (https://docs.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exocasmailbox-property-sets).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PropertySet[]</command:parameterValue> <dev:type> <maml:name>PropertySet[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ProtocolSettings</maml:name> <maml:Description> <maml:para>The ProtocolSettings switch returns the server names, TCP ports and encryption methods for the following settings:</maml:para> <maml:para>- ExternalImapSettings</maml:para> <maml:para>- InternalImapSettings</maml:para> <maml:para>- ExternalPopSettings</maml:para> <maml:para>- InternalPopSettings</maml:para> <maml:para>- ExternalSmtpSettings</maml:para> <maml:para>- InternalSmtpSettings</maml:para> <maml:para>To see these values, you need to use a formatting cmdlet. For example, Get-CasMailbox laura@contoso.com -ProtocolSettings | Format-List.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResultSize</maml:name> <maml:Description> <maml:para>The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Unlimited</command:parameterValue> <dev:type> <maml:name>Unlimited</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Identity</maml:name> <maml:Description> <maml:para>The Identity parameter specifies the mailbox you want to view. For the best performance, we recommend using the following values to identify the mailbox:</maml:para> <maml:para>- User ID or user principal name (UPN)</maml:para> <maml:para>- GUID</maml:para> <maml:para>Otherwise, you can use any other value that uniquely identifies the mailbox. For example:</maml:para> <maml:para>- Name</maml:para> <maml:para>- Alias</maml:para> <maml:para>- Distinguished name (DN)</maml:para> <maml:para>- <domain name>\<account name></maml:para> <maml:para>- Email address</maml:para> <maml:para>- LegacyExchangeDN</maml:para> <maml:para>- SamAccountName</maml:para> <maml:para>You can't use this parameter with the Anr parameter.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Anr</maml:name> <maml:Description> <maml:para>The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are:</maml:para> <maml:para>- CommonName (CN)</maml:para> <maml:para>- DisplayName</maml:para> <maml:para>- FirstName</maml:para> <maml:para>- LastName</maml:para> <maml:para>- Alias</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>ExternalDirectoryObjectId</maml:name> <maml:Description> <maml:para>The ExternalDirectoryObjectId parameter identifies the mailbox you want to view by using the ObjectId of the mailbox in Azure Active Directory. You can use this value instead of the Identity parameter.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:Description> <maml:para>The Filter parameter uses OPath syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`.</maml:para> <maml:para>- Enclose the whole OPath filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables.</maml:para> <maml:para>- Property is a filterable property. For more information about the filterable properties, see Get-EXOCasMailbox property sets (https://docs.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exocasmailbox-property-sets) and [Filterable properties for the Filter parameter](https://docs.microsoft.com/powershell/exchange/filter-properties).</maml:para> <maml:para>- ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see about_Comparison_Operators (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators).</maml:para> <maml:para>- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values (for example, `500`, `$true`, `$false`, or `$null`).</maml:para> <maml:para>You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example, `"Criteria1 -and Criteria2"` or `"(Criteria1 -and Criteria2) -or Criteria3"`.</maml:para> <maml:para>For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrganizationalUnit</maml:name> <maml:Description> <maml:para>The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid 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:</maml:para> <maml:para>- Name</maml:para> <maml:para>- Canonical name</maml:para> <maml:para>- Distinguished name (DN)</maml:para> <maml:para>- GUID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Properties</maml:name> <maml:Description> <maml:para>The Properties parameter specifies the properties that are returned in the output of this cmdlet. You can specify multiple values separated by commas.</maml:para> <maml:para>For more information about the available properties, see Get-EXOCasMailbox property sets (https://docs.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exocasmailbox-property-sets).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PropertySets</maml:name> <maml:Description> <maml:para>The PropertySets parameter specifies a logical grouping of properties that are returned in the output of this cmdlet. Valid values are:</maml:para> <maml:para>- Minimum (this is the default value)</maml:para> <maml:para>- ActiveSync</maml:para> <maml:para>- Ews</maml:para> <maml:para>- Imap</maml:para> <maml:para>- Mapi</maml:para> <maml:para>- Pop</maml:para> <maml:para>- ProtocolSettings</maml:para> <maml:para>- All</maml:para> <maml:para>You can specify multiple values separated by commas.</maml:para> <maml:para>For more information about the properties that are included in each property set, see Get-EXOCasMailbox property sets (https://docs.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exocasmailbox-property-sets).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PropertySet[]</command:parameterValue> <dev:type> <maml:name>PropertySet[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ProtocolSettings</maml:name> <maml:Description> <maml:para>The ProtocolSettings switch returns the server names, TCP ports and encryption methods for the following settings:</maml:para> <maml:para>- ExternalImapSettings</maml:para> <maml:para>- InternalImapSettings</maml:para> <maml:para>- ExternalPopSettings</maml:para> <maml:para>- InternalPopSettings</maml:para> <maml:para>- ExternalSmtpSettings</maml:para> <maml:para>- InternalSmtpSettings</maml:para> <maml:para>To see these values, you need to use a formatting cmdlet. For example, Get-CasMailbox laura@contoso.com -ProtocolSettings | Format-List.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResultSize</maml:name> <maml:Description> <maml:para>The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Unlimited</command:parameterValue> <dev:type> <maml:name>Unlimited</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>UserPrincipalName</maml:name> <maml:Description> <maml:para>The UserPrincipalName parameter specifies the UPN for the mailbox you want to view (for example, navin.contoso.com).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> </dev:type> <maml:description> <maml:para>The following Input parameters are not supported in Get-EXOCasMailbox:</maml:para> <maml:para>- IgnoreDefaultScope</maml:para> <maml:para>- ReadIsOptimizedForAccessibility</maml:para> <maml:para>- SortBy</maml:para> <maml:para>- GetImapProtocolLog</maml:para> <maml:para>- GetPopProtocolLog</maml:para> <maml:para>- SendLogsTo</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> </dev:type> <maml:description> <maml:para>The following properties are removed by design from Get-EXOCasMailbox output:</maml:para> <maml:para>- RunspaceId</maml:para> <maml:para>- Servername</maml:para> <maml:para>- OriginatingServer</maml:para> <maml:para>- IsValid</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-EXOCASMailbox -Identity "JeffHay@contoso.com"</dev:code> <dev:remarks> <maml:para>This example returns the values of the following client access settings for the user with Identity Jeffhay@contoso.com:</maml:para> <maml:para>- ActiveSyncEnabled</maml:para> <maml:para>- EwsEnabled</maml:para> <maml:para>- OWAEnabled</maml:para> <maml:para>- PopEnabled</maml:para> <maml:para>- ImapEnabled</maml:para> <maml:para>- MAPIEnabled</maml:para> <maml:para>- ECPEnabled</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/powershell/module/exchange/get-exocasmailbox</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-EXOMailbox</command:name> <command:verb>Get</command:verb> <command:noun>EXOMailbox</command:noun> <maml:description> <maml:para>This cmdlet is available only in the Exchange Online PowerShell V2 module. For more information, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell).</maml:para> <maml:para>Use the Get-EXOMailbox cmdlet to view mailbox objects and attributes, populate property pages, or supply mailbox information to other tasks.</maml:para> <maml:para>For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>By default, this cmdlet returns a summary list (a minimum set of properties) of all mailboxes in your organization.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-EXOMailbox</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Identity</maml:name> <maml:Description> <maml:para>The Identity parameter specifies the mailbox you want to view. For the best performance, we recommend using the following values to identify the mailbox:</maml:para> <maml:para>- User ID or user principal name (UPN)</maml:para> <maml:para>- GUID</maml:para> <maml:para>Otherwise, you can use any value that uniquely identifies the mailbox. For example:</maml:para> <maml:para>- Name</maml:para> <maml:para>- Alias</maml:para> <maml:para>- Distinguished name (DN)</maml:para> <maml:para>- <domain name>\<account name></maml:para> <maml:para>- Email address</maml:para> <maml:para>- LegacyExchangeDN</maml:para> <maml:para>- SamAccountName</maml:para> <maml:para>You can't use this parameter with the Anr parameter.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Archive</maml:name> <maml:Description> <maml:para>The Archive switch filters the results by mailboxes that have an archive enabled (only mailboxes that have an archive mailbox are returned). You don't need to specify a value with this switch.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>ExternalDirectoryObjectId</maml:name> <maml:Description> <maml:para>The ExternalDirectoryObjectId parameter identifies the mailbox you want to view by using the ObjectId of the mailbox in Azure Active Directory. You can use this value instead of the Identity parameter.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:Description> <maml:para>The Filter parameter uses OPath syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`.</maml:para> <maml:para>- Enclose the whole OPath filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables.</maml:para> <maml:para>- Property is a filterable property. For more information about the filterable properties, see Get-EXOMailbox property sets (https://docs.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exomailbox-property-sets) and [Filterable properties for the Filter parameter](https://docs.microsoft.com/powershell/exchange/filter-properties).</maml:para> <maml:para>- ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see about_Comparison_Operators (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators).</maml:para> <maml:para>- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values (for example, `500`, `$true`, `$false`, or `$null`).</maml:para> <maml:para>You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example, `"Criteria1 -and Criteria2"` or `"(Criteria1 -and Criteria2) -or Criteria3"`.</maml:para> <maml:para>For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>InactiveMailboxOnly</maml:name> <maml:Description> <maml:para>The InactiveMailboxOnly switch specifies whether to return only inactive mailboxes in the results. You don't need to specify a value with this switch.</maml:para> <maml:para>An inactive mailbox is a mailbox that's placed on Litigation Hold or In-Place Hold before it's soft-deleted. The contents of an inactive mailbox are preserved until the hold is removed.</maml:para> <maml:para>To return both active mailboxes and inactive mailboxes in the results, don't use this switch. Instead, use the IncludeInactiveMailbox switch.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeInactiveMailbox</maml:name> <maml:Description> <maml:para>The IncludeInactiveMailbox switch specifies whether to include inactive mailboxes in the results. You don't need to specify a value with this switch.</maml:para> <maml:para>An inactive mailbox is a mailbox that's placed on Litigation Hold or In-Place Hold before it's soft-deleted. The contents of an inactive mailbox are preserved until the hold is removed.</maml:para> <maml:para>To return only inactive mailboxes in the results, don't use this switch. Instead, use the InactiveMailboxOnly switch.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MailboxPlan</maml:name> <maml:Description> <maml:para>The MailboxPlan parameter filters the results by mailbox plan. When you use this parameter, only mailboxes that are assigned the specified mailbox plan are returned in the results. You can use any value that uniquely identifies the mailbox plan. For example:</maml:para> <maml:para>- Name</maml:para> <maml:para>- Alias</maml:para> <maml:para>- Display name</maml:para> <maml:para>- Distinguished name (DN)</maml:para> <maml:para>- GUID</maml:para> <maml:para>A mailbox plan specifies the permissions and features available to a mailbox user in cloud-based organizations. You can see the available mailbox plans by using the Get-MailboxPlan cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrganizationalUnit</maml:name> <maml:Description> <maml:para>The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid 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:</maml:para> <maml:para>- Name</maml:para> <maml:para>- Canonical name</maml:para> <maml:para>- Distinguished name (DN)</maml:para> <maml:para>- GUID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Properties</maml:name> <maml:Description> <maml:para>The Properties parameter specifies the properties that are returned in the output of this cmdlet. You can specify multiple values separated by commas.</maml:para> <maml:para>For more information about the available properties, see Get-EXOMailbox property sets (https://docs.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exomailbox-property-sets).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PropertySets</maml:name> <maml:Description> <maml:para>The PropertySets parameter specifies a logical grouping of properties that are returned in the output of this cmdlet. Valid values are:</maml:para> <maml:para>- All</maml:para> <maml:para>- Minimum (this is the default value)</maml:para> <maml:para>- AddressList</maml:para> <maml:para>- Archive</maml:para> <maml:para>- Audit</maml:para> <maml:para>- Custom</maml:para> <maml:para>- Delivery</maml:para> <maml:para>- Hold</maml:para> <maml:para>- Moderation</maml:para> <maml:para>- Move</maml:para> <maml:para>- Policy</maml:para> <maml:para>- PublicFolder</maml:para> <maml:para>- Quota</maml:para> <maml:para>- Resource</maml:para> <maml:para>- Retention</maml:para> <maml:para>- SCL</maml:para> <maml:para>- SoftDelete</maml:para> <maml:para>- StatisticsSeed</maml:para> <maml:para>You can specify multiple values separated by commas.</maml:para> <maml:para>For more information about the properties that are included in each property set, see Get-EXOMailbox property sets (https://docs.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exomailbox-property-sets).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PropertySet[]</command:parameterValue> <dev:type> <maml:name>PropertySet[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RecipientTypeDetails</maml:name> <maml:Description> <maml:para>The RecipientTypeDetails parameter filters the results by the specified mailbox subtype. Valid values are:</maml:para> <maml:para>- DiscoveryMailbox</maml:para> <maml:para>- EquipmentMailbox</maml:para> <maml:para>- GroupMailbox</maml:para> <maml:para>- LegacyMailbox</maml:para> <maml:para>- LinkedMailbox</maml:para> <maml:para>- LinkedRoomMailbox</maml:para> <maml:para>- RoomMailbox</maml:para> <maml:para>- SchedulingMailbox</maml:para> <maml:para>- SharedMailbox</maml:para> <maml:para>- TeamMailbox</maml:para> <maml:para>- UserMailbox</maml:para> <maml:para>You can specify multiple values separated by commas.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResultSize</maml:name> <maml:Description> <maml:para>The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Unlimited</command:parameterValue> <dev:type> <maml:name>Unlimited</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SoftDeletedMailbox</maml:name> <maml:Description> <maml:para>The SoftDeletedMailbox switch is required to return soft-deleted mailboxes in the results. You don't need to specify a value with this switch.</maml:para> <maml:para>Soft-deleted mailboxes are deleted mailboxes that are still recoverable.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>UserPrincipalName</maml:name> <maml:Description> <maml:para>The UserPrincipalName parameter specifies the UPN for the mailbox you want to view (for example, navin.contoso.com).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-EXOMailbox</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Anr</maml:name> <maml:Description> <maml:para>The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are:</maml:para> <maml:para>- CommonName (CN)</maml:para> <maml:para>- DisplayName</maml:para> <maml:para>- FirstName</maml:para> <maml:para>- LastName</maml:para> <maml:para>- Alias</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Archive</maml:name> <maml:Description> <maml:para>The Archive switch filters the results by mailboxes that have an archive enabled (only mailboxes that have an archive mailbox are returned). You don't need to specify a value with this switch.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:Description> <maml:para>The Filter parameter uses OPath syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`.</maml:para> <maml:para>- Enclose the whole OPath filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables.</maml:para> <maml:para>- Property is a filterable property. For more information about the filterable properties, see Get-EXOMailbox property sets (https://docs.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exomailbox-property-sets) and [Filterable properties for the Filter parameter](https://docs.microsoft.com/powershell/exchange/filter-properties).</maml:para> <maml:para>- ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see about_Comparison_Operators (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators).</maml:para> <maml:para>- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values (for example, `500`, `$true`, `$false`, or `$null`).</maml:para> <maml:para>You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example, `"Criteria1 -and Criteria2"` or `"(Criteria1 -and Criteria2) -or Criteria3"`.</maml:para> <maml:para>For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>InactiveMailboxOnly</maml:name> <maml:Description> <maml:para>The InactiveMailboxOnly switch specifies whether to return only inactive mailboxes in the results. You don't need to specify a value with this switch.</maml:para> <maml:para>An inactive mailbox is a mailbox that's placed on Litigation Hold or In-Place Hold before it's soft-deleted. The contents of an inactive mailbox are preserved until the hold is removed.</maml:para> <maml:para>To return both active mailboxes and inactive mailboxes in the results, don't use this switch. Instead, use the IncludeInactiveMailbox switch.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeInactiveMailbox</maml:name> <maml:Description> <maml:para>The IncludeInactiveMailbox switch specifies whether to include inactive mailboxes in the results. You don't need to specify a value with this switch.</maml:para> <maml:para>An inactive mailbox is a mailbox that's placed on Litigation Hold or In-Place Hold before it's soft-deleted. The contents of an inactive mailbox are preserved until the hold is removed.</maml:para> <maml:para>To return only inactive mailboxes in the results, don't use this switch. Instead, use the InactiveMailboxOnly switch.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MailboxPlan</maml:name> <maml:Description> <maml:para>The MailboxPlan parameter filters the results by mailbox plan. When you use this parameter, only mailboxes that are assigned the specified mailbox plan are returned in the results. You can use any value that uniquely identifies the mailbox plan. For example:</maml:para> <maml:para>- Name</maml:para> <maml:para>- Alias</maml:para> <maml:para>- Display name</maml:para> <maml:para>- Distinguished name (DN)</maml:para> <maml:para>- GUID</maml:para> <maml:para>A mailbox plan specifies the permissions and features available to a mailbox user in cloud-based organizations. You can see the available mailbox plans by using the Get-MailboxPlan cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrganizationalUnit</maml:name> <maml:Description> <maml:para>The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid 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:</maml:para> <maml:para>- Name</maml:para> <maml:para>- Canonical name</maml:para> <maml:para>- Distinguished name (DN)</maml:para> <maml:para>- GUID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Properties</maml:name> <maml:Description> <maml:para>The Properties parameter specifies the properties that are returned in the output of this cmdlet. You can specify multiple values separated by commas.</maml:para> <maml:para>For more information about the available properties, see Get-EXOMailbox property sets (https://docs.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exomailbox-property-sets).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PropertySets</maml:name> <maml:Description> <maml:para>The PropertySets parameter specifies a logical grouping of properties that are returned in the output of this cmdlet. Valid values are:</maml:para> <maml:para>- All</maml:para> <maml:para>- Minimum (this is the default value)</maml:para> <maml:para>- AddressList</maml:para> <maml:para>- Archive</maml:para> <maml:para>- Audit</maml:para> <maml:para>- Custom</maml:para> <maml:para>- Delivery</maml:para> <maml:para>- Hold</maml:para> <maml:para>- Moderation</maml:para> <maml:para>- Move</maml:para> <maml:para>- Policy</maml:para> <maml:para>- PublicFolder</maml:para> <maml:para>- Quota</maml:para> <maml:para>- Resource</maml:para> <maml:para>- Retention</maml:para> <maml:para>- SCL</maml:para> <maml:para>- SoftDelete</maml:para> <maml:para>- StatisticsSeed</maml:para> <maml:para>You can specify multiple values separated by commas.</maml:para> <maml:para>For more information about the properties that are included in each property set, see Get-EXOMailbox property sets (https://docs.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exomailbox-property-sets).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PropertySet[]</command:parameterValue> <dev:type> <maml:name>PropertySet[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RecipientTypeDetails</maml:name> <maml:Description> <maml:para>The RecipientTypeDetails parameter filters the results by the specified mailbox subtype. Valid values are:</maml:para> <maml:para>- DiscoveryMailbox</maml:para> <maml:para>- EquipmentMailbox</maml:para> <maml:para>- GroupMailbox</maml:para> <maml:para>- LegacyMailbox</maml:para> <maml:para>- LinkedMailbox</maml:para> <maml:para>- LinkedRoomMailbox</maml:para> <maml:para>- RoomMailbox</maml:para> <maml:para>- SchedulingMailbox</maml:para> <maml:para>- SharedMailbox</maml:para> <maml:para>- TeamMailbox</maml:para> <maml:para>- UserMailbox</maml:para> <maml:para>You can specify multiple values separated by commas.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResultSize</maml:name> <maml:Description> <maml:para>The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Unlimited</command:parameterValue> <dev:type> <maml:name>Unlimited</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SoftDeletedMailbox</maml:name> <maml:Description> <maml:para>The SoftDeletedMailbox switch is required to return soft-deleted mailboxes in the results. You don't need to specify a value with this switch.</maml:para> <maml:para>Soft-deleted mailboxes are deleted mailboxes that are still recoverable.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Identity</maml:name> <maml:Description> <maml:para>The Identity parameter specifies the mailbox you want to view. For the best performance, we recommend using the following values to identify the mailbox:</maml:para> <maml:para>- User ID or user principal name (UPN)</maml:para> <maml:para>- GUID</maml:para> <maml:para>Otherwise, you can use any value that uniquely identifies the mailbox. For example:</maml:para> <maml:para>- Name</maml:para> <maml:para>- Alias</maml:para> <maml:para>- Distinguished name (DN)</maml:para> <maml:para>- <domain name>\<account name></maml:para> <maml:para>- Email address</maml:para> <maml:para>- LegacyExchangeDN</maml:para> <maml:para>- SamAccountName</maml:para> <maml:para>You can't use this parameter with the Anr parameter.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Anr</maml:name> <maml:Description> <maml:para>The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are:</maml:para> <maml:para>- CommonName (CN)</maml:para> <maml:para>- DisplayName</maml:para> <maml:para>- FirstName</maml:para> <maml:para>- LastName</maml:para> <maml:para>- Alias</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Archive</maml:name> <maml:Description> <maml:para>The Archive switch filters the results by mailboxes that have an archive enabled (only mailboxes that have an archive mailbox are returned). You don't need to specify a value with this switch.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>ExternalDirectoryObjectId</maml:name> <maml:Description> <maml:para>The ExternalDirectoryObjectId parameter identifies the mailbox you want to view by using the ObjectId of the mailbox in Azure Active Directory. You can use this value instead of the Identity parameter.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:Description> <maml:para>The Filter parameter uses OPath syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`.</maml:para> <maml:para>- Enclose the whole OPath filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables.</maml:para> <maml:para>- Property is a filterable property. For more information about the filterable properties, see Get-EXOMailbox property sets (https://docs.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exomailbox-property-sets) and [Filterable properties for the Filter parameter](https://docs.microsoft.com/powershell/exchange/filter-properties).</maml:para> <maml:para>- ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see about_Comparison_Operators (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators).</maml:para> <maml:para>- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values (for example, `500`, `$true`, `$false`, or `$null`).</maml:para> <maml:para>You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example, `"Criteria1 -and Criteria2"` or `"(Criteria1 -and Criteria2) -or Criteria3"`.</maml:para> <maml:para>For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>InactiveMailboxOnly</maml:name> <maml:Description> <maml:para>The InactiveMailboxOnly switch specifies whether to return only inactive mailboxes in the results. You don't need to specify a value with this switch.</maml:para> <maml:para>An inactive mailbox is a mailbox that's placed on Litigation Hold or In-Place Hold before it's soft-deleted. The contents of an inactive mailbox are preserved until the hold is removed.</maml:para> <maml:para>To return both active mailboxes and inactive mailboxes in the results, don't use this switch. Instead, use the IncludeInactiveMailbox switch.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeInactiveMailbox</maml:name> <maml:Description> <maml:para>The IncludeInactiveMailbox switch specifies whether to include inactive mailboxes in the results. You don't need to specify a value with this switch.</maml:para> <maml:para>An inactive mailbox is a mailbox that's placed on Litigation Hold or In-Place Hold before it's soft-deleted. The contents of an inactive mailbox are preserved until the hold is removed.</maml:para> <maml:para>To return only inactive mailboxes in the results, don't use this switch. Instead, use the InactiveMailboxOnly switch.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MailboxPlan</maml:name> <maml:Description> <maml:para>The MailboxPlan parameter filters the results by mailbox plan. When you use this parameter, only mailboxes that are assigned the specified mailbox plan are returned in the results. You can use any value that uniquely identifies the mailbox plan. For example:</maml:para> <maml:para>- Name</maml:para> <maml:para>- Alias</maml:para> <maml:para>- Display name</maml:para> <maml:para>- Distinguished name (DN)</maml:para> <maml:para>- GUID</maml:para> <maml:para>A mailbox plan specifies the permissions and features available to a mailbox user in cloud-based organizations. You can see the available mailbox plans by using the Get-MailboxPlan cmdlet.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrganizationalUnit</maml:name> <maml:Description> <maml:para>The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid 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:</maml:para> <maml:para>- Name</maml:para> <maml:para>- Canonical name</maml:para> <maml:para>- Distinguished name (DN)</maml:para> <maml:para>- GUID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Properties</maml:name> <maml:Description> <maml:para>The Properties parameter specifies the properties that are returned in the output of this cmdlet. You can specify multiple values separated by commas.</maml:para> <maml:para>For more information about the available properties, see Get-EXOMailbox property sets (https://docs.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exomailbox-property-sets).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PropertySets</maml:name> <maml:Description> <maml:para>The PropertySets parameter specifies a logical grouping of properties that are returned in the output of this cmdlet. Valid values are:</maml:para> <maml:para>- All</maml:para> <maml:para>- Minimum (this is the default value)</maml:para> <maml:para>- AddressList</maml:para> <maml:para>- Archive</maml:para> <maml:para>- Audit</maml:para> <maml:para>- Custom</maml:para> <maml:para>- Delivery</maml:para> <maml:para>- Hold</maml:para> <maml:para>- Moderation</maml:para> <maml:para>- Move</maml:para> <maml:para>- Policy</maml:para> <maml:para>- PublicFolder</maml:para> <maml:para>- Quota</maml:para> <maml:para>- Resource</maml:para> <maml:para>- Retention</maml:para> <maml:para>- SCL</maml:para> <maml:para>- SoftDelete</maml:para> <maml:para>- StatisticsSeed</maml:para> <maml:para>You can specify multiple values separated by commas.</maml:para> <maml:para>For more information about the properties that are included in each property set, see Get-EXOMailbox property sets (https://docs.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exomailbox-property-sets).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PropertySet[]</command:parameterValue> <dev:type> <maml:name>PropertySet[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RecipientTypeDetails</maml:name> <maml:Description> <maml:para>The RecipientTypeDetails parameter filters the results by the specified mailbox subtype. Valid values are:</maml:para> <maml:para>- DiscoveryMailbox</maml:para> <maml:para>- EquipmentMailbox</maml:para> <maml:para>- GroupMailbox</maml:para> <maml:para>- LegacyMailbox</maml:para> <maml:para>- LinkedMailbox</maml:para> <maml:para>- LinkedRoomMailbox</maml:para> <maml:para>- RoomMailbox</maml:para> <maml:para>- SchedulingMailbox</maml:para> <maml:para>- SharedMailbox</maml:para> <maml:para>- TeamMailbox</maml:para> <maml:para>- UserMailbox</maml:para> <maml:para>You can specify multiple values separated by commas.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResultSize</maml:name> <maml:Description> <maml:para>The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Unlimited</command:parameterValue> <dev:type> <maml:name>Unlimited</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SoftDeletedMailbox</maml:name> <maml:Description> <maml:para>The SoftDeletedMailbox switch is required to return soft-deleted mailboxes in the results. You don't need to specify a value with this switch.</maml:para> <maml:para>Soft-deleted mailboxes are deleted mailboxes that are still recoverable.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>UserPrincipalName</maml:name> <maml:Description> <maml:para>The UserPrincipalName parameter specifies the UPN for the mailbox you want to view (for example, navin.contoso.com).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> </dev:type> <maml:description> <maml:para>The following Get-Mailbox parameters aren't available in Get-EXOMailbox:</maml:para> <maml:para>- PublicFolder</maml:para> <maml:para>- GroupMailbox</maml:para> <maml:para>- Migration</maml:para> <maml:para>- SortBy</maml:para> <maml:para>- Async</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> </dev:type> <maml:description> <maml:para>The following properties aren't included in the output of Get-EXOMailbox:</maml:para> <maml:para>- RunspaceId</maml:para> <maml:para>- Servername</maml:para> <maml:para>- AdminDisplayVersion</maml:para> <maml:para>- DelayReleaseHoldApplied</maml:para> <maml:para>- EnforcedTimestamps</maml:para> <maml:para>- Description</maml:para> <maml:para>- OriginatingServer</maml:para> <maml:para>- IsValid</maml:para> <maml:para>- ObjectState</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-EXOMailbox -ResultSize unlimited</dev:code> <dev:remarks> <maml:para>This example returns a summary list of all mailboxes in the organization, and includes the default set of minimum output properties. To return additional properties, use the Properties and/or PropertySets parameters.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Get-EXOMailbox -PropertySets Archive</dev:code> <dev:remarks> <maml:para>This example returns the Properties that are defined in Archive property set. For a complete list of these properties, see Get-EXOMailbox property sets (https://docs.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exomailbox-property-sets).</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>Get-EXOMailbox -Properties Name,DistinguishedName,Guid -PropertySets Archive,Audit</dev:code> <dev:remarks> <maml:para>This example returns a summary list of all mailboxes in the organization, and includes the following properties:</maml:para> <maml:para>- The properties in Archive and Audit property sets.</maml:para> <maml:para>- The Name and DistinguishedName properties.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>Get-EXOMailbox -Identity John@contoso.com -Properties DisplayName,EmailAddresses,Alias</dev:code> <dev:remarks> <maml:para>This example returns the specified properties for the mailbox John@contoso.com.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/powershell/module/exchange/get-exomailbox</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-EXOMailboxFolderPermission</command:name> <command:verb>Get</command:verb> <command:noun>EXOMailboxFolderPermission</command:noun> <maml:description> <maml:para>This cmdlet is available only in the Exchange Online PowerShell V2 module. For more information, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell).</maml:para> <maml:para>Use the Get-ExOMailboxFolderPermission cmdlet to view folder-level permissions in mailboxes.</maml:para> <maml:para>For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Use this cmdlet to retrieve folder level permission in the mailbox. You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-EXOMailboxFolderPermission</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Identity</maml:name> <maml:Description> <maml:para>The Identity parameter specifies the mailbox folder that you want to view. This parameter uses the syntax: `<Mailbox>:<Folder>`. For the best performance, we recommend using the user ID or user principal name (UPN) to identify the mailbox.</maml:para> <maml:para>Otherwise, you can use any value that uniquely identifies the mailbox. For example:</maml:para> <maml:para>- Name</maml:para> <maml:para>- Alias</maml:para> <maml:para>- Distinguished name (DN)</maml:para> <maml:para>- Email address</maml:para> <maml:para>- LegacyExchangeDN</maml:para> <maml:para>- SamAccountName</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>ExternalDirectoryObjectId</maml:name> <maml:Description> <maml:para>The ExternalDirectoryObjectId parameter identifies the mailbox you want to view by using the ObjectId of the mailbox in Azure Active Directory. You can use this value instead of the Identity parameter.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>GroupMailbox</maml:name> <maml:Description> <maml:para>The GroupMailbox switch is required to return Microsoft 365 Groups in the results. You don't need to specify a value with this switch.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>User</maml:name> <maml:Description> <maml:para>The User parameter filters the results by the specified mailbox, mail user, or mail-enabled security group (security principal) that's granted permission to the mailbox folder. You can use any value that uniquely identifies the user or group. For example:</maml:para> <maml:para>- Name</maml:para> <maml:para>- Alias</maml:para> <maml:para>- Distinguished name (DN)</maml:para> <maml:para>- Canonical DN</maml:para> <maml:para>- Email address</maml:para> <maml:para>- GUID Note : If you specify a user that doesn't have permission to access the mailbox folder, the command will throw an exception.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>UserPrincipalName</maml:name> <maml:Description> <maml:para>The UserPrincipalName parameter specifies the UPN for the mailbox you want to view (for example, navin.contoso.com).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Identity</maml:name> <maml:Description> <maml:para>The Identity parameter specifies the mailbox folder that you want to view. This parameter uses the syntax: `<Mailbox>:<Folder>`. For the best performance, we recommend using the user ID or user principal name (UPN) to identify the mailbox.</maml:para> <maml:para>Otherwise, you can use any value that uniquely identifies the mailbox. For example:</maml:para> <maml:para>- Name</maml:para> <maml:para>- Alias</maml:para> <maml:para>- Distinguished name (DN)</maml:para> <maml:para>- Email address</maml:para> <maml:para>- LegacyExchangeDN</maml:para> <maml:para>- SamAccountName</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>ExternalDirectoryObjectId</maml:name> <maml:Description> <maml:para>The ExternalDirectoryObjectId parameter identifies the mailbox you want to view by using the ObjectId of the mailbox in Azure Active Directory. You can use this value instead of the Identity parameter.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>GroupMailbox</maml:name> <maml:Description> <maml:para>The GroupMailbox switch is required to return Microsoft 365 Groups in the results. You don't need to specify a value with this switch.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>User</maml:name> <maml:Description> <maml:para>The User parameter filters the results by the specified mailbox, mail user, or mail-enabled security group (security principal) that's granted permission to the mailbox folder. You can use any value that uniquely identifies the user or group. For example:</maml:para> <maml:para>- Name</maml:para> <maml:para>- Alias</maml:para> <maml:para>- Distinguished name (DN)</maml:para> <maml:para>- Canonical DN</maml:para> <maml:para>- Email address</maml:para> <maml:para>- GUID Note : If you specify a user that doesn't have permission to access the mailbox folder, the command will throw an exception.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>UserPrincipalName</maml:name> <maml:Description> <maml:para>The UserPrincipalName parameter specifies the UPN for the mailbox you want to view (for example, navin.contoso.com).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-EXOMailboxFolderPermission -Identity john@contoso.com:\Marketing\Reports</dev:code> <dev:remarks> <maml:para>This example returns the current list of user permissions for the Reports subfolder in the Marketing folder in John's mailbox.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Get-EXOMailboxFolderPermission -Identity john@contoso.com:\Marketing\Reports -User Kim@contoso.com</dev:code> <dev:remarks> <maml:para>This example returns the permissions for the same folder in John's mailbox, but only for the user Kim.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/powershell/module/exchange/get-exomailboxfolderpermission</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-MailboxFolderPermission</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-MailboxFolderPermission</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-MailboxFolderPermission</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-MailboxFolderPermission</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-EXOMailboxFolderStatistics</command:name> <command:verb>Get</command:verb> <command:noun>EXOMailboxFolderStatistics</command:noun> <maml:description> <maml:para>This cmdlet is available only in the Exchange Online PowerShell V2 module. For more information, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell).</maml:para> <maml:para>Use the Get-EXOMailboxFolderStatistics cmdlet to retrieve information about the folders in a specified mailbox, including the number and size of items in the folder, the folder name and ID, and other information.</maml:para> <maml:para>For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>A mailbox can have hidden items that are never visible to the user and are only used by applications. The Get-EXOMailboxFolderStatistics cmdlet can return hidden items for the following values: FolderSize, FolderAndSubfolderSize, ItemsInFolder and ItemsInFolderAndSubfolders.</maml:para> <maml:para>Don't confuse Get-EXOMailboxFolderStatistics cmdlet (folders) with the Get-EXOMailboxStatistics cmdlet (mailboxes).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-EXOMailboxFolderStatistics</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Archive</maml:name> <maml:Description> <maml:para>The Archive switch specifies whether to return the usage statistics of the archive mailbox that's associated with the mailbox or mail user. You don't need to specify a value with this switch.</maml:para> <maml:para>If you use this switch on a mailbox that doesn't have archiving enabled, an error is returned.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>ExternalDirectoryObjectId</maml:name> <maml:Description> <maml:para>The ExternalDirectoryObjectId parameter identifies the mailbox you want to view by using the ObjectId of the mailbox in Azure Active Directory. You can use this value instead of the Identity parameter.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Folderscope</maml:name> <maml:Description> <maml:para>The FolderScope parameter specifies the scope of the search by folder type. Valid values include:</maml:para> <maml:para>- All</maml:para> <maml:para>- Archive</maml:para> <maml:para>- Calendar</maml:para> <maml:para>- Clutter</maml:para> <maml:para>- Contacts</maml:para> <maml:para>- ConversationHistory</maml:para> <maml:para>- DeletedItems</maml:para> <maml:para>- Drafts</maml:para> <maml:para>- Inbox</maml:para> <maml:para>- Journal</maml:para> <maml:para>- JunkEmail</maml:para> <maml:para>- LegacyArchiveJournals</maml:para> <maml:para>- ManagedCustomFolder</maml:para> <maml:para>- NonIpmRoot</maml:para> <maml:para>- Notes</maml:para> <maml:para>- Outbox</maml:para> <maml:para>- Personal</maml:para> <maml:para>- RecoverableItems</maml:para> <maml:para>- RssSubscriptions</maml:para> <maml:para>- SentItems</maml:para> <maml:para>- SyncIssues</maml:para> <maml:para>- Tasks</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ElcFolderType</command:parameterValue> <dev:type> <maml:name>ElcFolderType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Identity</maml:name> <maml:Description> <maml:para>The Identity parameter specifies the identity of the mailbox or mail user. For the best performance, we recommend using the user ID or user principal name (UPN) to identify the mailbox.</maml:para> <maml:para>Otherwise, you can use any value that uniquely identifies the mailbox or mail user. For example:</maml:para> <maml:para>- Name</maml:para> <maml:para>- Alias</maml:para> <maml:para>- Distinguished name (DN)</maml:para> <maml:para>- LegacyExchangeDN</maml:para> <maml:para>- SamAccountName</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeOldestAndNewestItems</maml:name> <maml:Description> <maml:para>The IncludeOldestAndNewestItems switch specifies whether to return the dates of the oldest and newest items in each folder. You don't need to specify a value with this switch.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeSoftDeletedRecipients</maml:name> <maml:Description> <maml:para>The IncludeSoftDeletedRecipients switch specifies whether to include soft-deleted mailboxes in the results. You don't need to specify a value with this switch.</maml:para> <maml:para>Soft-deleted mailboxes are mailboxes that have been deleted, but are still recoverable.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>UserPrincipalName</maml:name> <maml:Description> <maml:para>The UserPrincipalName parameter specifies the UPN for the mailbox you want to view (for example, navin.contoso.com).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Archive</maml:name> <maml:Description> <maml:para>The Archive switch specifies whether to return the usage statistics of the archive mailbox that's associated with the mailbox or mail user. You don't need to specify a value with this switch.</maml:para> <maml:para>If you use this switch on a mailbox that doesn't have archiving enabled, an error is returned.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>ExternalDirectoryObjectId</maml:name> <maml:Description> <maml:para>The ExternalDirectoryObjectId parameter identifies the mailbox you want to view by using the ObjectId of the mailbox in Azure Active Directory. You can use this value instead of the Identity parameter.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Folderscope</maml:name> <maml:Description> <maml:para>The FolderScope parameter specifies the scope of the search by folder type. Valid values include:</maml:para> <maml:para>- All</maml:para> <maml:para>- Archive</maml:para> <maml:para>- Calendar</maml:para> <maml:para>- Clutter</maml:para> <maml:para>- Contacts</maml:para> <maml:para>- ConversationHistory</maml:para> <maml:para>- DeletedItems</maml:para> <maml:para>- Drafts</maml:para> <maml:para>- Inbox</maml:para> <maml:para>- Journal</maml:para> <maml:para>- JunkEmail</maml:para> <maml:para>- LegacyArchiveJournals</maml:para> <maml:para>- ManagedCustomFolder</maml:para> <maml:para>- NonIpmRoot</maml:para> <maml:para>- Notes</maml:para> <maml:para>- Outbox</maml:para> <maml:para>- Personal</maml:para> <maml:para>- RecoverableItems</maml:para> <maml:para>- RssSubscriptions</maml:para> <maml:para>- SentItems</maml:para> <maml:para>- SyncIssues</maml:para> <maml:para>- Tasks</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ElcFolderType</command:parameterValue> <dev:type> <maml:name>ElcFolderType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Identity</maml:name> <maml:Description> <maml:para>The Identity parameter specifies the identity of the mailbox or mail user. For the best performance, we recommend using the user ID or user principal name (UPN) to identify the mailbox.</maml:para> <maml:para>Otherwise, you can use any value that uniquely identifies the mailbox or mail user. For example:</maml:para> <maml:para>- Name</maml:para> <maml:para>- Alias</maml:para> <maml:para>- Distinguished name (DN)</maml:para> <maml:para>- LegacyExchangeDN</maml:para> <maml:para>- SamAccountName</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeOldestAndNewestItems</maml:name> <maml:Description> <maml:para>The IncludeOldestAndNewestItems switch specifies whether to return the dates of the oldest and newest items in each folder. You don't need to specify a value with this switch.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeSoftDeletedRecipients</maml:name> <maml:Description> <maml:para>The IncludeSoftDeletedRecipients switch specifies whether to include soft-deleted mailboxes in the results. You don't need to specify a value with this switch.</maml:para> <maml:para>Soft-deleted mailboxes are mailboxes that have been deleted, but are still recoverable.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>UserPrincipalName</maml:name> <maml:Description> <maml:para>The UserPrincipalName parameter specifies the UPN for the mailbox you want to view (for example, navin.contoso.com).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-EXOMailboxFolderStatistics -Identity admin@contoso.com</dev:code> <dev:remarks> <maml:para>This example returns statistics for all mailbox folders. Default is FolderScope All.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Get-EXOMailboxFolderStatistics -Identity admin@contoso.com -FolderScope Calendar -IncludeAnalysis -IncludeOldestAndNewestItems</dev:code> <dev:remarks> <maml:para>This example returns statistics only for calendar folders.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/powershell/module/exchange/get-exomailboxfolderstatistics</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-EXOMailboxPermission</command:name> <command:verb>Get</command:verb> <command:noun>EXOMailboxPermission</command:noun> <maml:description> <maml:para>This cmdlet is available only in the Exchange Online PowerShell V2 module. For more information, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell).</maml:para> <maml:para>Use the Get-EXOMailboxPermission cmdlet to retrieve permissions on a mailbox.</maml:para> <maml:para>For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The output of this cmdlet shows the following information:</maml:para> <maml:para>Identity: The mailbox in question.</maml:para> <maml:para>User: The security principal (user, security group, Exchange management role group, etc.) that has permission to the mailbox.</maml:para> <maml:para>AccessRights: The permission that the security principal has on the mailbox. The available values are ChangeOwner (change the owner of the mailbox), ChangePermission (change the permissions on the mailbox), DeleteItem (delete the mailbox), ExternalAccount (indicates the account isn't in the same domain), FullAccess (open the mailbox, access its contents, but can't send mail) and ReadPermission (read the permissions on the mailbox). Whether the permissions are allowed or denied is indicated in the Deny column.</maml:para> <maml:para>IsInherited: Whether the permission is inherited (True) or directly assigned to the mailbox (False). Permissions are inherited from the mailbox database and/or Active Directory. Typically, directly assigned permissions override inherited permissions.</maml:para> <maml:para>Deny: Whether the permission is allowed (False) or denied (True). Typically, deny permissions override allow permissions.</maml:para> <maml:para>By default, the following permissions are assigned to user mailboxes:</maml:para> <maml:para>FullAccess and ReadPermission are directly assigned to NT AUTHORITY\SELF. This entry gives a user permission to their own mailbox.</maml:para> <maml:para>FullAccess is denied to Administrator, Domain Admins, Enterprise Admins and Organization Management. These inherited permissions prevent these users and group members from opening other users' mailboxes.</maml:para> <maml:para>ChangeOwner, ChangePermission, DeleteItem, and ReadPermission are allowed for Administrator, Domain Admins, Enterprise Admins and Organization Management. Note that these inherited permission entries also appear to allow FullAccess. However, these users and groups do not have FullAccess to the mailbox because the inherited Deny permission entries override the inherited Allow permission entries.</maml:para> <maml:para>FullAccess is inherited by NT AUTHORITY\SYSTEM and ReadPermission is inherited by NT AUTHORITY\NETWORK.</maml:para> <maml:para>FullAccess and ReadPermission are inherited by Exchange Servers, ChangeOwner, ChangePermission, DeleteItem, and ReadPermission are inherited by Exchange Trusted Subsystem and ReadPermission is inherited by Managed Availability Servers.</maml:para> <maml:para>By default, other security groups and role groups inherit permissions to mailboxes based on their location (on-premises Exchange or Microsoft 365).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-EXOMailboxPermission</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>ExternalDirectoryObjectId</maml:name> <maml:Description> <maml:para>The ExternalDirectoryObjectId parameter identifies the mailbox you want to view by using the ObjectId of the mailbox in Azure Active Directory. You can use this value instead of the Identity parameter.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Identity</maml:name> <maml:Description> <maml:para>The Identity parameter specifies the mailbox you want to view. For the best performance, we recommend using the user ID or user principal name (UPN) to identify the mailbox.</maml:para> <maml:para>Otherwise, you can use any value that uniquely identifies the mailbox. For example:</maml:para> <maml:para>- Name</maml:para> <maml:para>- Alias</maml:para> <maml:para>- Distinguished name (DN)</maml:para> <maml:para>- LegacyExchangeDN</maml:para> <maml:para>- SamAccountName</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Owner</maml:name> <maml:Description> <maml:para>The Owner switch returns the owner information for the mailbox that's specified by the Identity parameter. You don't need to specify a value with this switch.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResultSize</maml:name> <maml:Description> <maml:para>The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Unlimited</command:parameterValue> <dev:type> <maml:name>Unlimited</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SoftDeletedMailbox</maml:name> <maml:Description> <maml:para>The SoftDeletedMailbox switch is required to return soft-deleted mailboxes in the results. You don't need to specify a value with this switch.</maml:para> <maml:para>Soft-deleted mailboxes are deleted mailboxes that are still recoverable.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>User</maml:name> <maml:Description> <maml:para>The User parameter returns information about the user who has permissions to the mailbox specified by the Identity parameter.</maml:para> <maml:para>The user that you specify for this parameter must be a user or security group (a security principal that can have permissions assigned). You can use any value that uniquely identifies the user. For example: For example:</maml:para> <maml:para>- Name</maml:para> <maml:para>- Distinguished name (DN)</maml:para> <maml:para>- Canonical DN</maml:para> <maml:para>- GUID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>UserPrincipalName</maml:name> <maml:Description> <maml:para>The UserPrincipalName parameter specifies the UPN for the mailbox you want to view (for example, navin.contoso.com).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>ExternalDirectoryObjectId</maml:name> <maml:Description> <maml:para>The ExternalDirectoryObjectId parameter identifies the mailbox you want to view by using the ObjectId of the mailbox in Azure Active Directory. You can use this value instead of the Identity parameter.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Identity</maml:name> <maml:Description> <maml:para>The Identity parameter specifies the mailbox you want to view. For the best performance, we recommend using the user ID or user principal name (UPN) to identify the mailbox.</maml:para> <maml:para>Otherwise, you can use any value that uniquely identifies the mailbox. For example:</maml:para> <maml:para>- Name</maml:para> <maml:para>- Alias</maml:para> <maml:para>- Distinguished name (DN)</maml:para> <maml:para>- LegacyExchangeDN</maml:para> <maml:para>- SamAccountName</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Owner</maml:name> <maml:Description> <maml:para>The Owner switch returns the owner information for the mailbox that's specified by the Identity parameter. You don't need to specify a value with this switch.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResultSize</maml:name> <maml:Description> <maml:para>The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Unlimited</command:parameterValue> <dev:type> <maml:name>Unlimited</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SoftDeletedMailbox</maml:name> <maml:Description> <maml:para>The SoftDeletedMailbox switch is required to return soft-deleted mailboxes in the results. You don't need to specify a value with this switch.</maml:para> <maml:para>Soft-deleted mailboxes are deleted mailboxes that are still recoverable.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>User</maml:name> <maml:Description> <maml:para>The User parameter returns information about the user who has permissions to the mailbox specified by the Identity parameter.</maml:para> <maml:para>The user that you specify for this parameter must be a user or security group (a security principal that can have permissions assigned). You can use any value that uniquely identifies the user. For example: For example:</maml:para> <maml:para>- Name</maml:para> <maml:para>- Distinguished name (DN)</maml:para> <maml:para>- Canonical DN</maml:para> <maml:para>- GUID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>UserPrincipalName</maml:name> <maml:Description> <maml:para>The UserPrincipalName parameter specifies the UPN for the mailbox you want to view (for example, navin.contoso.com).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-EXOMailboxPermission -Identity john@contoso.com</dev:code> <dev:remarks> <maml:para>This example return the permission the user has on mailboxes</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/powershell/module/exchange/get-exomailboxpermission</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-EXOMailboxStatistics</command:name> <command:verb>Get</command:verb> <command:noun>EXOMailboxStatistics</command:noun> <maml:description> <maml:para>This cmdlet is available only in the Exchange Online PowerShell V2 module. For more information, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell).</maml:para> <maml:para>Use the Get-EXOMailboxStatistics cmdlet to return information about a mailbox, such as the size of the mailbox, the number of messages it contains, and the last time it was accessed.</maml:para> <maml:para>For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>You can use the detailed move history and a move report output from this cmdlet to troubleshoot a move request. To view the move history, you must pass this cmdlet as an object. Move histories are retained in the mailbox database, are numbered incrementally, and the last run move request is always numbered 0.</maml:para> <maml:para>You can only see move reports and move history for completed move requests.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-EXOMailboxStatistics</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Archive</maml:name> <maml:Description> <maml:para>The Archive switch parameter specifies whether to return mailbox statistics for the archive mailbox associated with the specified mailbox. You don't need to specify a value with this switch.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>DatabaseGuid</maml:name> <maml:Description> <maml:para>The DatabaseGuid parameter filters the results by the GUID of mailbox database that hosts the Mailbox. You can find this property value by using the Get-EXOMailbox cmdlet with the Properties parameter value DatabaseGuid.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>ExchangeGuid</maml:name> <maml:Description> <maml:para>The ExchangeGuid parameter filters the results by the GUID of mailbox (aso known as the Mailbox GUID). You can find this property value by using the Get-EXOMailbox cmdlet with Properies filter set to ExchangeGuid.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Identity</maml:name> <maml:Description> <maml:para>The Identity parameter specifies the mailbox you want to return statistics for. For the best performance, we recommend using the following values to identify the mailbox:</maml:para> <maml:para>- User ID or user principal name (UPN)</maml:para> <maml:para>- GUID</maml:para> <maml:para>Otherwise, you can use any value that uniquely identifies the mailbox. For example:</maml:para> <maml:para>- Name</maml:para> <maml:para>- Alias</maml:para> <maml:para>- Distinguished name (DN)</maml:para> <maml:para>- <domain name>\<account name></maml:para> <maml:para>- Email address</maml:para> <maml:para>- LegacyExchangeDN</maml:para> <maml:para>- SamAccountName</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeSoftDeletedRecipients</maml:name> <maml:Description> <maml:para>The IncludeSoftDeletedRecipients switch specifies whether to include soft deleted recipients in the results. You don't need to specify a value with this switch.</maml:para> <maml:para>Soft-deleted recipients are deleted recipients that are still recoverable.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Properties</maml:name> <maml:Description> <maml:para>The Properties parameter specifies the properties that are returned in the output of this cmdlet. You can specify multiple values separated by commas.</maml:para> <maml:para>For more information about the available properties, see Get-EXOMailboxStatistics property sets (https://docs.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exomailboxstatistics-property-sets).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PropertySets</maml:name> <maml:Description> <maml:para>The PropertySets parameter specifies a logical grouping of properties that are returned in the output of this cmdlet. Valid values are:</maml:para> <maml:para>- Minimum (this is the default value)</maml:para> <maml:para>- All</maml:para> <maml:para>You can specify multiple values separated by commas.</maml:para> <maml:para>For more information about the properties that are included in each property set, see Get-EXOMailboxStatistics property sets (https://docs.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exomailboxstatistics-property-sets).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PropertySet[]</command:parameterValue> <dev:type> <maml:name>PropertySet[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>UserPrincipalName</maml:name> <maml:Description> <maml:para>The UserPrincipalName parameter specifies the UPN for the mailbox you want to view (for example, navin.contoso.com).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Archive</maml:name> <maml:Description> <maml:para>The Archive switch parameter specifies whether to return mailbox statistics for the archive mailbox associated with the specified mailbox. You don't need to specify a value with this switch.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>DatabaseGuid</maml:name> <maml:Description> <maml:para>The DatabaseGuid parameter filters the results by the GUID of mailbox database that hosts the Mailbox. You can find this property value by using the Get-EXOMailbox cmdlet with the Properties parameter value DatabaseGuid.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>ExchangeGuid</maml:name> <maml:Description> <maml:para>The ExchangeGuid parameter filters the results by the GUID of mailbox (aso known as the Mailbox GUID). You can find this property value by using the Get-EXOMailbox cmdlet with Properies filter set to ExchangeGuid.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>Identity</maml:name> <maml:Description> <maml:para>The Identity parameter specifies the mailbox you want to return statistics for. For the best performance, we recommend using the following values to identify the mailbox:</maml:para> <maml:para>- User ID or user principal name (UPN)</maml:para> <maml:para>- GUID</maml:para> <maml:para>Otherwise, you can use any value that uniquely identifies the mailbox. For example:</maml:para> <maml:para>- Name</maml:para> <maml:para>- Alias</maml:para> <maml:para>- Distinguished name (DN)</maml:para> <maml:para>- <domain name>\<account name></maml:para> <maml:para>- Email address</maml:para> <maml:para>- LegacyExchangeDN</maml:para> <maml:para>- SamAccountName</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeSoftDeletedRecipients</maml:name> <maml:Description> <maml:para>The IncludeSoftDeletedRecipients switch specifies whether to include soft deleted recipients in the results. You don't need to specify a value with this switch.</maml:para> <maml:para>Soft-deleted recipients are deleted recipients that are still recoverable.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Properties</maml:name> <maml:Description> <maml:para>The Properties parameter specifies the properties that are returned in the output of this cmdlet. You can specify multiple values separated by commas.</maml:para> <maml:para>For more information about the available properties, see Get-EXOMailboxStatistics property sets (https://docs.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exomailboxstatistics-property-sets).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PropertySets</maml:name> <maml:Description> <maml:para>The PropertySets parameter specifies a logical grouping of properties that are returned in the output of this cmdlet. Valid values are:</maml:para> <maml:para>- Minimum (this is the default value)</maml:para> <maml:para>- All</maml:para> <maml:para>You can specify multiple values separated by commas.</maml:para> <maml:para>For more information about the properties that are included in each property set, see Get-EXOMailboxStatistics property sets (https://docs.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exomailboxstatistics-property-sets).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PropertySet[]</command:parameterValue> <dev:type> <maml:name>PropertySet[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>UserPrincipalName</maml:name> <maml:Description> <maml:para>The UserPrincipalName parameter specifies the UPN for the mailbox you want to view (for example, navin.contoso.com).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-EXOMailboxStatistics -Identity john@contoso.com</dev:code> <dev:remarks> <maml:para>This example retrieves the mailbox statistics for the specified mailbox. Only the minimum set of properties are returned.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Get-EXOMailboxStatistics -Identity john@contoso.com -Properties SystemMessageSize,SystemMessageSizeWarningQuota,SystemMessageCount</dev:code> <dev:remarks> <maml:para>This example retrieves the minimum set of properties and the specified properties for the specified mailbox.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/powershell/module/exchange/get-exomailboxstatistics</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-EXOMobileDeviceStatistics</command:name> <command:verb>Get</command:verb> <command:noun>EXOMobileDeviceStatistics</command:noun> <maml:description> <maml:para>This cmdlet is available only in the Exchange Online PowerShell V2 module. For more information, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell).</maml:para> <maml:para>Use the Get-EXOMobileDeviceStatistics cmdlet to retrieve the list of mobile devices configured to synchronize with a specified user's mailbox and return a list of statistics about the mobile devices.</maml:para> <maml:para>For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet returns a list of statistics about each mobile device. Additionally, it allows you to retrieve logs and send those logs to a recipient for troubleshooting purposes.</maml:para> <maml:para>You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-EXOMobileDeviceStatistics</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Mailbox</maml:name> <maml:Description> <maml:para>This input parameter acts as Identity filter. The Mailbox parameter filters the results by the user mailbox that's associated with the mobile device. You can use any value that uniquely identifies the mailbox. For example:</maml:para> <maml:para>- GUID</maml:para> <maml:para>- User ID or user principal name (UPN)</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ActiveSync</maml:name> <maml:Description> <maml:para>The ActiveSync switch filters the results by Exchange ActiveSync devices. You don't need to specify a value with this switch.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>ExternalDirectoryObjectId</maml:name> <maml:Description> <maml:para>The ExternalDirectoryObjectId parameter identifies the mailbox you want to view by using the ObjectId of the mailbox in Azure Active Directory. You can use this value instead of the Identity parameter.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OWAforDevices</maml:name> <maml:Description> <maml:para>The OWAforDevices switch filters the results by devices where Outlook on the web for devices is enabled. You don't need to specify a value with this switch.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RestApi</maml:name> <maml:Description> <maml:para>The RestApi switch filters the results by REST API devices. You don't need to specify a value with this switch.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>UniversalOutlook</maml:name> <maml:Description> <maml:para>The UniversalOutlook switch filters the results by Mail and Calendar devices. You don't need to specify a value with this switch.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>UserPrincipalName</maml:name> <maml:Description> <maml:para>The UserPrincipalName parameter specifies the UPN for the mailbox you want to view (for example, navin.contoso.com).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Mailbox</maml:name> <maml:Description> <maml:para>This input parameter acts as Identity filter. The Mailbox parameter filters the results by the user mailbox that's associated with the mobile device. You can use any value that uniquely identifies the mailbox. For example:</maml:para> <maml:para>- GUID</maml:para> <maml:para>- User ID or user principal name (UPN)</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ActiveSync</maml:name> <maml:Description> <maml:para>The ActiveSync switch filters the results by Exchange ActiveSync devices. You don't need to specify a value with this switch.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>ExternalDirectoryObjectId</maml:name> <maml:Description> <maml:para>The ExternalDirectoryObjectId parameter identifies the mailbox you want to view by using the ObjectId of the mailbox in Azure Active Directory. You can use this value instead of the Identity parameter.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OWAforDevices</maml:name> <maml:Description> <maml:para>The OWAforDevices switch filters the results by devices where Outlook on the web for devices is enabled. You don't need to specify a value with this switch.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RestApi</maml:name> <maml:Description> <maml:para>The RestApi switch filters the results by REST API devices. You don't need to specify a value with this switch.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>UniversalOutlook</maml:name> <maml:Description> <maml:para>The UniversalOutlook switch filters the results by Mail and Calendar devices. You don't need to specify a value with this switch.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>UserPrincipalName</maml:name> <maml:Description> <maml:para>The UserPrincipalName parameter specifies the UPN for the mailbox you want to view (for example, navin.contoso.com).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-EXOMobileDeviceStatistics -Mailbox john.doe@contoso.com</dev:code> <dev:remarks> <maml:para>Above example fetches the statstics of all devices linked to user with email john.doe@contoso.com</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Get-EXOMobileDeviceStatistics -Mailbox john.doe@contoso.com -ActiveSync</dev:code> <dev:remarks> <maml:para>Above example fetches the statstics for active sync devices linked to user with email john.doe@contoso.com</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/powershell/module/exchange/get-exomobiledevicestatistics</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-EXORecipient</command:name> <command:verb>Get</command:verb> <command:noun>EXORecipient</command:noun> <maml:description> <maml:para>This cmdlet is available only in the Exchange Online PowerShell V2 module. For more information, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell).</maml:para> <maml:para>Use the Get-ExORecipient cmdlet to view existing recipient objects in your organization. This cmdlet returns all mail-enabled objects (for example, mailboxes, mail users, mail contacts, and distribution groups).</maml:para> <maml:para>For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get-EXORecipient cmdlet can be used to view existing recipient objects in your organization. This cmdlet returns all mail-enabled objects (for example, mailboxes, mail users, mail contacts, and distribution groups).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-EXORecipient</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Identity</maml:name> <maml:Description> <maml:para>The Identity parameter specifies the recipient object that you want to view. For the best performance, we recommend using the following values to identify the recipient:</maml:para> <maml:para>- User ID or user principal name (UPN)</maml:para> <maml:para>- GUID</maml:para> <maml:para>Otherwise, you can use any value that uniquely identifies the recipient. For example:</maml:para> <maml:para>- Name</maml:para> <maml:para>- Alias</maml:para> <maml:para>- Distinguished name (DN)</maml:para> <maml:para>- <domain name>\<account name></maml:para> <maml:para>- Email address</maml:para> <maml:para>- LegacyExchangeDN</maml:para> <maml:para>- SamAccountName</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>ExternalDirectoryObjectId</maml:name> <maml:Description> <maml:para>The ExternalDirectoryObjectId parameter identifies the mailbox you want to view by using the ObjectId of the mailbox in Azure Active Directory. You can use this value instead of the Identity parameter.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:Description> <maml:para>The Filter parameter uses OPath syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`.</maml:para> <maml:para>- Enclose the whole OPath filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables.</maml:para> <maml:para>- Property is a filterable property. For more information about the filterable properties, see Get-EXORecipient property sets (https://docs.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exorecipient-property-sets) and [Filterable properties for the Filter parameter](https://docs.microsoft.com/powershell/exchange/filter-properties).</maml:para> <maml:para>- ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see about_Comparison_Operators (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators).</maml:para> <maml:para>- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values (for example, `500`, `$true`, `$false`, or `$null`).</maml:para> <maml:para>You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example, `"Criteria1 -and Criteria2"` or `"(Criteria1 -and Criteria2) -or Criteria3"`.</maml:para> <maml:para>For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeSoftDeletedRecipients</maml:name> <maml:Description> <maml:para>The IncludeSoftDeletedRecipients switch specifies whether to include soft deleted recipients in the results. You don't need to specify a value with this switch.</maml:para> <maml:para>Soft-deleted recipients are deleted recipients that are still recoverable.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrganizationalUnit</maml:name> <maml:Description> <maml:para>The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid 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:</maml:para> <maml:para>- Name</maml:para> <maml:para>- Canonical name</maml:para> <maml:para>- Distinguished name (DN)</maml:para> <maml:para>- GUID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Properties</maml:name> <maml:Description> <maml:para>The Properties parameter specifies the properties that are returned in the output of this cmdlet. You can specify multiple values separated by commas. Wildcards ( * ) are supported.</maml:para> <maml:para>For more information about the available properties, see Get-EXORecipient property sets (https://docs.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exorecipient-property-sets).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PropertySets</maml:name> <maml:Description> <maml:para>The PropertySets parameter specifies a logical grouping of properties that are returned in the output of this cmdlet. Valid values are:</maml:para> <maml:para>- Minimum (this is the default value)</maml:para> <maml:para>- Archive</maml:para> <maml:para>- Custom</maml:para> <maml:para>- MailboxMove</maml:para> <maml:para>- Policy</maml:para> <maml:para>For more information about the properties that are included in each property set, see Get-EXORecipient property sets (https://docs.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exorecipient-property-sets).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PropertySet[]</command:parameterValue> <dev:type> <maml:name>PropertySet[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RecipientType</maml:name> <maml:Description> <maml:para>The RecipientType parameter filters the results by the specified recipient type. Valid values are:</maml:para> <maml:para>- DynamicDistributionGroup</maml:para> <maml:para>- MailContact</maml:para> <maml:para>- MailNonUniversalGroup</maml:para> <maml:para>- MailUniversalDistributionGroup</maml:para> <maml:para>- MailUniversalSecurityGroup</maml:para> <maml:para>- MailUser</maml:para> <maml:para>- PublicFolder</maml:para> <maml:para>- UserMailbox</maml:para> <maml:para>You can specify multiple values separated by commas.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RecipientTypeDetails</maml:name> <maml:Description> <maml:para>The RecipientTypeDetails parameter filters the results by the specified recipient subtype. Valid values are:</maml:para> <maml:para>- DiscoveryMailbox</maml:para> <maml:para>- DynamicDistributionGroup</maml:para> <maml:para>- EquipmentMailbox</maml:para> <maml:para>- GroupMailbox</maml:para> <maml:para>- GuestMailUser</maml:para> <maml:para>- LegacyMailbox</maml:para> <maml:para>- LinkedMailbox</maml:para> <maml:para>- LinkedRoomMailbox</maml:para> <maml:para>- MailContact</maml:para> <maml:para>- MailForestContact</maml:para> <maml:para>- MailNonUniversalGroup</maml:para> <maml:para>- MailUniversalDistributionGroup</maml:para> <maml:para>- MailUniversalSecurityGroup</maml:para> <maml:para>- MailUser</maml:para> <maml:para>- PublicFolder</maml:para> <maml:para>- PublicFolderMailbox</maml:para> <maml:para>- RemoteEquipmentMailbox</maml:para> <maml:para>- RemoteRoomMailbox</maml:para> <maml:para>- RemoteSharedMailbox</maml:para> <maml:para>- RemoteTeamMailbox</maml:para> <maml:para>- RemoteUserMailbox</maml:para> <maml:para>- RoomList</maml:para> <maml:para>- RoomMailbox</maml:para> <maml:para>- SchedulingMailbox</maml:para> <maml:para>- SharedMailbox</maml:para> <maml:para>- TeamMailbox</maml:para> <maml:para>- UserMailbox</maml:para> <maml:para>You can specify multiple values separated by commas.</maml:para> <maml:para>The value of the RecipientType parameter affects the values that you can use for this parameter. For example, if you use the RecipientType value MailContact, you can't use the value UserMailbox for this parameter. You'll receive the error: None of the specified RecipientTypeDetails are included in any specified recipient type.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResultSize</maml:name> <maml:Description> <maml:para>The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Unlimited</command:parameterValue> <dev:type> <maml:name>Unlimited</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>UserPrincipalName</maml:name> <maml:Description> <maml:para>The UserPrincipalName parameter specifies the UPN for the mailbox you want to view (for example, navin.contoso.com).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-EXORecipient</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Anr</maml:name> <maml:Description> <maml:para>The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are:</maml:para> <maml:para>- CommonName (CN)</maml:para> <maml:para>- DisplayName</maml:para> <maml:para>- FirstName</maml:para> <maml:para>- LastName</maml:para> <maml:para>- Alias</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:Description> <maml:para>The Filter parameter uses OPath syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`.</maml:para> <maml:para>- Enclose the whole OPath filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables.</maml:para> <maml:para>- Property is a filterable property. For more information about the filterable properties, see Get-EXORecipient property sets (https://docs.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exorecipient-property-sets) and [Filterable properties for the Filter parameter](https://docs.microsoft.com/powershell/exchange/filter-properties).</maml:para> <maml:para>- ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see about_Comparison_Operators (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators).</maml:para> <maml:para>- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values (for example, `500`, `$true`, `$false`, or `$null`).</maml:para> <maml:para>You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example, `"Criteria1 -and Criteria2"` or `"(Criteria1 -and Criteria2) -or Criteria3"`.</maml:para> <maml:para>For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeSoftDeletedRecipients</maml:name> <maml:Description> <maml:para>The IncludeSoftDeletedRecipients switch specifies whether to include soft deleted recipients in the results. You don't need to specify a value with this switch.</maml:para> <maml:para>Soft-deleted recipients are deleted recipients that are still recoverable.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrganizationalUnit</maml:name> <maml:Description> <maml:para>The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid 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:</maml:para> <maml:para>- Name</maml:para> <maml:para>- Canonical name</maml:para> <maml:para>- Distinguished name (DN)</maml:para> <maml:para>- GUID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Properties</maml:name> <maml:Description> <maml:para>The Properties parameter specifies the properties that are returned in the output of this cmdlet. You can specify multiple values separated by commas. Wildcards ( * ) are supported.</maml:para> <maml:para>For more information about the available properties, see Get-EXORecipient property sets (https://docs.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exorecipient-property-sets).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PropertySets</maml:name> <maml:Description> <maml:para>The PropertySets parameter specifies a logical grouping of properties that are returned in the output of this cmdlet. Valid values are:</maml:para> <maml:para>- Minimum (this is the default value)</maml:para> <maml:para>- Archive</maml:para> <maml:para>- Custom</maml:para> <maml:para>- MailboxMove</maml:para> <maml:para>- Policy</maml:para> <maml:para>For more information about the properties that are included in each property set, see Get-EXORecipient property sets (https://docs.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exorecipient-property-sets).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PropertySet[]</command:parameterValue> <dev:type> <maml:name>PropertySet[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RecipientType</maml:name> <maml:Description> <maml:para>The RecipientType parameter filters the results by the specified recipient type. Valid values are:</maml:para> <maml:para>- DynamicDistributionGroup</maml:para> <maml:para>- MailContact</maml:para> <maml:para>- MailNonUniversalGroup</maml:para> <maml:para>- MailUniversalDistributionGroup</maml:para> <maml:para>- MailUniversalSecurityGroup</maml:para> <maml:para>- MailUser</maml:para> <maml:para>- PublicFolder</maml:para> <maml:para>- UserMailbox</maml:para> <maml:para>You can specify multiple values separated by commas.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RecipientTypeDetails</maml:name> <maml:Description> <maml:para>The RecipientTypeDetails parameter filters the results by the specified recipient subtype. Valid values are:</maml:para> <maml:para>- DiscoveryMailbox</maml:para> <maml:para>- DynamicDistributionGroup</maml:para> <maml:para>- EquipmentMailbox</maml:para> <maml:para>- GroupMailbox</maml:para> <maml:para>- GuestMailUser</maml:para> <maml:para>- LegacyMailbox</maml:para> <maml:para>- LinkedMailbox</maml:para> <maml:para>- LinkedRoomMailbox</maml:para> <maml:para>- MailContact</maml:para> <maml:para>- MailForestContact</maml:para> <maml:para>- MailNonUniversalGroup</maml:para> <maml:para>- MailUniversalDistributionGroup</maml:para> <maml:para>- MailUniversalSecurityGroup</maml:para> <maml:para>- MailUser</maml:para> <maml:para>- PublicFolder</maml:para> <maml:para>- PublicFolderMailbox</maml:para> <maml:para>- RemoteEquipmentMailbox</maml:para> <maml:para>- RemoteRoomMailbox</maml:para> <maml:para>- RemoteSharedMailbox</maml:para> <maml:para>- RemoteTeamMailbox</maml:para> <maml:para>- RemoteUserMailbox</maml:para> <maml:para>- RoomList</maml:para> <maml:para>- RoomMailbox</maml:para> <maml:para>- SchedulingMailbox</maml:para> <maml:para>- SharedMailbox</maml:para> <maml:para>- TeamMailbox</maml:para> <maml:para>- UserMailbox</maml:para> <maml:para>You can specify multiple values separated by commas.</maml:para> <maml:para>The value of the RecipientType parameter affects the values that you can use for this parameter. For example, if you use the RecipientType value MailContact, you can't use the value UserMailbox for this parameter. You'll receive the error: None of the specified RecipientTypeDetails are included in any specified recipient type.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResultSize</maml:name> <maml:Description> <maml:para>The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Unlimited</command:parameterValue> <dev:type> <maml:name>Unlimited</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Identity</maml:name> <maml:Description> <maml:para>The Identity parameter specifies the recipient object that you want to view. For the best performance, we recommend using the following values to identify the recipient:</maml:para> <maml:para>- User ID or user principal name (UPN)</maml:para> <maml:para>- GUID</maml:para> <maml:para>Otherwise, you can use any value that uniquely identifies the recipient. For example:</maml:para> <maml:para>- Name</maml:para> <maml:para>- Alias</maml:para> <maml:para>- Distinguished name (DN)</maml:para> <maml:para>- <domain name>\<account name></maml:para> <maml:para>- Email address</maml:para> <maml:para>- LegacyExchangeDN</maml:para> <maml:para>- SamAccountName</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Anr</maml:name> <maml:Description> <maml:para>The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are:</maml:para> <maml:para>- CommonName (CN)</maml:para> <maml:para>- DisplayName</maml:para> <maml:para>- FirstName</maml:para> <maml:para>- LastName</maml:para> <maml:para>- Alias</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>ExternalDirectoryObjectId</maml:name> <maml:Description> <maml:para>The ExternalDirectoryObjectId parameter identifies the mailbox you want to view by using the ObjectId of the mailbox in Azure Active Directory. You can use this value instead of the Identity parameter.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Filter</maml:name> <maml:Description> <maml:para>The Filter parameter uses OPath syntax to filter the results by the specified properties and values. The search criteria uses the syntax `"Property -ComparisonOperator 'Value'"`.</maml:para> <maml:para>- Enclose the whole OPath filter in double quotation marks " ". If the filter contains system values (for example, `$true`, `$false`, or `$null`), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables.</maml:para> <maml:para>- Property is a filterable property. For more information about the filterable properties, see Get-EXORecipient property sets (https://docs.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exorecipient-property-sets) and [Filterable properties for the Filter parameter](https://docs.microsoft.com/powershell/exchange/filter-properties).</maml:para> <maml:para>- ComparisonOperator is an OPath comparison operator (for example `-eq` for equals and `-like` for string comparison). For more information about comparison operators, see about_Comparison_Operators (https://docs.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comparison_operators).</maml:para> <maml:para>- Value is the property value to search for. Enclose text values and variables in single quotation marks (`'Value'` or `'$Variable'`). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of `'$User'`, use `'$($User -Replace "'","''")'`. Don't enclose integers or system values (for example, `500`, `$true`, `$false`, or `$null`).</maml:para> <maml:para>You can chain multiple search criteria together using the logical operators `-and` and `-or`. For example, `"Criteria1 -and Criteria2"` or `"(Criteria1 -and Criteria2) -or Criteria3"`.</maml:para> <maml:para>For detailed information about OPath filters in Exchange, see Additional OPATH syntax information (https://docs.microsoft.com/powershell/exchange/recipient-filters#additional-opath-syntax-information).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeSoftDeletedRecipients</maml:name> <maml:Description> <maml:para>The IncludeSoftDeletedRecipients switch specifies whether to include soft deleted recipients in the results. You don't need to specify a value with this switch.</maml:para> <maml:para>Soft-deleted recipients are deleted recipients that are still recoverable.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrganizationalUnit</maml:name> <maml:Description> <maml:para>The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid 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:</maml:para> <maml:para>- Name</maml:para> <maml:para>- Canonical name</maml:para> <maml:para>- Distinguished name (DN)</maml:para> <maml:para>- GUID</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Properties</maml:name> <maml:Description> <maml:para>The Properties parameter specifies the properties that are returned in the output of this cmdlet. You can specify multiple values separated by commas. Wildcards ( * ) are supported.</maml:para> <maml:para>For more information about the available properties, see Get-EXORecipient property sets (https://docs.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exorecipient-property-sets).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PropertySets</maml:name> <maml:Description> <maml:para>The PropertySets parameter specifies a logical grouping of properties that are returned in the output of this cmdlet. Valid values are:</maml:para> <maml:para>- Minimum (this is the default value)</maml:para> <maml:para>- Archive</maml:para> <maml:para>- Custom</maml:para> <maml:para>- MailboxMove</maml:para> <maml:para>- Policy</maml:para> <maml:para>For more information about the properties that are included in each property set, see Get-EXORecipient property sets (https://docs.microsoft.com/powershell/exchange/cmdlet-property-sets#get-exorecipient-property-sets).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PropertySet[]</command:parameterValue> <dev:type> <maml:name>PropertySet[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RecipientType</maml:name> <maml:Description> <maml:para>The RecipientType parameter filters the results by the specified recipient type. Valid values are:</maml:para> <maml:para>- DynamicDistributionGroup</maml:para> <maml:para>- MailContact</maml:para> <maml:para>- MailNonUniversalGroup</maml:para> <maml:para>- MailUniversalDistributionGroup</maml:para> <maml:para>- MailUniversalSecurityGroup</maml:para> <maml:para>- MailUser</maml:para> <maml:para>- PublicFolder</maml:para> <maml:para>- UserMailbox</maml:para> <maml:para>You can specify multiple values separated by commas.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>RecipientTypeDetails</maml:name> <maml:Description> <maml:para>The RecipientTypeDetails parameter filters the results by the specified recipient subtype. Valid values are:</maml:para> <maml:para>- DiscoveryMailbox</maml:para> <maml:para>- DynamicDistributionGroup</maml:para> <maml:para>- EquipmentMailbox</maml:para> <maml:para>- GroupMailbox</maml:para> <maml:para>- GuestMailUser</maml:para> <maml:para>- LegacyMailbox</maml:para> <maml:para>- LinkedMailbox</maml:para> <maml:para>- LinkedRoomMailbox</maml:para> <maml:para>- MailContact</maml:para> <maml:para>- MailForestContact</maml:para> <maml:para>- MailNonUniversalGroup</maml:para> <maml:para>- MailUniversalDistributionGroup</maml:para> <maml:para>- MailUniversalSecurityGroup</maml:para> <maml:para>- MailUser</maml:para> <maml:para>- PublicFolder</maml:para> <maml:para>- PublicFolderMailbox</maml:para> <maml:para>- RemoteEquipmentMailbox</maml:para> <maml:para>- RemoteRoomMailbox</maml:para> <maml:para>- RemoteSharedMailbox</maml:para> <maml:para>- RemoteTeamMailbox</maml:para> <maml:para>- RemoteUserMailbox</maml:para> <maml:para>- RoomList</maml:para> <maml:para>- RoomMailbox</maml:para> <maml:para>- SchedulingMailbox</maml:para> <maml:para>- SharedMailbox</maml:para> <maml:para>- TeamMailbox</maml:para> <maml:para>- UserMailbox</maml:para> <maml:para>You can specify multiple values separated by commas.</maml:para> <maml:para>The value of the RecipientType parameter affects the values that you can use for this parameter. For example, if you use the RecipientType value MailContact, you can't use the value UserMailbox for this parameter. You'll receive the error: None of the specified RecipientTypeDetails are included in any specified recipient type.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResultSize</maml:name> <maml:Description> <maml:para>The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Unlimited</command:parameterValue> <dev:type> <maml:name>Unlimited</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>UserPrincipalName</maml:name> <maml:Description> <maml:para>The UserPrincipalName parameter specifies the UPN for the mailbox you want to view (for example, navin.contoso.com).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-EXORecipient -ResultSize 100</dev:code> <dev:remarks> <maml:para>This example returns the first 100 recipient objects in name sorted order.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>Get-EXORecipient -Identity john@contosot.com</dev:code> <dev:remarks> <maml:para>This example returns the recipient attribute details for the user john@contoso.com</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/powershell/module/exchange/get-exorecipient</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-EXORecipientPermission</command:name> <command:verb>Get</command:verb> <command:noun>EXORecipientPermission</command:noun> <maml:description> <maml:para>This cmdlet is available only in the Exchange Online PowerShell V2 module. For more information, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell).</maml:para> <maml:para>Use the Get-EXORecipientPermission cmdlet to view information about SendAs permissions that are configured for users in a cloud-based organization.</maml:para> <maml:para>For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet is used to view/manage information about SendAs permissions that are configured for users in a cloud-based organization. Send As permission allows delegates to use the mailbox to send messages. After this permission is assigned to a delegate, any message that the delegate sends from the mailbox will appear to have been sent by the mailbox owner. However, this permission doesn't allow a delegate to sign in to the user's mailbox. It only allows users to open the mailbox. If this permission is assigned to a group, a message sent by the delegate will appear to have been sent by the group.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-EXORecipientPermission</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Identity</maml:name> <maml:Description> <maml:para>The Identity parameter filters the results by the target recipient. The user or group specified by the Trustee parameter can operate on this recipient.</maml:para> <maml:para>You can specify any type of recipient, for example:</maml:para> <maml:para>- Mailboxes</maml:para> <maml:para>- Mail users</maml:para> <maml:para>- External contacts</maml:para> <maml:para>- Distribution groups</maml:para> <maml:para>- Dynamic distribution groups</maml:para> <maml:para>For the best performance, we recommend using the following values to identify the recipient:</maml:para> <maml:para>- User ID or user principal name (UPN)</maml:para> <maml:para>- GUID</maml:para> <maml:para>Otherwise, you can use any value that uniquely identifies the mailbox. For example:</maml:para> <maml:para>- Name</maml:para> <maml:para>- Alias</maml:para> <maml:para>- Distinguished name (DN)</maml:para> <maml:para>- <domain name>\<account name></maml:para> <maml:para>- Email address</maml:para> <maml:para>- LegacyExchangeDN</maml:para> <maml:para>- SamAccountName</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AccessRights</maml:name> <maml:Description> <maml:para>The AccessRights parameter filters the results by permission.</maml:para> <maml:para>The only valid value for this parameter is SendAs.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">MultiValuedProperty</command:parameterValue> <dev:type> <maml:name>MultiValuedProperty</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>ExternalDirectoryObjectId</maml:name> <maml:Description> <maml:para>The ExternalDirectoryObjectId parameter identifies the mailbox you want to view by using the ObjectId of the mailbox in Azure Active Directory. You can use this value instead of the Identity parameter.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>PrimarySmtpAddress</maml:name> <maml:Description> <maml:para>This parameter is reserved for internal Microsoft use.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResultSize</maml:name> <maml:Description> <maml:para>The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Unlimited</command:parameterValue> <dev:type> <maml:name>Unlimited</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Trustee</maml:name> <maml:Description> <maml:para>The Trustee parameter filters the results by the user or group to whom you're granting the permission. The user or group can operate on the recipient specified by the Identity, UserPrincipalName, or ExternalDirectoryObjectId parameters (and you can only use the Trustee parameter with those parameters). Note : Trustee parameter can be specified only with Identity, UserPrincipalName, ExternalDirectoryObjectId parameters</maml:para> <maml:para>You can specify the following types of users or groups:</maml:para> <maml:para>- Mailbox users</maml:para> <maml:para>- Mail users with a Microsoft account (formerly known as a Windows Live ID)</maml:para> <maml:para>- Security groups</maml:para> <maml:para>You can use any value that uniquely identifies the user or group. For example:</maml:para> <maml:para>- Name</maml:para> <maml:para>- Alias</maml:para> <maml:para>- Distinguished name (DN)</maml:para> <maml:para>- Canonical DN</maml:para> <maml:para>- <domain name>\<account name></maml:para> <maml:para>- Email address</maml:para> <maml:para>- User Principal name (UPN)</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>UserPrincipalName</maml:name> <maml:Description> <maml:para>The UserPrincipalName parameter specifies the UPN for the mailbox you want to view (for example, navin.contoso.com).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="0" aliases="none"> <maml:name>Identity</maml:name> <maml:Description> <maml:para>The Identity parameter filters the results by the target recipient. The user or group specified by the Trustee parameter can operate on this recipient.</maml:para> <maml:para>You can specify any type of recipient, for example:</maml:para> <maml:para>- Mailboxes</maml:para> <maml:para>- Mail users</maml:para> <maml:para>- External contacts</maml:para> <maml:para>- Distribution groups</maml:para> <maml:para>- Dynamic distribution groups</maml:para> <maml:para>For the best performance, we recommend using the following values to identify the recipient:</maml:para> <maml:para>- User ID or user principal name (UPN)</maml:para> <maml:para>- GUID</maml:para> <maml:para>Otherwise, you can use any value that uniquely identifies the mailbox. For example:</maml:para> <maml:para>- Name</maml:para> <maml:para>- Alias</maml:para> <maml:para>- Distinguished name (DN)</maml:para> <maml:para>- <domain name>\<account name></maml:para> <maml:para>- Email address</maml:para> <maml:para>- LegacyExchangeDN</maml:para> <maml:para>- SamAccountName</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AccessRights</maml:name> <maml:Description> <maml:para>The AccessRights parameter filters the results by permission.</maml:para> <maml:para>The only valid value for this parameter is SendAs.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">MultiValuedProperty</command:parameterValue> <dev:type> <maml:name>MultiValuedProperty</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>ExternalDirectoryObjectId</maml:name> <maml:Description> <maml:para>The ExternalDirectoryObjectId parameter identifies the mailbox you want to view by using the ObjectId of the mailbox in Azure Active Directory. You can use this value instead of the Identity parameter.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Guid</command:parameterValue> <dev:type> <maml:name>Guid</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>PrimarySmtpAddress</maml:name> <maml:Description> <maml:para>This parameter is reserved for internal Microsoft use.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResultSize</maml:name> <maml:Description> <maml:para>The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Unlimited</command:parameterValue> <dev:type> <maml:name>Unlimited</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Trustee</maml:name> <maml:Description> <maml:para>The Trustee parameter filters the results by the user or group to whom you're granting the permission. The user or group can operate on the recipient specified by the Identity, UserPrincipalName, or ExternalDirectoryObjectId parameters (and you can only use the Trustee parameter with those parameters). Note : Trustee parameter can be specified only with Identity, UserPrincipalName, ExternalDirectoryObjectId parameters</maml:para> <maml:para>You can specify the following types of users or groups:</maml:para> <maml:para>- Mailbox users</maml:para> <maml:para>- Mail users with a Microsoft account (formerly known as a Windows Live ID)</maml:para> <maml:para>- Security groups</maml:para> <maml:para>You can use any value that uniquely identifies the user or group. For example:</maml:para> <maml:para>- Name</maml:para> <maml:para>- Alias</maml:para> <maml:para>- Distinguished name (DN)</maml:para> <maml:para>- Canonical DN</maml:para> <maml:para>- <domain name>\<account name></maml:para> <maml:para>- Email address</maml:para> <maml:para>- User Principal name (UPN)</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>UserPrincipalName</maml:name> <maml:Description> <maml:para>The UserPrincipalName parameter specifies the UPN for the mailbox you want to view (for example, navin.contoso.com).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-EXORecipientPermission -ResultSize 100</dev:code> <dev:remarks> <maml:para>Above example returns recipient permission for first 100 mailbox users in the name sorted order.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/powershell/module/exchange/get-exorecipientpermission</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-UserBriefingConfig</command:name> <command:verb>Get</command:verb> <command:noun>UserBriefingConfig</command:noun> <maml:description> <maml:para>This cmdlet is available only in the Exchange Online PowerShell V2 module. For more information, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell).</maml:para> <maml:para>Use the Get-UserBriefingConfig cmdlet to get the current state of the Briefing email flag for the specified user. For more details about configuring the Briefing email, see Configure Briefing email (https://docs.microsoft.com/Briefing/be-admin).</maml:para> <maml:para>For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet requires the .NET Framework 4.7.2 or later. Also, you need to be a member of the Organization Management role group (Global admins).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-UserBriefingConfig</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Identity</maml:name> <maml:Description> <maml:para>The Identity parameter specifies the user that you want to view (for example, lila@contoso.com).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResultSize </maml:name> <maml:Description> <maml:para>This parameter is reserved for internal Microsoft use.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Unlimited</command:parameterValue> <dev:type> <maml:name>Unlimited</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Identity</maml:name> <maml:Description> <maml:para>The Identity parameter specifies the user that you want to view (for example, lila@contoso.com).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResultSize </maml:name> <maml:Description> <maml:para>This parameter is reserved for internal Microsoft use.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Unlimited</command:parameterValue> <dev:type> <maml:name>Unlimited</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert /> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Get-UserBriefingConfig -Identity lila@contoso.com</dev:code> <dev:remarks> <maml:para>This example returns the Briefing configuration for the user lila@contoso.com.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/powershell/module/exchange/get-userbriefingconfig</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Configure Briefing email</maml:linkText> <maml:uri>https://docs.microsoft.com/Briefing/be-admin</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-UserBriefingConfig</command:name> <command:verb>Set</command:verb> <command:noun>UserBriefingConfig</command:noun> <maml:description> <maml:para>This cmdlet is available only in the Exchange Online PowerShell V2 module. For more information, see Connect to Exchange Online PowerShell (https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell).</maml:para> <maml:para>Use the Set-UserBriefingConfig cmdlet to enable or disable the Briefing for a user. For more details about configuring the Briefing, see Configure Briefing email (https://docs.microsoft.com/Briefing/be-admin).</maml:para> <maml:para>For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax).</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This cmdlet requires the .NET Framework 4.7.2 or later. Also, you need to be a member of the Organization Management role group (Global admins).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-UserBriefingConfig</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Identity</maml:name> <maml:Description> <maml:para>The Identity parameter specifies the user that you want to modify (for example, lila@contoso.onmicrosoft.com).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Enabled</maml:name> <maml:Description> <maml:para>The Enabled parameter specifies whether to enable or disable the Briefing email for a specified user's mailbox. Valid values are:</maml:para> <maml:para>- $true: The daily briefing message is enabled.</maml:para> <maml:para>- $false: The daily briefing message is disabled. This is the default value.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResultSize </maml:name> <maml:Description> <maml:para>This parameter is reserved for internal Microsoft use.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Unlimited</command:parameterValue> <dev:type> <maml:name>Unlimited</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Identity</maml:name> <maml:Description> <maml:para>The Identity parameter specifies the user that you want to modify (for example, lila@contoso.onmicrosoft.com).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Enabled</maml:name> <maml:Description> <maml:para>The Enabled parameter specifies whether to enable or disable the Briefing email for a specified user's mailbox. Valid values are:</maml:para> <maml:para>- $true: The daily briefing message is enabled.</maml:para> <maml:para>- $false: The daily briefing message is disabled. This is the default value.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ResultSize </maml:name> <maml:Description> <maml:para>This parameter is reserved for internal Microsoft use.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Unlimited</command:parameterValue> <dev:type> <maml:name>Unlimited</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert /> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>Set-UserBriefingConfig -Identity lila@contoso.com -Enabled $true</dev:code> <dev:remarks> <maml:para>This example enables the Briefing email for lila@contoso.com.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/powershell/module/exchange/set-userbriefingconfig</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Configure Briefing email</maml:linkText> <maml:uri>https://docs.microsoft.com/Briefing/be-admin</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |