New-QuarantinePolicy
This cmdlet is available only in the cloud-based service.
Use the New-QuarantinePolicy cmdlet to create quarantine policies in your cloud-based organization.
For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.
Syntax
Default (Default)
New-QuarantinePolicy
[-Name] <String>
[-AdminDisplayName <String>]
[-AdminNotificationFrequencyInDays <Int32>]
[-AdminNotificationLanguage <EsnLanguage>]
[-AdminNotificationsEnabled <Boolean>]
[-AdminQuarantinePermissionsList <MultiValuedProperty>]
[-CustomDisclaimer <String>]
[-DomainController <Fqdn>]
[-EndUserQuarantinePermissions <QuarantinePermissions>]
[-EndUserQuarantinePermissionsValue <Int32>]
[-EndUserSpamNotificationCustomFromAddress <String>]
[-EndUserSpamNotificationFrequency <TimeSpan>]
[-EndUserSpamNotificationFrequencyInDays <Int32>]
[-EndUserSpamNotificationLanguage <EsnLanguage>]
[-EsnCustomSubject <MultiValuedProperty>]
[-ESNEnabled <Boolean>]
[-IncludeMessagesFromBlockedSenderAddress <Boolean>]
[-MultiLanguageCustomDisclaimer <MultiValuedProperty>]
[-MultiLanguageSenderName <MultiValuedProperty>]
[-MultiLanguageSetting <MultiValuedProperty>]
[-OrganizationBrandingEnabled <Boolean>]
[-QuarantinePolicyType <QuarantinePolicyType>]
[-QuarantineRetentionDays <Int32>]
[<CommonParameters>]
Description
Quarantine policies define what users are allowed to do to quarantined messages based on why the message was quarantined (for supported features) and quarantine notification settings. For more information, see Quarantine policies.
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.
Examples
Example 1
New-QuarantinePolicy -Name ContosoTag -EndUserQuarantinePermissionsValue 0
This example creates a new quarantine policy named ContosoTag with the same permissions as the No access preset permissions group.
To assign Limited access permissions, use the value 27. To assign Full access permissions, use the value 23.
Parameters
-AdminDisplayName
Applicable: Exchange Online, Exchange Online Protection
The AdminDisplayName parameter specifies a description for the quarantine policy. If the value contains spaces, enclose the value in quotation marks (").
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-AdminNotificationFrequencyInDays
Applicable: Exchange Online, Exchange Online Protection
This parameter is reserved for internal Microsoft use.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-AdminNotificationLanguage
Applicable: Exchange Online, Exchange Online Protection
This parameter is reserved for internal Microsoft use.
Parameter properties
| Type: | EsnLanguage |
| Default value: | None |
| Accepted values: | Default, English, French, German, Italian, Japanese, Spanish, Korean, Portuguese, Russian, ChineseSimplified, ChineseTraditional, Amharic, Arabic, Bulgarian, BengaliIndia, Catalan, Czech, Cyrillic, Danish, Greek, Estonian, Basque, Persian, Finnish, Filipino, Galician, Gujarati, Hebrew, Hindi, Croatian, Hungarian, Indonesian, Icelandic, Kazakh, Kannada, Lithuanian, Latvian, Malayalam, Marathi, Malay, Dutch, NorwegianNynorsk, Norwegian, Odia, Polish, PortuguesePortugal, Romanian, Slovak, Slovenian, SerbianCyrillic, Serbian, Swedish, Swahili, Tamil, Telugu, Thai, Turkish, Ukrainian, Urdu, Vietnamese |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-AdminNotificationsEnabled
Applicable: Exchange Online, Exchange Online Protection
This parameter is reserved for internal Microsoft use.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-AdminQuarantinePermissionsList
Applicable: Exchange Online, Exchange Online Protection
This parameter is reserved for internal Microsoft use.
Parameter properties
| Type: | MultiValuedProperty |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-CustomDisclaimer
Applicable: Exchange Online, Exchange Online Protection
This parameter is reserved for internal Microsoft use.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-DomainController
Applicable: Exchange Online, Exchange Online Protection
This parameter is reserved for internal Microsoft use.
Parameter properties
| Type: | Fqdn |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-EndUserQuarantinePermissions
Applicable: Exchange Online, Exchange Online Protection
Note: To set permissions in quarantine policies, we recommend using the EndUserQuarantinePermissionsValue parameter.
The EndUserQuarantinePermissions specifies the end-user permissions for the quarantine policy by using a variable from the output of a New-QuarantinePermissions or Set-QuarantinePermissions command.
For example, run the following command to store the required permissions in a variable: $Perms = New-QuarantinePermissions <permissions>. In the same PowerShell session, use the value $Perms for this parameter.
Parameter properties
| Type: | QuarantinePermissions |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-EndUserQuarantinePermissionsValue
Applicable: Exchange Online, Exchange Online Protection
The EndUserQuarantinePermissionsValue parameter specifies the end-user permissions for the quarantine policy.
This parameter uses a decimal value that's converted from a binary value. The binary value corresponds to the list of available permissions in a specific order. For each permission, the value 1 equals True and the value 0 equals False. The required order is described in the following list from highest (1000000 or 128) to lowest (00000001 or 1):
- PermissionToViewHeader: The value 0 doesn't hide the View message header action in quarantine. If the message is visible in quarantine, the action is always available for the message.
- PermissionToDownload: This permission is not used (the value 0 or 1 does nothing).
- PermissionToAllowSender
- PermissionToBlockSender
- PermissionToRequestRelease: Don't set this permission and PermissionToRelease to the value 1. Set one value to 1 and the other value to 0, or set both values to 0.
- PermissionToRelease: Don't set this permission and PermissionToRequestRelease to value 1. Set one value to 1 and the other value to 0, or set both values to 0. This permission isn't honored for messages that were quarantined as malware or high confidence phishing. If the quarantine policy gives users this permission, users are allowed to request the release of their quarantined malware or high confidence phishing messages as if PermissionToRequestRelease was selected instead.
- PermissionToPreview
- PermissionToDelete
The values for the preset end-user permission groups are described in the following list:
- No access: Binary = 0000000, so use the decimal value 0.
- Limited access: Binary = 00101011, so use the decimal value 43.
- Full access: Binary = 00100111, so use the decimal value 39.
For custom permissions, get the binary value that corresponds to the permissions you want. Convert the binary value to a decimal value to use. Don't use the binary value for this parameter.
Note: If the value of this parameter is 0 (No access) and the value of the ESNEnabled parameter is $true, users can view their messages in quarantine, but the only available action for the messages is View message header.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-EndUserSpamNotificationCustomFromAddress
Applicable: Exchange Online, Exchange Online Protection
The EndUserSpamNotificationCustomFromAddress specifies the email address of an existing internal sender to use as the sender for quarantine notifications.
If you don't use this parameter, the default sender is quarantine@messaging.microsoft.com.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-EndUserSpamNotificationFrequency
Applicable: Exchange Online, Exchange Online Protection
The EndUserSpamNotificationFrequency parameter specifies how often quarantine notifications are sent to users. Valid values are:
- 04:00:00 (4 hours)
- 1.00:00:00 (1 day)
- 7.00:00:00 (7 days)
Parameter properties
| Type: | TimeSpan |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-EndUserSpamNotificationFrequencyInDays
Applicable: Exchange Online, Exchange Online Protection
This parameter is reserved for internal Microsoft use.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-EndUserSpamNotificationLanguage
Applicable: Exchange Online, Exchange Online Protection
This parameter is reserved for internal Microsoft use.
Parameter properties
| Type: | EsnLanguage |
| Default value: | None |
| Accepted values: | Default, English, French, German, Italian, Japanese, Spanish, Korean, Portuguese, Russian, ChineseSimplified, ChineseTraditional, Amharic, Arabic, Bulgarian, BengaliIndia, Catalan, Czech, Cyrillic, Danish, Greek, Estonian, Basque, Persian, Finnish, Filipino, Galician, Gujarati, Hebrew, Hindi, Croatian, Hungarian, Indonesian, Icelandic, Kazakh, Kannada, Lithuanian, Latvian, Malayalam, Marathi, Malay, Dutch, NorwegianNynorsk, Norwegian, Odia, Polish, PortuguesePortugal, Romanian, Slovak, Slovenian, SerbianCyrillic, Serbian, Swedish, Swahili, Tamil, Telugu, Thai, Turkish, Ukrainian, Urdu, Vietnamese |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-EsnCustomSubject
Applicable: Exchange Online, Exchange Online Protection
The EsnCustomSubject parameter specifies the text to use in the Subject field of quarantine notifications.
You can specify multiple values separated by commas using the syntax: ('value1',''value2',...'valueN'). For each language that you specify with the MultiLanguageSetting parameter, you need to specify unique Sender text. Be sure to align the corresponding MultiLanguageSetting, MultiLanguageCustomDisclaimer, EsnCustomSubject, and MultiLanguageSenderName parameter values in the same order.
To modify an existing value and preserve other values, you need to specify all existing values and the new value in the existing order.
This setting is available only in the built-in quarantine policy named DefaultGlobalTag that controls global quarantine policy settings. To access this quarantine policy, start your command with the following syntax: Get-QuarantinePolicy -QuarantinePolicyType GlobalQuarantinePolicy | Set-QuarantinePolicy ....
Parameter properties
| Type: | MultiValuedProperty |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | MultiValuedProperty |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ESNEnabled
Applicable: Exchange Online, Exchange Online Protection
The ESNEnabled parameter specifies whether to enable quarantine notifications (formerly known as end-user spam notifications) for the policy. Valid values are:
- $true: Quarantine notifications are enabled.
- $false: Quarantine notifications are disabled. User can only access quarantined messages in quarantine, not in email notifications. This value is the default.
Note: If the value of this parameter is $true and the value of the EndUserQuarantinePermissionsValue parameter is 0 (No access where all permissions are turned off), users can see their messages in quarantine, but the only available action for the messages is View message header.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-IncludeMessagesFromBlockedSenderAddress
Applicable: Exchange Online, Exchange Online Protection
The IncludeMessagesFromBlockedSenderAddress parameter specifies whether to send quarantine notifications for quarantined messages from blocked sender addresses. Valid values are:
- $true: Recipients get quarantine notifications for affected messages from blocked senders.
- $false: Recipients don't get quarantine notifications for affected messages from blocked senders. This value is the default.
Parameter properties
| Type: | Boolean |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-MultiLanguageCustomDisclaimer
Applicable: Exchange Online, Exchange Online Protection
This parameter is reserved for internal Microsoft use.
Parameter properties
| Type: | MultiValuedProperty |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-MultiLanguageSenderName
Applicable: Exchange Online, Exchange Online Protection
This parameter is reserved for internal Microsoft use.
Parameter properties
| Type: | MultiValuedProperty |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-MultiLanguageSetting
Applicable: Exchange Online, Exchange Online Protection
This parameter is reserved for internal Microsoft use.
Parameter properties
| Type: | MultiValuedProperty |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Name
Applicable: Exchange Online, Exchange Online Protection
The Name parameter specifies a unique name for the quarantine policy. If the value contains spaces, enclose the value in quotation marks (").
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-OrganizationBrandingEnabled
Applicable: Exchange Online, Exchange Online Protection
This parameter is reserved for internal Microsoft use.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-QuarantinePolicyType
Applicable: Exchange Online, Exchange Online Protection
This parameter is reserved for internal Microsoft use.
Parameter properties
| Type: | QuarantinePolicyType |
| Default value: | None |
| Accepted values: | QuarantinePolicy, GlobalQuarantinePolicy |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-QuarantineRetentionDays
Applicable: Exchange Online, Exchange Online Protection
This parameter is reserved for internal Microsoft use.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
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.