Skip to content

Commit c764068

Browse files
chrisdachrisda
authored
Merge pull request MicrosoftDocs#2467 from MicrosoftDocs/chrisda
Added Get-OMEMessageStatus and Set-OMEMessageRevocation
2 parents 5ebf9a1 + 05f4707 commit c764068

File tree

2 files changed

+169
-0
lines changed

2 files changed

+169
-0
lines changed

‎exchange/exchange-ps/exchange/encryption-and-certificates/Get-OMEMessageStatus.md

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
---
2+
external help file: Microsoft.Exchange.WebClient-Help.xml
3+
applicable: Exchange Online
4+
title: Get-OMEMessageStatus
5+
schema: 2.0.0
6+
monikerRange: "exchonline-ps"
7+
---
8+
9+
# Get-OMEMessageStatus
10+
11+
## SYNOPSIS
12+
This cmdlet is available only in the cloud-based service.
13+
14+
Use the Get-OMEMessageStatus cmdlet to view the Microsoft Office 365 Message Encryption (OME) revocation status for a specific message.
15+
16+
For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx).
17+
18+
## SYNTAX
19+
20+
```
21+
Get-OMEMessageStatus -MessageId <String> [<CommonParameters>]
22+
```
23+
24+
## DESCRIPTION
25+
If encryption for the message was successfully revoked, the command will return the message: The encrypted email with the subject "\<subject\>" and Message ID "\<messageId>\" was successfully revoked.
26+
27+
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 (https://technet.microsoft.com/library/mt432940.aspx).
28+
29+
## EXAMPLES
30+
31+
### Example 1
32+
```
33+
Get-OMEMessageStatus -MessageId "<d9683b4c-127b-413a-ae2e-fa7dfb32c69d@DM3NAM06BG401.Eop-nam06.prod.protection.outlook.com>"
34+
```
35+
36+
This example returns the encryption revocation status for the specified message.
37+
38+
## PARAMETERS
39+
40+
### -MessageId
41+
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. This may include angle brackets.
42+
43+
You can find the Message ID for a message in Message Trace or the Message Encryption Report in the Office 365 Security & Compliance Center.
44+
45+
```yaml
46+
Type: String
47+
Parameter Sets: (All)
48+
Aliases:
49+
Applicable: Exchange Online
50+
Required: True
51+
Position: Named
52+
Default value: None
53+
Accept pipeline input: False
54+
Accept wildcard characters: False
55+
```
56+
57+
### CommonParameters
58+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
59+
60+
## INPUTS
61+
62+
###
63+
To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data.
64+
65+
## OUTPUTS
66+
67+
###
68+
To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data.
69+
70+
## NOTES
71+
72+
## RELATED LINKS
73+
74+
[Online Version](https://docs.microsoft.com/powershell/module/exchange/encryption-and-certificates/get-omemessagestatus)

‎exchange/exchange-ps/exchange/encryption-and-certificates/Set-OMEMessageRevocation.md

Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
---
2+
external help file: Microsoft.Exchange.WebClient-Help.xml
3+
applicable: Exchange Online
4+
title: Set-OMEMessageRevocation
5+
schema: 2.0.0
6+
monikerRange: "exchonline-ps"
7+
---
8+
9+
# Set-OMEMessageRevocation
10+
11+
## SYNOPSIS
12+
This cmdlet is available only in the cloud-based service.
13+
14+
Use the Set-OMEMessageRevocation cmdlet to revoke Microsoft Office 365 Message Encryption (OME) for a message. Revoking encryption prevents the recipient from viewing the message in the Office 365 Message Encryption portal.
15+
16+
For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx).
17+
18+
## SYNTAX
19+
20+
```
21+
Set-OMEMessageRevocation -MessageId <String> -Revoke <Boolean> [<CommonParameters>]
22+
```
23+
24+
## DESCRIPTION
25+
When an email has been revoked, the recipient will get the following error when they try to view the encrypted message in the Office 365 Message Encryption portal: "The message has been revoked by the sender".
26+
27+
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.
28+
29+
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 (https://technet.microsoft.com/library/mt432940.aspx).
30+
31+
## EXAMPLES
32+
33+
### Example 1
34+
```
35+
Set-OMEMessageRevocation -MessageId "<d9683b4c-127b-413a-ae2e-fa7dfb32c69d@DM3NAM06BG401.Eop-nam06.prod.protection.outlook.com>" -Revoke $true
36+
```
37+
38+
This example revokes encryption for the specified message.
39+
40+
## PARAMETERS
41+
42+
### -MessageId
43+
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. This may include angle brackets.
44+
45+
You can find the Message ID for a message in Message Trace or the Message Encryption Report in the Office 365 Security & Compliance Center.
46+
47+
```yaml
48+
Type: String
49+
Parameter Sets: (All)
50+
Aliases:
51+
Applicable: Exchange Online
52+
Required: True
53+
Position: Named
54+
Default value: None
55+
Accept pipeline input: False
56+
Accept wildcard characters: False
57+
```
58+
59+
### -Revoke
60+
The Revoke parameter specifies whether to revoke encryption for the message. Valid values are:
61+
62+
- $true: Encryption for the specified message is revoked. The recipient will get an error when they try to view the encrypted message in the Office 365 Message Encryption portal
63+
64+
- $false: Encryption for the specified message isn't revoked. This is the default value.
65+
66+
```yaml
67+
Type: Boolean
68+
Parameter Sets: (All)
69+
Aliases:
70+
Applicable: Exchange Online
71+
Required: True
72+
Position: Named
73+
Default value: None
74+
Accept pipeline input: False
75+
Accept wildcard characters: False
76+
```
77+
78+
### CommonParameters
79+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
80+
81+
## INPUTS
82+
83+
###
84+
To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data.
85+
86+
## OUTPUTS
87+
88+
###
89+
To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data.
90+
91+
## NOTES
92+
93+
## RELATED LINKS
94+
95+
[Online Version](https://docs.microsoft.com/powershell/module/exchange/encryption-and-certificates/set-omemessagerevocation)

0 commit comments

Comments
 (0)