Get-InboxRule (ExchangePowerShell) By chrisda Archived: 2026-04-06 03:31:33 UTC In this article 1. Syntax 2. Description 3. Examples 4. Parameters 5. Inputs 6. Outputs This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings might be exclusive to one environment or the other. Use the Get-InboxRule cmdlet to view Inbox rule properties. Inbox rules are used to process messages in the Inbox based on conditions specified and take actions such as moving a message to a specified folder or deleting a message. For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax. Get-InboxRule [[-Identity] ] [-BypassScopeCheck] [-DescriptionTimeFormat ] [-DescriptionTimeZone ] [-DomainController ] [-IncludeHidden] [-Mailbox ] [-ResultSize ] [-SkipCount ] [-SweepRules] [-UseCustomRouting] [] You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet. https://docs.microsoft.com/en-us/powershell/module/exchange/get-inboxrule?view=exchange-ps Page 1 of 8 Note: This cmdlet doesn't work for members of View-Only Organization Management role group in Exchange Online or the Global Reader role in Microsoft Entra ID. Get-InboxRule -Mailbox Joe@Contoso.com This example retrieves all Inbox rules for the mailbox Joe@Contoso.com. Get-InboxRule "ReceivedLastYear" -Mailbox joe@contoso.com -DescriptionTimeFormat "MM/dd/yyyy" -DescriptionTimeZ This example retrieves the Inbox rule ReceivedLastYear from the mailbox joe@contoso.com on which the ReceivedBeforeDate parameter was set when the rule was created. The DescriptionTimeFormat and DescriptionTimeZone parameters are used in this example to specify formatting of the time and the time zone used in the rule's Description property. Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online The BypassScopeCheck switch specifies whether to bypass the scope check for the user that's running the command. You don't need to specify a value with this switch. Type: SwitchParameter Default value: None Supports wildcards: False DontShow: False (All) Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online The DescriptionTimeFormat parameter specifies the format for time values in the rule description. For example: MM/dd/yyyy, where MM is the 2-digit month, dd is the 2-digit day and yyyy is the 4-digit year. Type: String https://docs.microsoft.com/en-us/powershell/module/exchange/get-inboxrule?view=exchange-ps Page 2 of 8 Default value: None Supports wildcards: False DontShow: False (All) Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online The DescriptionTimeZone parameter specifies time zone that's used for time values in the rule description. A valid value for this parameter is a supported time zone key name (for example, "Pacific Standard Time"). To see the available values, run the following command: $TimeZone = Get-ChildItem "HKLM:\Software\Microsoft\Windows NT\CurrentVersion\Time zones" | foreach {Get-ItemProperty $_.PSPath}; $TimeZone | sort Display | Format-Table -Auto PSChildname,Display . If the value contains spaces, enclose the value in quotation marks ("). The default value is the time zone setting of the Exchange server. Type: ExTimeZoneValue Default value: None Supports wildcards: False DontShow: False (All) Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False https://docs.microsoft.com/en-us/powershell/module/exchange/get-inboxrule?view=exchange-ps Page 3 of 8 Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE This parameter is available only in on-premises Exchange. The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. Type: Fqdn Default value: None Supports wildcards: False DontShow: False (All) Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online The Identity parameter specifies the Inbox rule that you want to view. You can use any value that uniquely identifies the rule. For example: Name RuleIdentity property (for example, 16752869479666417665). Exchange Online: MailboxAlias\RuleIdentity (for example, rzaher\16752869479666417665 ). On-premises Exchange: MailboxCanonicalName\RuleIdentity (for example, contoso.com/Users/Rick Zaher\16752869479666417665 ). Caution: The value $null or a non-existent value for the Identity parameter returns all objects as if you ran the Get- command without the Identity parameter. Verify any lists of values for the Identity parameter are accurate and don't contain non-existent $null values. Type: InboxRuleIdParameter Default value: None https://docs.microsoft.com/en-us/powershell/module/exchange/get-inboxrule?view=exchange-ps Page 4 of 8 Supports wildcards: False DontShow: False (All) Position: 1 Mandatory: False Value from pipeline: True Value from pipeline by property name: True Value from remaining arguments: False Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online The IncludeHidden switch specifies whether to include hidden Inbox rules in the results. You don't need to specify a value with this switch. Type: SwitchParameter Default value: None Supports wildcards: False DontShow: False (All) Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online The Mailbox parameter specifies the mailbox that contains the Inbox rule. You can use any value that uniquely identifies the mailbox. For example: Name Alias Distinguished name (DN) https://docs.microsoft.com/en-us/powershell/module/exchange/get-inboxrule?view=exchange-ps Page 5 of 8 Canonical DN Domain\Username Email address GUID LegacyExchangeDN SamAccountName User ID or user principal name (UPN) Type: MailboxIdParameter Default value: None Supports wildcards: False DontShow: False (All) Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False Applicable: Exchange Online, Built-in security add-on for on-premises mailboxes This parameter is available only in the cloud-based service. 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. Type: Unlimited Default value: None Supports wildcards: False DontShow: False (All) Position: Named Mandatory: False Value from pipeline: False https://docs.microsoft.com/en-us/powershell/module/exchange/get-inboxrule?view=exchange-ps Page 6 of 8 Value from pipeline by property name: False Value from remaining arguments: False Applicable: Exchange Online This parameter is available only in the cloud-based service. {{ Fill SkipCount Description }} Type: Int32 Default value: None Supports wildcards: False DontShow: False (All) Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False Applicable: Exchange Server 2016, Exchange Server 2019, Exchange Server SE This parameter is available only in on-premises Exchange. The SweepRules switch specifies whether to return only Sweep rules in the results. You don't need to specify a value with this switch. Sweep rules run at regular intervals to help keep your Inbox clean. Type: SwitchParameter Default value: None Supports wildcards: False DontShow: False (All) Position: Named Mandatory: False https://docs.microsoft.com/en-us/powershell/module/exchange/get-inboxrule?view=exchange-ps Page 7 of 8 Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False Applicable: Exchange Online This parameter is available only in the cloud-based service. {{ Fill UseCustomRouting Description }} Type: SwitchParameter Default value: None Supports wildcards: False DontShow: False (All) Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, - InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters. Input types To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types. If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data. Output types To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types. If the Output Type field is blank, the cmdlet doesn't return data. Source: https://docs.microsoft.com/en-us/powershell/module/exchange/get-inboxrule?view=exchange-ps https://docs.microsoft.com/en-us/powershell/module/exchange/get-inboxrule?view=exchange-ps Page 8 of 8