Commands › Exchange Online

Set-OMEConfiguration

Exchange Online ExchangeOnlineManagement Set-*

Configure Microsoft Purview Message Encryption.

Quick start script

# Set-OMEConfiguration — quick start (serv365.ai)
# 1. Connect (app-only shown; interactive: omit the certificate parameters)
Connect-ExchangeOnline -CertificateThumbprint $thumb -AppId $appId -Organization $org

# 2. Capture the current state first — you cannot roll back what you never recorded
$before = Get-OMEConfiguration
$before | Format-List

# 3. Make the change (dry run first)
Set-OMEConfiguration -Identity <OMEConfigurationIdParameter> -WhatIf
Set-OMEConfiguration -Identity <OMEConfigurationIdParameter>

# 4. Verify and diff
$after = Get-OMEConfiguration
Compare-Object ($before | Out-String) ($after | Out-String)

Syntax

Set-OMEConfiguration [-Identity] <OMEConfigurationIdParameter>
 [-BackgroundColor <String>]
 [-Confirm]
 [-DisclaimerText <String>]
 [-EmailText <String>]
 [-ExternalMailExpiryInDays <Int32>]
 [-Image <Byte[]>]
 [-IntroductionText <String>]
 [-OTPEnabled <Boolean>]
 [-PortalText <String>]
 [-PrivacyStatementUrl <String>]
 [-ReadButtonText <String>]
 [-SocialIdSignIn <Boolean>]
 [-WhatIf]
 [<CommonParameters>]

Parameters (14)

Parameter	Type	Required	What it controls
-Identity	OMEConfigurationIdParameter	yes	The Identity parameter specifies the OME configuration that you want to modify. The default OME configuration has the Identity value "OME Configuration".
-BackgroundColor	String		The BackgroundColor parameter specifies the background color. Valid values are:
-Confirm	SwitchParameter		The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on whether the cmdlet requires confirmation before proceeding.
-DisclaimerText	String		The DisclaimerText parameter specifies the disclaimer text in the email that contains the encrypted message. The maximum length is 1024 characters. If the value contains spaces, enclose the value in quotation marks (").
-EmailText	String		The EmailText parameter specifies the default text that accompanies encrypted email messages. The default text appears above the instructions for viewing encrypted messages. The maximum length is 1024 characters. If...
-ExternalMailExpiryInDays	String		This parameter is available only with a Microsoft 365 Advanced Message Encryption subscription.
-Image	Byte[]		The Image parameter identifies and uploads an image to be displayed in the email message and in the Microsoft 365 admin center.
-IntroductionText	String		The IntroductionText parameter specifies the text that appears next to the sender's name and email address. If the value contains spaces, enclose the value in quotation marks (").
-OTPEnabled	Boolean		The OTPEnabled parameter specifies whether to allow recipients to use a one-time passcode to view encrypted messages. Valid values are:
-PortalText	String		The PortalText parameter specifies the text that appears at the top of the encrypted mail viewing portal. The maximum length is 128 characters. If the value contains spaces, enclose the value in quotation marks (").
-PrivacyStatementUrl	String		The PrivacyStatementUrl parameter specifies the Privacy Statement link in the encrypted email notification message.
-ReadButtonText	String		The ReadButtonText parameter specifies the text that appears on the "Read the message" button. If the value contains spaces, enclose the value in quotation marks (").
-SocialIdSignIn	Boolean		The SocialIdSignIn parameter specifies whether a user is allowed to view an encrypted message in the Microsoft 365 admin center using their own social network id (Google, Yahoo, and Microsoft account). Valid values are:
-WhatIf	SwitchParameter		This parameter is reserved for internal Microsoft use.

Reference facts derived from Microsoft documentation, © Microsoft, licensed CC BY 4.0; restructured with original guidance by serv365.ai.