{"id":79,"date":"2013-04-30T15:55:21","date_gmt":"2013-04-30T11:55:21","guid":{"rendered":"http:\/\/use-powershell.com\/?p=79"},"modified":"2013-09-18T11:19:53","modified_gmt":"2013-09-18T07:19:53","slug":"managing-outlook-rules-using-powershell","status":"publish","type":"post","link":"https:\/\/rakhesh.com\/powershell\/managing-outlook-rules-using-powershell\/","title":{"rendered":"Managing Outlook rules using PowerShell"},"content":{"rendered":"

To view the rules associated with a mailbox use the Get-InboxRule<\/code> cmdlet. Very useful when you are troubleshooting a remote user who is not getting emails and you suspect the rules could have a hand in it. <\/p>\n

The cmdlet requires the initials of the user whose mailbox you want to check via the -Mailbox<\/code> switch: <\/p>\n

\nPS> Get-InboxRule -Mailbox rakhesh\n\nName                          Enabled                       Priority                      RuleIdentity\n----                          -------                       --------                      ------------\nSCOM Alerts                   True                          1                             4228791152867803137\nMAPIMailbox::HandleObjectM... True                          2                             4300848746905731073\nBackup Exec Alert             True                          3                             4372906340943659009\nOperations Manager Service... True                          4                             4444963934981586945\nMove messages sent from Te... True                          5                             4517021529019514881\nx_ServicedeskLondon (to)      True                          6                             4589079123057442817\nFacebook                      True                          7                             4661136717095370753\nIsisOnlineBilling@isistele... True                          8                             4733194311133298689\nMove messages sent from Ch... False                         9                             4805251905171226625\nMAILER-DAEMON@messagelabs.com True                          10                            4877309499209154561\ndisplay a Desktop Alert       True                          11                            4949367093247082497\n<\/pre>\n
To view a particular rule you can pass its name to the cmdlet:<\/p>\n
\nPS> Get-InboxRule -Mailbox rakhesh \"Facebook\"\n\nName                          Enabled                       Priority                      RuleIdentity\n----                          -------                       --------                      ------------\nFacebook                      True                          7                             4661136717095370753\n<\/pre>\n
The good thing about manipulating rules via PowerShell is that you can filter based on the rule properties. Pipe the output to get-member<\/code> to see the various properties:<\/p>\n
\nPS> Get-InboxRule -Mailbox rakhesh | gm\n\n...\nMarkAsRead                            Property     System.Boolean {get;set;}\nMarkImportance                        Property      {get;set;}\nMessageTypeMatches                    Property      {get;set;}\nMoveToFolder                          Property     System.String {get;set;}\nMyNameInCcBox                         Property     System.Boolean {get;set;}\nMyNameInToBox                         Property     System.Boolean {get;set;}\nMyNameInToOrCcBox                     Property     System.Boolean {get;set;}\nMyNameNotInToBox                      Property     System.Boolean {get;set;}\nName                                  Property     System.String {get;set;}\nPriority                              Property     System.Int32 {get;set;}\nReceivedAfterDate                     Property      {get;set;}\nReceivedBeforeDate                    Property      {get;set;}\nRecipientAddressContainsWords         Property     Deserialized.Microsoft.Exchange.Data.MultiValuedProperty`1[[Sy\nRedirectTo                            Property      {get;set;}\n...\n\n<\/pre>\n
Then you can do stuff like:<\/p>\n
\nPS> # find all rules where I delete the message\nPS> Get-InboxRule -Mailbox rakhesh | ?{ $_.DeleteMessage }\n\nName                          Enabled                       Priority                      RuleIdentity\n----                          -------                       --------                      ------------\nMAPIMailbox::HandleObjectM... True                          2                             4300848746905731073\nBackup Exec Alert             True                          3                             4372906340943659009\nMAILER-DAEMON@messagelabs.com True                          10                            4877309499209154561\n\n\nPS> # find all rules where I am filing the message\nPS> Get-InboxRule -Mailbox rakhesh | ?{ $_.MoveToFolder }\n\nName                          Enabled                       Priority                      RuleIdentity\n----                          -------                       --------                      ------------\nSCOM Alerts                   True                          1                             4228791152867803137\nOperations Manager Service... True                          4                             4444963934981586945\nMove messages sent from Te... True                          5                             4517021529019514881\nx_ServicedeskLondon (to)      True                          6                             4589079123057442817\nIsisOnlineBilling@isistele... True                          8                             4733194311133298689\n\nPS> # find all rules matching a particular domain in the from: address\nPS> Get-InboxRule -Mailbox rakhesh | ?{ $_.From -match \"facebook\" }\n\nName                          Enabled                       Priority                      RuleIdentity\n----                          -------                       --------                      ------------\nFacebook                      True                          7                             4661136717095370753\n\n<\/pre>\n
To disable and enable rules you have the Disable-InboxRule<\/code> and Enable-InboxRule<\/code> cmdlets. <\/p>\n
\nPS> Disable-InboxRule -Mailbox rakhesh \"Facebook\"\n\nConfirm\nUsing Outlook Web App or Windows PowerShell to modify your rules will delete any rules that were previously turned off\nusing Outlook. If you want to preserve the rules you turned off using Outlook, select \"No\" and use Outlook to edit your\n rules. Are you sure you want to proceed?\n[Y] Yes  [A] Yes to All  [N] No  [L] No to All  [?] Help (default is \"Y\"): y\nThis Inbox rule isn't supported by this version of Exchange.\n    + CategoryInfo          : InvalidOperation: (Facebook:InboxRuleIdParameter) [Disable-InboxRule], InvalidOperationE\n   xception\n    + FullyQualifiedErrorId : 783DD273,Microsoft.Exchange.Management.RecipientTasks.DisableInboxRule\n\nPS> # the error is because this is a client only rule and so can't be manipulated from the server\nPS> # so let's try another rule\nPS> Disable-InboxRule -Mailbox rakhesh \"SCOM Alerts\"\n\nConfirm\nUsing Outlook Web App or Windows PowerShell to modify your rules will delete any rules that were previously turned off\nusing Outlook. If you want to preserve the rules you turned off using Outlook, select \"No\" and use Outlook to edit your\n rules. Are you sure you want to proceed?\n[Y] Yes  [A] Yes to All  [N] No  [L] No to All  [?] Help (default is \"Y\"):\n\nPS> # enabling the previously disabled rule\nPS> Enable-InboxRule -Mailbox rakhesh \"SCOM Alerts\"\n<\/pre>\n
Notice how the cmdlet failed for a client only rule? You can find such rules by using the SupportedByTask<\/code> property:<\/p>\n
\nPS> Get-InboxRule -Mailbox rakhesh | ?{ !$_.SupportedByTask } | ft -AutoSize\n\nName                    Enabled Priority RuleIdentity\n----                    ------- -------- ------------\nFacebook                True    7        16514055682962489345\ndisplay a Desktop Alert True    10       16730228465076273153\n\n<\/pre>\n
Lastly, to mass enable or disable rules do thus (in the examples below I am selecting rules matching certain criteria, but that’s optional):<\/p>\n
\nPS> Get-InboxRule -Mailbox rakhesh | ?{ $_.MoveToFolder }\n\nName                          Enabled                       Priority                      RuleIdentity\n----                          -------                       --------                      ------------\nSCOM Alerts                   True                          1                             16081710118734921729\nOperations Manager Service... True                          4                             16297882900848705537\nMove messages sent from Te... True                          5                             16369940494886633473\nx_ServicedeskLondon (to)      True                          6                             16441998088924561409\nIsisOnlineBilling@isistele... True                          8                             16586113277000417281\n\n\nPS> Get-InboxRule -Mailbox rakhesh | ?{ $_.MoveToFolder } | Disable-InboxRule\nPS> Get-InboxRule -Mailbox rakhesh | ?{ $_.MoveToFolder }\n\nName                          Enabled                       Priority                      RuleIdentity\n----                          -------                       --------                      ------------\nSCOM Alerts                   False                         1                             16081710118734921729\nOperations Manager Service... False                         4                             16297882900848705537\nMove messages sent from Te... False                         5                             16369940494886633473\nx_ServicedeskLondon (to)      False                         6                             16441998088924561409\nIsisOnlineBilling@isistele... False                         8                             16586113277000417281\n\n\nPS> Get-InboxRule -Mailbox rakhesh | ?{ $_.MoveToFolder } | Enable-InboxRule\nPS> Get-InboxRule -Mailbox rakhesh | ?{ $_.MoveToFolder }\n\nName                          Enabled                       Priority                      RuleIdentity\n----                          -------                       --------                      ------------\nSCOM Alerts                   True                          1                             16081710118734921729\nOperations Manager Service... True                          4                             16297882900848705537\nMove messages sent from Te... True                          5                             16369940494886633473\nx_ServicedeskLondon (to)      True                          6                             16441998088924561409\nIsisOnlineBilling@isistele... True                          8                             16586113277000417281\n\n<\/pre>\n
PowerShell can also be used to create and delete rules. Like thus:<\/p>\n
\nPS> New-InboxRule -Mailbox rakhesh -Name \"Mails from Gmail\" -FromAddressContainsWords \"gmail\" -MoveToFolder \"rakhesh:Hold\" -StopProcessingRules $true\n \nName                          Enabled                       Priority                      RuleIdentity\n----                          -------                       --------                      ------------\nMails from Gmail              True                          1                             16946401247190056961\n \nPS> Remove-InboxRule -Mailbox rakhesh \"Mails from Gmail\"\n \nConfirm\nAre you sure you want to perform this action?\nRemoving inbox rule \"Mails from Gmail\" from mailbox \"domain.com\/path\/to\/OU\/Sasidharan, Rakhesh\".\n[Y] Yes  [A] Yes to All  [N] No  [L] No to All  [?] Help (default is \"Y\"): Y\n \nConfirm\nUsing Outlook Web App or Windows PowerShell to modify your rules will delete any rules that were previously turned off\nusing Outlook. If you want to preserve the rules you turned off using Outlook, select \"No\" and use Outlook to edit your\nrules. Are you sure you want to proceed?\n[Y] Yes  [A] Yes to All  [N] No  [L] No to All  [?] Help (default is \"Y\"): Y\n<\/pre>\n","protected":false},"excerpt":{"rendered":"
To view the rules associated with a mailbox use the Get-InboxRule cmdlet. Very useful when you are troubleshooting a remote user who is not getting emails and you suspect the rules could have a hand in it. The cmdlet requires the initials of the user whose mailbox you want to check via the -Mailbox switch: … Continue reading Managing Outlook rules using PowerShell<\/span><\/a><\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_jetpack_memberships_contains_paid_content":false,"footnotes":"","jetpack_publicize_message":"","jetpack_publicize_feature_enabled":true,"jetpack_social_post_already_shared":true,"jetpack_social_options":{"image_generator_settings":{"template":"highway","enabled":false}}},"categories":[2],"tags":[],"jetpack_publicize_connections":[],"jetpack_sharing_enabled":true,"jetpack_featured_media_url":"","_links":{"self":[{"href":"https:\/\/rakhesh.com\/wp-json\/wp\/v2\/posts\/79"}],"collection":[{"href":"https:\/\/rakhesh.com\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/rakhesh.com\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/rakhesh.com\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/rakhesh.com\/wp-json\/wp\/v2\/comments?post=79"}],"version-history":[{"count":0,"href":"https:\/\/rakhesh.com\/wp-json\/wp\/v2\/posts\/79\/revisions"}],"wp:attachment":[{"href":"https:\/\/rakhesh.com\/wp-json\/wp\/v2\/media?parent=79"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/rakhesh.com\/wp-json\/wp\/v2\/categories?post=79"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/rakhesh.com\/wp-json\/wp\/v2\/tags?post=79"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}