Set-OMEMessageRevocation

Reference

Module:: ExchangePowerShell

Applies to:: Exchange Online

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

Use the Set-OMEMessageRevocation cmdlet to revoke Microsoft Purview Message Encryption for a message. Revoking encryption prevents the recipient from viewing the message in the OME portal.

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

Syntax

Set-OMEMessageRevocation
   -MessageId <String>
   -Revoke <Boolean>
   [<CommonParameters>]

Description

When an email has been revoked, the recipient will get the following error when they try to view the encrypted message in the OME portal: "The message has been revoked by the sender".

You can revoke encrypted messages if the recipient received a link-based, branded encrypted email message. If the recipient received a native inline experience in a supported Outlook client, then you can't revoke encryption for the message.

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-OMEMessageRevocation -MessageId "<d9683b4c-127b-413a-ae2e-fa7dfb32c69d@DM3NAM06BG401.Eop-nam06.prod.protection.outlook.com>" -Revoke $true

This example revokes encryption for the specified message.

Parameters

-MessageId

The MessageId parameter specifies the message based on the value the Message-ID header field. This value is also known as the Client ID. The format of the Message-ID depends on the messaging server that sent the message. The value should be unique for each message. However, not all messaging servers create values for the Message-ID in the same way. Be sure to include the full Message ID string (which may include angle brackets) and enclose the value in quotation marks (for example, "d9683b4c-127b-413a-ae2e-fa7dfb32c69d@DM3NAM06BG401.Eop-nam06.prod.protection.outlook.com").

You can find the Message ID for a message in Message Trace or the Message Encryption Report in the Microsoft Purview compliance portal.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Online

-Revoke

The Revoke parameter specifies whether to revoke encryption for the message. Valid values are:

$true: Encryption for the specified message is revoked. The recipient will get an error when they try to view the encrypted message in the OME portal
$false: Encryption for the specified message isn't revoked. This is the default value.

Type:	Boolean
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Online