Merge pull request MicrosoftDocs#3316 from samschan-ms/patch-1

Patch 1

Author: chrisda

exchange/exchange-ps/exchange/encryption-and-certificates/New-OMEConfiguration.md

@@ -0,0 +1,258 @@
+---
+external help file: Microsoft.Exchange.WebClient-Help.xml
+applicable: Exchange Online
+title: New-OMEConfiguration
+schema: 2.0.0
+monikerRange: "exchonline-ps"
+---
+
+# New-OMEConfiguration
+
+## SYNOPSIS
+This cmdlet is available only in the cloud-based service.
+
+Use the New-OMEConfiguration cmdlet to create a Microsoft Office 365 Message Encryption (OME) configuration.
+
+For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx).
+
+## SYNTAX
+
+```
+New-OMEConfiguration [-Identity] <OrganizationIdParameter>
+ [-BackgroundColor <String>]
+ [-DisclaimerText <String>]
+ [-EmailText <String>]
+ [-ExternalMailExpiryInDays <Int32>]
+ [-Image <Byte[]>] 
+ [-Identity <String>]
+ [-IntroductionText <String>]
+ [-OTPEnabled <$true | $false>]
+ [-PortalText <String>]
+ [-ReadButtonText <String>]
+ [-SocialIdSignIn <$true | $false>]
+ [<CommonParameters>]
+```
+
+## DESCRIPTION
+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).
+
+## EXAMPLES
+
+### Example 1
+```
+New-OMEConfiguration -Identity "Expire in 7 days" ExternalMailExpiryInDays 7
+```
+
+This example configures encrypted email messages that are sent to external recipients to expire after 7 days.
+
+## PARAMETERS
+
+### -Identity
+The Identity parameter specifies a unique name for the OME configuration object. The maximum length is 64 characters. If the value contains spaces, enclose the value in quotation marks (").
+
+```yaml
+Type: OrganizationIdParameter
+Parameter Sets: (All)
+Aliases:
+Applicable: Exchange Online
+Required: True
+Position: 0
+Default value: None
+Accept pipeline input: True (ByValue)
+Accept wildcard characters: False
+```
+
+### -BackgroundColor
+The BackgroundColor parameter specifies the background color. Valid values are:
+
+- An available HTML hexadecimal \(hex triplet\) color code value \(for example, 0x000000 is white\).
+
+- An available text value \(for example, yellow is 0x00FFFF00\).
+
+- $null \(blank\). This is the default value.
+
+For the list of available hex and text values, see Background colors for Office 365 Message Encryption (https://support.office.com/article/1508cb35-c5ff-4523-b579-947b21d5515f). 
+
+```yaml
+Type: String
+Parameter Sets: (All)
+Aliases:
+Applicable: Exchange Online
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -DisclaimerText
+The DisclaimerText parameter specifies the disclaimer text in the email that contains the encrypted message. The maximum length is 1024 characters.
+
+To remove existing text and use the default value, use the value $null for this parameter.
+
+```yaml
+Type: String
+Parameter Sets: (All)
+Aliases:
+Applicable: Exchange Online
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -EmailText
+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.
+
+To remove existing text and use the default value, use the value $null for this parameter.
+
+```yaml
+Type: String
+Parameter Sets: (All)
+Aliases:
+Applicable: Exchange Online
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -ExternalMailExpiryInDays
+The ExternalMailExpiryInDays parameter specifies when access to the mail through the Office 365 web portal will expire.  The range of the parameter is between 1 and 730.
+
+```yaml
+Type: Int32
+Parameter Sets: (All)
+Aliases:
+Applicable: Exchange Online
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -Image
+The Image parameter identifies and uploads an image that will be displayed in the email message and in the Office 365 portal.
+
+You need to read the file to a byte-encoded object using the Get-Content cmdlet, for example, -Image (Get-Content "C:\\Temp\\OME Logo.gif" -Encoding byte)
+
+- Supported file formats: .png, .jpg, .bmp, or .tiff
+
+- Optimal size of logo file: less than 40 KB
+
+- Optimal dimensions of logo image: 170x70 pixels
+
+To remove an existing image and use the default image, use the value $null for this parameter.
+
+```yaml
+Type: Byte[]
+Parameter Sets: (All)
+Aliases:
+Applicable: Exchange Online
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -IntroductionText
+The IntroductionText parameter specifies the default text that accompanies encrypted email messages. The default text appears below the recipient email address for viewing encrypted message.
+
+```yaml
+Type: String
+Parameter Sets: (All)
+Aliases:
+Applicable: Exchange Online
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -OTPEnabled
+The OTPEnabled parameter specifies whether to allow recipients to use a one-time passcode to view encrypted messages. Valid values are:
+
+- $true: Recipients can use a one-time passcode to view encrypted messages. This is the default value.
+
+- $false: Recipients can't use a one-time passcode to view encrypted messages. The recipient is required to sign in using an Office 365 work or school account.
+
+```yaml
+Type: $true | $false
+Parameter Sets: (All)
+Aliases:
+Applicable: Exchange Online
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -PortalText
+The PortalText parameter specifies the text that appears at the top of the encrypted mail viewing portal. The maximum length is 128 characters.
+
+To remove existing text and use the default value, use the value $null for this parameter.
+
+```yaml
+Type: String
+Parameter Sets: (All)
+Aliases:
+Applicable: Exchange Online
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -ReadButtonText
+The ReadButtonText parameter specifies the default text on the Read email button that accompanies encrypted email messages.
+
+```yaml
+Type: String
+Parameter Sets: (All)
+Aliases:
+Applicable: Exchange Online
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -SocialIdSignIn
+The SocialIdSignIn parameter specifies whether a user is allowed to view an encrypted message in the Office 365 portal using their own social network id (Google, Yahoo, etc).
+
+```yaml
+Type: $true | $false
+Parameter Sets: (All)
+Aliases:
+Applicable: Exchange Online
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### CommonParameters
+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).
+
+## INPUTS
+
+###  
+
+## OUTPUTS
+
+###  
+
+## NOTES
+
+## RELATED LINKS
+
+[Online Version](https://docs.microsoft.com/powershell/module/exchange/encryption-and-certificates/New-OMEConfiguration)