Set-PopSettings

 

Applies to: Exchange Server 2016

Topic Last Modified: 2016-08-19

This cmdlet is available only in on-premises Exchange Server 2016.

Use the Set-PopSettings cmdlet to modify the configuration of the Microsoft Exchange POP3 service. This service exists on Exchange servers that have the Client Access server role installed, and is used by POP3 clients to connect to Exchange.

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

Set-PopSettings [-AuthenticatedConnectionTimeout <EnhancedTimeSpan>] [-Banner <String>] [-CalendarItemRetrievalOption <iCalendar | intranetUrl | InternetUrl | Custom>] [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-EnableExactRFC822Size <$true | $false>] [-EnableGSSAPIAndNTLMAuth <$true | $false>] [-EnforceCertificateErrors <$true | $false>] [-ExtendedProtectionPolicy <None | Allow | Require>] [-ExternalConnectionSettings <MultiValuedProperty>] [-InternalConnectionSettings <MultiValuedProperty>] [-LogFileLocation <String>] [-LogFileRollOverSettings <Hourly | Daily | Weekly | Monthly>] [-LoginType <PlainTextLogin | PlainTextAuthentication | SecureLogin>] [-LogPerFileSizeQuota <Unlimited>] [-MaxCommandSize <Int32>] [-MaxConnectionFromSingleIP <Int32>] [-MaxConnections <Int32>] [-MaxConnectionsPerUser <Int32>] [-MessageRetrievalMimeFormat <TextOnly | HtmlOnly | HtmlAndTextAlternative | TextEnrichedOnly | TextEnrichedAndTextAlternative | BestBodyFormat | Tnef>] [-MessageRetrievalSortOrder <Ascending | Descending>] [-OwaServerUrl <Uri>] [-PreAuthenticatedConnectionTimeout <EnhancedTimeSpan>] [-ProtocolLogEnabled <$true | $false>] [-ProxyTargetPort <Int32>] [-Server <ServerIdParameter>] [-SSLBindings <MultiValuedProperty>] [-SuppressReadReceipt <$true | $false>] [-UnencryptedOrTLSBindings <MultiValuedProperty>] [-WhatIf [<SwitchParameter>]] [-X509CertificateName <String>]

This example sets the plain text or TLS connection to the server named MBX01. In this example, the connection uses an IP address of 10.0.0.0 and a port number of 995.

Set-PopSettings -Server "MBX01" -UnencryptedOrTLSBindings 10.0.0.0:995

This example turns on POP3 protocol logging. It also changes the POP3 protocol logging directory to C:\Pop3Logging.

Set-PopSettings -ProtocolLogEnabled $true -LogFileLocation "C:\Pop3Logging"

This example changes the POP3 protocol logging to create a new log file when a log file reaches 2 megabytes (MB).

Set-PopSettings -LogPerFileSizeQuota 2000000

This example changes the POP3 protocol logging to create a new log file every hour.

Set-PopSettings -LogPerFileSizeQuota 0 -LogFileRollOverSettings Hourly

You need to be assigned permissions before you can run this cmdlet. Although all parameters for this cmdlet are listed in this topic, you may not have access to some parameters if they're not included in the permissions assigned to you. To see what permissions you need, see the "POP3 settings" entry in the Clients and mobile devices permissions topic.

 

Parameter Required Type Description

AuthenticatedConnectionTimeout

Optional

Microsoft.Exchange.Data.EnhancedTimeSpan

The AuthenticatedConnectionTimeout parameter specifies the time to wait before closing an idle authenticated connection.

To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds.

Valid values are 00:00:30 to 1:00:00. The default value is 00:30:00 (30 minutes).

Banner

Optional

System.String

The Banner parameter specifies the text string that's displayed to connecting POP3 clients. The default value is: The Microsoft Exchange POP3 service is ready.

CalendarItemRetrievalOption

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.CalendarItemRetrievalOptions

The CalendarItemRetrievalOption parameter specifies the type of calendar item that's used by POP3 clients. Valid values are:

  • 0 or iCalendar. This is the default value.

  • 1 or intranetUrl.

  • 2 or InternetUrl.

  • 3 or Custom.

If you specify 3 or Custom, you need to specify a value for the OwaServerUrl parameter.

Confirm

Optional

System.Management.Automation.SwitchParameter

