New-ReportSubmissionRule
This cmdlet is available only in the cloud-based service.
Use the New-ReportSubmissionRule cmdlet to create the report submission rule in your cloud-based organization. The report submission rule identifies the reporting mailbox where user reported messages are delivered.
Note: If the rule already exists (the Get-ReportSubmissionRule cmdlet returns output), you can't use this cmdlet. To delete the existing rule and start over, use the Remove-ReportSubmissionRule cmdlet first.
For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.
Syntax
New-ReportSubmissionRule
[-Name] <String>
-ReportSubmissionPolicy <ReportSubmissionPolicyIdParameter>
[-Comments <String>]
[-Confirm]
[-Enabled <Boolean>]
[-SentTo <RecipientIdParameter[]>]
[-WhatIf]
[<CommonParameters>] Description
You can use this cmdlet only if the following statements are true:
- The report submission rule doesn't exist (the Get-ReportSubmissionRule cmdlet returns no output).
- The report submission policy exists (the Get-ReportSubmissionPolicy cmdlet returns output).
The SentTo parameter identifies the email address of the reporting mailbox. Your organization needs a report submission rule only to send user reported messages to the reporting mailbox using Microsoft or third-party reporting tools in Outlook (reporting in Outlook is turned on).
When you set the email address of the reporting mailbox in the Microsoft Defender portal at https://security.microsoft.com/securitysettings/userSubmission, the same email address is also set in the *-ReportSubmissionPolicy cmdlets:
- Microsoft integrated reporting using Microsoft reporting tools in Outlook: ReportJunkAddresses, ReportNotJunkAddresses, and ReportPhishAddresses (all three must be the same value).
- Microsoft integrated reporting using third-party reporting tools in Outlook: ThirdPartyReportAddresses.
When you use this cmdlet to set the email address of the reporting mailbox, the corresponding parameters in the *-ReportSubmissionPolicy cmdlets are not updated.
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. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet.
Examples
Example 1
New-ReportSubmissionRule -Name DefaultReportSubmissionRule -ReportSubmissionPolicy DefaultReportSubmissionPolicy -SentTo "userreportedmessages@contoso.onmicrosoft.com"This example creates the report submission rule. The reporting mailbox is userreportedmessages@contoso.onmicrosoft.com.
Parameters
-Comments
The Comments parameter specifies informative comments for the rule, such as what the rule is used for or how it has changed over time. The length of the comment can't exceed 1024 characters.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-Confirm
The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding.
- Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax:
-Confirm:$false. - Most other cmdlets (for example, New-* and Set-* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-Enabled
The Enabled parameter specifies whether the rule is enabled or disabled. Valid values are:
- $true: The rule is enabled. This is the default value.
- $false: The rule is disabled.
After you create the rule, use the Enable-ReportSubmissionRule and Disable-ReportSubmissionRule cmdlets to enable or disable the rule.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-Name
The Name parameter specifies the name of the report submission rule. When the rule is automatically created, the name of the rule is DefaultReportSubmissionRule. We recommend using this value to avoid confusion.
| Type: | String |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-ReportSubmissionPolicy
The ReportSubmissionPolicy parameter specifies the report submission policy that's associated with this rule. The only available policy is named DefaultReportSubmissionPolicy.
| Type: | ReportSubmissionPolicyIdParameter |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-SentTo
The SentTo parameter specifies the email address of the reporting mailbox in Exchange Online where user reported messages are sent.
The value of this parameter is meaningful only if reporting in Outlook is enabled, and user reported messages are sent to a reporting mailbox as configured in the *-ReportSubmissionPolicy cmdlets (either of the following scenarios):
- Microsoft integrated reporting is enabled using Microsoft reporting tools in Outlook:
-EnableThirdPartyAddress $false -ReportJunkToCustomizedAddress $true -ReportNotJunkToCustomizedAddress $true -ReportPhishToCustomizedAddress $true. - Microsoft integrated reporting is enabled using third-party reporting tools in Outlook:
-EnableReportToMicrosoft $false -EnableThirdPartyAddress $true -ReportJunkToCustomizedAddress $false -ReportNotJunkToCustomizedAddress $false -ReportPhishToCustomizedAddress $false.
If you set the email address of the reporting mailbox in the Microsoft Defender portal, the following parameters in the *-ReportSubmissionPolicy cmdlets are set to the same value:
- Microsoft integrated reporting using Microsoft reporting tools in Outlook: ReportJunkAddresses, ReportNotJunkAddresses, and ReportPhishAddresses (all three must be the same value).
- Microsoft integrated reporting using third-party reporting tools in Outlook: ThirdPartyReportAddresses.
When you use this cmdlet to set the email address of the reporting mailbox, the related parameter values in the *-ReportSubmissionPolicy cmdlets are not updated, which doesn't affect the functionality of the reporting mailbox. You should update the related values in the *-ReportSubmissionPolicy cmdlets for consistency and to avoid confusion.
| Type: | RecipientIdParameter[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-WhatIf
The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |