Applies to: Exchange Server 2013, Exchange Online
Topic Last Modified: 2012-07-12
Use the Disable-InboxRule cmdlet to disable an Inbox rule.
For information about the parameter sets in the Syntax section below, see Syntax.
Syntax
Disable-InboxRule -Identity <InboxRuleIdParameter>
[-AlwaysDeleteOutlookRulesBlob <SwitchParameter>] [-Confirm
[<SwitchParameter>]] [-DomainController <Fqdn>] [-Force
<SwitchParameter>] [-Mailbox <MailboxIdParameter>]
[-WhatIf [<SwitchParameter>]]
|
Examples
EXAMPLE 1
This example disables the Inbox rule MoveAnnoncements in the mailbox Joe@Contoso.com.
 Copy Code |
|
|---|---|
Disable-InboxRule -Identity "MoveAnnouncements" -Mailbox "Joe@Contoso.com" |
|
Detailed Description
 Important: |
|---|
| When you create, modify, remove, enable, or disable an Inbox rule on Microsoft Exchange Server 2013, any client-side rules created by Microsoft Outlook are removed. |
You need to be assigned permissions before you can run this cmdlet. Although all parameters for this cmdlet are listed in this topic, you may not have access to some parameters if they're not included in the permissions assigned to you. To see what permissions you need, see the "Inbox rules" entry in the Recipients Permissions topic.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
Identity |
Required |
Microsoft.Exchange.Configuration.Tasks.InboxRuleIdParameter |
The Identity parameter specifies the identity of the Inbox rule to be disabled. |
|
AlwaysDeleteOutlookRulesBlob |
Optional |
System.Management.Automation.SwitchParameter |
The AlwaysDeleteOutlookRulesBlob parameter suppresses a warning that end users or administrators get if they use Outlook Web App or Windows PowerShell to modify Inbox rules. |
|
Confirm |
Optional |
System.Management.Automation.SwitchParameter |
The Confirm switch causes the command to pause processing and requires you to acknowledge what the command will do before processing continues. You don't have to specify a value with the Confirm switch. |
|
DomainController |
Optional |
Microsoft.Exchange.Data.Fqdn |
The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to Active Directory. |
|
Force |
Optional |
System.Management.Automation.SwitchParameter |
The Force switch specifies whether to suppress the confirmation prompt produced if rules created by Outlook exist on the mailbox. When taking an action using Inbox rules on Exchange 2013, any client-side rules are removed. |
|
Mailbox |
Optional |
Microsoft.Exchange.Configuration.Tasks.MailboxIdParameter |
The Mailbox parameter specifies the identity of the mailbox to which the Inbox rule belongs. |
|
WhatIf |
Optional |
System.Management.Automation.SwitchParameter |
The WhatIf switch instructs the command to simulate the actions that it would take on the object. By using the WhatIf switch, you can view what changes would occur without having to apply any of those changes. You don't have to specify a value with the WhatIf switch. |
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.
Return 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.