The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding.

  • Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false.

  • Most other cmdlets (for example, New-* and Set-* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com.

EnableExactRFC822Size

Optional

System.Boolean

The EnableExactRFC822Size parameter specifies whether Exchange calculates the exact size of each MIME message that can be retrieved from the server. Valid values are:

  • $true   Exchange calculates the exact size of the message. This value may be required for POP3 clients that expect the exact size of the message. However, this value can negatively affect performance, so you should only configure it when it's required by your POP3 clients.

  • $false   Exchange uses an approximate message size. This is the default value

EnableGSSAPIAndNTLMAuth

Optional

System.Boolean

The EnableGSSAPIAndNTLMAuth parameter specifies whether connections can use Integrated Windows authentication (NTLM) by using the Generic Security Services application programming interface (GSSAPI). This setting applies to connections where Transport Layer Security (TLS) is disabled. Valid values are:

  • $true    NTLM for POP3 connections is enabled. This is the default value.

  • $false   NTLM for POP3 connections is disabled.

EnforceCertificateErrors

Optional

System.Boolean

The EnforceCertificateErrors parameter specifies whether to enforce Secure Sockets Layer (SSL) certificate validation failures. Valid values are:.

  • $true    If the certificate isn't valid or doesn't match the target POP3 server's FQDN, the connection attempt fails.

  • $false   The server doesn't deny POP3 connections based on certificate errors. This is the default value.

ExtendedProtectionPolicy

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.ExtendedProtectionTokenCheckingMode

The ExtendedProtectionPolicy parameter specifies how Extended Protection for Authentication is used for POP3 connections. Valid values are:

  • None   Extended Protection for Authentication isn't used. This is the default value.

  • Allow   Extended Protection for Authentication is used only if it's supported by the incoming POP3 connection. If it's not, Extended Protection for Authentication isn't used.

  • Require   Extended Protection for Authentication is required for all POP3 connections. If the incoming POP3 connection doesn't support it, the connection is rejected.

Extended Protection for Authentication enhances the protection and handling of credentials by Integrated Windows authentication (also known as NTLM), so we strongly recommend that you use it if it's supported by your clients (default installations of Windows 7 or later and Windows Server 2008 R2 or later support it).

ExternalConnectionSettings

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The ExternalConnectionSettings parameter specifies the host name, port, and encryption method that's used by external POP3 clients (POP3 connections from outside your corporate network).

This parameter uses the syntax <HostName>:<Port>:[<TLS | SSL>]. The encryption method value is optional (blank indicates unencrypted connections).

The default value is blank ($null), which means no external POP3 connection settings are configured.

To enter multiple values and overwrite any existing entries, use the following syntax: <value1>,<value2>.... If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "<value1>","<value2>"....

To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="<value1>","<value2>"...; Remove="<value1>","<value2>"...}.

The combination of encryption methods and ports that are specified for this parameter need to match the corresponding encryption methods and ports that are specified by the SSLBindings and UnencryptedOrTLSBindings parameters.

InternalConnectionSettings

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The InternalConnectionSettings parameter specifies the host name, port, and encryption method that's used by internal POP3 clients (POP3 connections from inside your corporate network). This setting is also used when a POP3 connection is forwarded to another Exchange server that's running the Microsoft Exchange POP3 service.

This parameter uses the syntax <HostName>:<Port>:[<TLS | SSL>]. The encryption method value is optional (blank indicates unencrypted connections).

The default value is <ServerFQDN>:995:SSL,<ServerFQDN>:110:TLS.

To enter multiple values and overwrite any existing entries, use the following syntax: <value1>,<value2>.... If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "<value1>","<value2>"....

To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="<value1>","<value2>"...; Remove="<value1>","<value2>"...}.

The combination of encryption methods and ports that are specified for this parameter need to match the corresponding encryption methods and ports that are specified by the SSLBindings and UnencryptedOrTLSBindings parameters.

LogFileLocation

Optional

System.String

The LogFileLocation parameter specifies the location for the POP3 protocol log files. The default location is%ExchangeInstallPath%Logging\Pop3.

This parameter is only meaningful when the ProtocolLogEnabled parameter value is $true.

LogFileRollOverSettings

Optional

Microsoft.Exchange.Diagnostics.LogFileRollOver

The LogFileRollOverSettings parameter defines how frequently POP3 protocol logging creates a new log file. Valid values are:

  • 1 or Hourly.

  • 2 or Daily. This is the default value.

  • 3 or Weekly.

  • 4 or Monthly.

This parameter is only meaningful when the LogPerFileSizeQuota parameter value is 0, and the ProtocolLogEnabled parameter value is $true.

LoginType

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.LoginOptions

The LoginType parameter specifies the authentication method for POP3 connections. Valid values are:

  • 1 or PlainTextLogin.

  • 2 or PlainTextAuthentication.

  • 3 or SecureLogin. This is the default value.

LogPerFileSizeQuota

Optional

Microsoft.Exchange.Data.Unlimited

The LogPerFileSizeQuota parameter specifies the maximum size in bytes of a POP3 protocol log file.

When you enter a value, qualify the value with one of the following units:

  • B (bytes)

  • KB (kilobytes)

  • MB (megabytes)

  • GB (gigabytes)

  • TB (terabytes)

Unqualified values are typically treated as bytes, but small values may be rounded up to the nearest kilobyte.

The default value is 0, which means a new POP3 protocol log file is created at the frequency that's specified by the LogFileRollOverSettings parameter.

This parameter is only meaningful when the ProtocolLogEnabled parameter value is $true.

MaxCommandSize

Optional

System.Int32

The MaxCommandSize parameter specifies the maximum size in bytes of a single POP3 command. Valid values are from 40 through 1024. The default value is 512.

MaxConnectionFromSingleIP

