Set-QuarantinePermissions

Reference

Module:: ExchangePowerShell

Applies to:: Exchange Online, Exchange Online Protection

This cmdlet is available only in the cloud-based service.

Use the New-QuarantinePermissions cmdlet to modify quarantine permissions objects to use with the EndUserQuarantinePermission parameter on the New-QuarantinePolicy or Set-QuarantinePolicy cmdlets. This cmdlet works only on a permission object that was created by the New-QuarantinePermissions cmdlet and stored in a variable that's currently available in the Windows PowerShell session.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Syntax

Set-QuarantinePermissions
   -QuarantinePermissionsObject <QuarantinePermissions>
   [[-PermissionToAllowSender] <Boolean>]
   [[-PermissionToBlockSender] <Boolean>]
   [[-PermissionToDelete] <Boolean>]
   [[-PermissionToDownload] <Boolean>]
   [[-PermissionToPreview] <Boolean>]
   [[-PermissionToRelease] <Boolean>]
   [[-PermissionToRequestRelease] <Boolean>]
   [[-PermissionToViewHeader] <Boolean>]
   [<CommonParameters>]

Description

To see the current value of the permissions object that you want to modify, run the variable name as a command. For example, run the command $Perms to see the quarantine policy permissions stored in the $Perms variable.

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

Set-QuarantinePermissions -QuarantinePermissionsObject $Perms -PermissionToRequestRelease $true -PermissionToRelease $false

This example modifies the specified quarantine policy permissions in the exiting $Perms permissions object that was created previously in the same Windows PowerShell session (the $Perms variable is still available and populated).

In the same Windows PowerShell session, you can use $Perms for the EndUserQuarantinePermissions parameter value in a New-QuarantinePolicy or Set-QuarantinePolicy command.

Parameters

-PermissionToAllowSender

The PermissionToBlockSender parameter specifies whether users are allowed to add the quarantined message sender to their Safe Senders list. Valid values are:

$true: Allow sender is available for affected messages in quarantine.
$false: Allow sender isn't available for affected messages in quarantine. This is the default value.

Type:	Boolean
Position:	1
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Online, Exchange Online Protection

-PermissionToBlockSender

The PermissionToBlockSender parameter specifies whether users are allowed to add the quarantined message sender to their Blocked Senders list. Valid values are:

$true: Block sender is available in quarantine notifications for affected messages, and Block sender is available for affected messages in quarantine.
$false: Block sender isn't available in quarantine notifications for affected messages, and Block sender isn't available for affected messages in quarantine. This is the default value.

Type:	Boolean
Position:	2
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Online, Exchange Online Protection

-PermissionToDelete

The PermissionToDelete parameter specifies whether users are allowed to delete messages from quarantine. Valid values are:

$true: Delete messages and Delete from quarantine are available for affected messages in quarantine.
$false: Delete messages and Delete from quarantine aren't available for affected messages in quarantine. This is the default value.

Type:	Boolean
Position:	3
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Online, Exchange Online Protection

-PermissionToDownload

The PermissionToDownload parameter specifies whether users are allowed to download messages from quarantine. Valid values are:

$true: The permission is enabled.
$false: The permission is disabled. This is the default value.

Currently, this value has no effect on the available actions in quarantine notifications or quarantine for affected messages. End-users can't download quarantined messages.

Type:	Boolean
Position:	4
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Online, Exchange Online Protection

-PermissionToPreview

The PermissionToPreview parameter specifies whether users are allowed to preview quarantined messages. Valid values are:

$true: Preview message is available for affected messages in quarantine.
$false: Preview message isn't available for affected messages in quarantine. This is the default value.

Type:	Boolean
Position:	5
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Online, Exchange Online Protection

-PermissionToRelease

The PermissionToRelease parameter specifies whether users are allowed to directly release affected messages from quarantine. Valid values are:

$true: Release is available in quarantine notifications for affected messages, and Release (Release email) is available for affected messages in quarantine.
$false: Release message isn't available in quarantine notifications for affected messages, and Release and Release email aren't available for affected messages in quarantine.

Don't set this parameter and the PermissionToRequestRelease parameter to $true. Set one parameter to $true and the other to $false, or set both parameters to $false.

Type:	Boolean
Position:	6
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Online, Exchange Online Protection

-PermissionToRequestRelease

The PermissionToRequestRelease parameter specifies whether users are allowed to request messages to be released from quarantine. The request must be approved by an admin. Valid values are:

$true: Request Release is available in quarantine notifications for affected messages, and Request release is available for affected messages in quarantine.
$false: Request Release isn't available in quarantine notifications for affected messages, and Request release isn't available for affected messages in quarantine.

Don't set this parameter and the PermissionRelease parameter to $true. Set one parameter to $true and the other to $false, or set both parameters to $false.

Type:	Boolean
Position:	7
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Online, Exchange Online Protection

-PermissionToViewHeader

The PermissionToViewHeader parameter specifies whether users are allowed to view the message headers of quarantined messages. Valid values are:

$true: The permission is enabled.
$false: The permission is disabled. This is the default value.

Currently, this value has no effect on available actions in quarantine notifications or quarantine for affected messages. View message header is always available for affected messages in quarantine.

Type:	Boolean
Position:	8
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Online, Exchange Online Protection

-QuarantinePermissionsObject

The QuarantinePermissionsObject parameter specifies the variable that contains quarantine permissions object that you want to modify. For example if you ran the command $Perms = New-QuarantinePermissions <permissions>, use the value $Perms for this parameter.

Type:	QuarantinePermissions
Position:	9
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Online, Exchange Online Protection

Share via