Commands › Exchange Online

Get-InboxRule

Exchange Online ExchangeOnlineManagement Get-*

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.

Quick start script

# Get-InboxRule — quick start (serv365.ai)
# 1. Connect (app-only shown; interactive: omit the certificate parameters)
Connect-ExchangeOnline -CertificateThumbprint $thumb -AppId $appId -Organization $org

# 2. Run and inspect
Get-InboxRule | Format-List

# 3. Export for evidence / drift tracking
Get-InboxRule | Export-Clixml .\InboxRule-$(Get-Date -Format yyyyMMdd).xml

Syntax

Get-InboxRule [[-Identity] <InboxRuleIdParameter>]
 [-BypassScopeCheck]
 [-DescriptionTimeFormat <String>]
 [-DescriptionTimeZone <ExTimeZoneValue>]
 [-DomainController <Fqdn>]
 [-IncludeHidden]
 [-Mailbox <MailboxIdParameter>]
 [-ResultSize <Unlimited>]
 [-SkipCount <Int32>]
 [-SweepRules]
 [-UseCustomRouting]
 [<CommonParameters>]

Parameters (11)

ParameterTypeRequiredWhat it controls
-Identity InboxRuleIdParameter The Identity parameter specifies the Inbox rule that you want to view. You can use any value that uniquely identifies the rule. For example:
-BypassScopeCheck SwitchParameter 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.
-DescriptionTimeFormat String The DescriptionTimeFormat parameter specifies the format for time values in the rule description. For example:
-DescriptionTimeZone ExTimeZoneValue The DescriptionTimeZone parameter specifies time zone that's used for time values in the rule description.
-DomainController Fqdn This parameter is available only in on-premises Exchange.
-IncludeHidden SwitchParameter The IncludeHidden switch specifies whether to include hidden Inbox rules in the results. You don't need to specify a value with this switch.
-Mailbox MailboxIdParameter The Mailbox parameter specifies the mailbox that contains the Inbox rule. You can use any value that uniquely identifies the mailbox. For example:
-ResultSize Unlimited This parameter is available only in the cloud-based service.
-SkipCount Int32 This parameter is available only in the cloud-based service.
-SweepRules SwitchParameter This parameter is available only in on-premises Exchange.
-UseCustomRouting SwitchParameter This parameter is available only in the cloud-based service.

Reference facts derived from Microsoft documentation, © Microsoft, licensed CC BY 4.0; restructured with original guidance by serv365.ai.