Optional

System.Int32

The MaxConnectionFromSingleIP parameter specifies the maximum number of POP3 connections that are accepted by the Exchange server from a single IP address. Valid values are from 1 through 2147483647. The default value is 2147483647.

MaxConnections

Optional

System.Int32

The MaxConnections parameter specifies the maximum number of POP3 connections that are accepted by the Exchange server. Valid values are from 1 through 2147483647. The default value is 2147483647.

MaxConnectionsPerUser

Optional

System.Int32

The MaxConnectionsPerUser parameter specifies the maximum number of POP3 connections that are allowed for each user. Valid values are from 1 through 2147483647. The default value is 16.

MessageRetrievalMimeFormat

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.MimeTextFormat

The MessageRetrievalMimeFormat parameter specifies the MIME encoding of messages. Valid values are:

  • 0 or TextOnly.

  • 1 or HtmlOnly.

  • 2 or HtmlAndTextAlternative.

  • 3 or TextEnrichedOnly.

  • 4 or TextEnrichedAndTextAlternative.

  • 5 or BestBodyFormat. This is the default value.

  • 6 or Tnef.

MessageRetrievalSortOrder

Optional

Microsoft.Exchange.Data.SortOrder

The MessageRetrievalSortOrder parameter specifies how retrieved messages are sorted. Valid values are:

  • 0 or Ascending. This is the default value.

  • 1 or Descending.

OwaServerUrl

Optional

System.Uri

The OwaServerUrl parameter specifies the URL that's used to retrieve calendar information for instances of custom Outlook on the web calendar items.

PreAuthenticatedConnectionTimeout

Optional

Microsoft.Exchange.Data.EnhancedTimeSpan

The PreAuthenticatedConnectionTimeout parameter specifies the time to wait before closing an idle POP3 connection that isn't authenticated.

To specify a value, enter it as a time span: dd.hh:mm:ss where dd = days, hh = hours, mm = minutes, and ss = seconds.

Valid values are from00:00:30 to 1:00:00. The default value is 00:01:00 (one minute).

ProtocolLogEnabled

Optional

System.Boolean

The ProtocolLogEnabled parameter specifies whether to enable protocol logging for POP3. Valid values are:

  • $true    POP3 protocol logging is enabled.

  • $false   POP3 protocol logging is disabled. This is the default value.

ProxyTargetPort

Optional

System.Int32

The ProxyTargetPort parameter specifies the port on the Microsoft Exchange POP3 Backend service that listens for client connections that are proxied from the Microsoft Exchange POP3 service. The default value is 1995.

Server

Optional

Microsoft.Exchange.Configuration.Tasks.ServerIdParameter

The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example:

  • Name

  • FQDN

  • Distinguished name (DN)

  • Exchange Legacy DN

If you don't use this parameter, the command is run on the local server.

SSLBindings

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The SSLBindings parameter specifies the IP address and TCP port that's used for an SSL encrypted POP3 session. This parameter uses the syntax <IPv4OrIPv6Address>:<Port>.

The default value is [::]:995,0.0.0.0:995.

To enter multiple values and overwrite any existing entries, use the following syntax: <value1>,<value2>.... If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "<value1>","<value2>"....

To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="<value1>","<value2>"...; Remove="<value1>","<value2>"...}.

SuppressReadReceipt

Optional

System.Boolean

The SuppressReadReceipt parameter specifies whether to stop duplicate read receipts from being sent to POP3 clients that have the Send read receipts for messages I send setting configured in their POP3 email program. Valid values are:

  • $false   The sender receives a read receipt when the recipient downloads the message, and when the recipient opens the message. This is the default value.

  • $true   The sender receives a read receipt only when the recipient opens the message.

UnencryptedOrTLSBindings

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The UnencryptedOrTLSBindings parameter specifies the IP address and TCP port that's used for unencrypted or TLS encrypted POP3 connections. This parameter uses the syntax <IPv4OrIPv6Address>:<Port>.

The default value is [::]:110, 0.0.0.0:110.

To enter multiple values and overwrite any existing entries, use the following syntax: <value1>,<value2>.... If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "<value1>","<value2>"....

To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="<value1>","<value2>"...; Remove="<value1>","<value2>"...}.

WhatIf

Optional

System.Management.Automation.SwitchParameter

The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch.

X509CertificateName

Optional

System.String

The X509CertificateName parameter specifies the certificate that's used for encrypting POP3 client connections.

A valid value for this parameter is the FQDN from the ExternalConnectionSettings or InternalConnectionSettings parameters (for example, mail.contoso.com or mailbox01.contoso.com).

If you use a single subject certificate or a subject alternative name (SAN) certificate, you also need to assign the certificate to the Exchange POP service. For more information, see Assign certificates to Exchange 2016 services.

If you use a wildcard certificate, you don't need to assign the certificate to the Exchange POP service.

To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types. If the Input Type field for a cmdlet is blank, the cmdlet doesn’t accept input data.

To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types. If the Output Type field is blank, the cmdlet doesn’t return data.

 
Show: