Export (0) Print
Expand All

Set-PopSettings

Applies to: Exchange Server 2010

Topic Last Modified: 2011-03-19

Use the Set-PopSettings cmdlet to set specific POP3 settings for the server running Microsoft Exchange Server 2010 that has the Client Access server role installed and that's running the Microsoft Exchange POP3 service.


Set-PopSettings [-AuthenticatedConnectionTimeout <EnhancedTimeSpan>] [-Banner <String>] [-CalendarItemRetrievalOption <iCalendar | intranetUrl | InternetUrl | Custom>] [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-EnableExactRFC822Size <$true | $false>] [-EnforceCertificateErrors <$true | $false>] [-ExternalConnectionSettings <MultiValuedProperty>] [-InternalConnectionSettings <MultiValuedProperty>] [-LiveIdBasicAuthReplacement <$true | $false>] [-LoginType <PlainTextLogin | PlainTextAuthentication | SecureLogin>] [-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>] [-UnencryptedOrTLSBindings <MultiValuedProperty>] [-WhatIf [<SwitchParameter>]] [-X509CertificateName <String>]

Parameter Required Type Description

AuthenticatedConnectionTimeout

Optional

Microsoft.Exchange.Data.EnhancedTimeSpan

The AuthenticatedConnectionTimeout parameter specifies the time to wait before closing an idle authenticated connection. The default setting is 1800 seconds. The possible values are from 30 through 86400 seconds.

Banner

Optional

System.String

The Banner parameter specifies the banner string displayed after a connection to a Client Access server has been established.

CalendarItemRetrievalOption

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.CalendarItemRetrievalOptions

The CalendarItemRetrievalOption parameter specifies the type of calendar item returned when the calendar is accessed by using POP3. The following values are available:

  • 0:Calendar
  • 1:IntranetUrl
  • 2:InternetUrl
  • 3:Custom

If you're using 3:Custom, you must specify the OWAServerUrl parameter setting.

Confirm

Optional

System.Management.Automation.SwitchParameter

The Confirm switch causes the command to pause processing and requires you to acknowledge what the command will do before processing continues. You don't have to specify a value with the Confirm switch.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to Active Directory.

EnableExactRFC822Size

Optional

System.Boolean

The EnableExactRFC822Size parameter calculates the exact size of each MIME message that can be retrieved from the server. When you set this parameter to $true, the exact size of MIME messages stored on the Exchange server is available to POP3 or IMAP4 client programs that rely on knowing the exact size of each MIME message.

Aa997154.note(en-us,EXCHG.140).gifNote:
This parameter is set to $false by default. If you don't set this option to $true, the size of each MIME message that the Exchange server returns to POP3 and IMAP4 client programs may be slightly different than the exact size of the message. Because setting this option to $true can negatively affect performance, you should only use this option if many of your users are using a client that requires knowing the exact size of MIME messages.

EnforceCertificateErrors

Optional

System.Boolean

The EnforceCertificateErrors parameter specifies whether to enforce valid Secure Sockets Layer (SSL) certificates. To use this parameter, specify the destination Client Access server for which you want to enforce valid SSL certificates. If the EnforceCertificateErrors parameter is set to $true and the proxy's target certificate isn't valid, the proxy logon attempt fails.

The default setting is $false.

ExternalConnectionSettings

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The ExternalConnectionSettings parameter specifies the host name, port, and encryption type that Exchange uses when POP3 clients connect to their e-mail from outside your corporate network.

Enter a value using the format: <HostName>:<Port>:<Encryption Type>. The <Encryption Type> part of the multivalued value is optional. Valid values for <Encryption Type> are either TLS (Transport Layer Security) or SSL.

InternalConnectionSettings

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The InternalConnectionSettings parameter specifies the host name, port, and encryption type used when POP3 clients connect to their e-mail from inside your corporate network. This setting is also used to specify the host name, port, and encryption type used when a user connection is forwarded to another Client Access server.

Enter a value using the format: <HostName>:<Port>: <Encryption Type>. The <Encryption Type> part of the multivalued value is optional. Valid values for <Encryption Type> are either TLS or SSL.

LiveIdBasicAuthReplacement

Optional

System.Boolean

This parameter is reserved for internal Microsoft use.

LoginType

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.LoginOptions

The LoginType parameter specifies the authentication setting used for the Client Access server running the Microsoft Exchange POP3 service. The possible values are:

  • 1:PlainTextLogin
  • 2:PlainTextAuthentication
  • 3:SecureLogin

MaxCommandSize

Optional

System.Int32

The MaxCommandSize parameter specifies the maximum size of a single command. The default size is 40 bytes. The possible values are from 40 through 1024 bytes.

MaxConnectionFromSingleIP

Optional

System.Int32

The MaxConnectionFromSingleIP parameter specifies the number of connections that the specified server accepts from a single IP address. The default value is 2000. The possible values are from 1 through 25000.

MaxConnections

Optional

System.Int32

The MaxConnections parameter specifies the total number of connections that the specified server accepts. This includes authenticated and unauthenticated connections. The default size is 2000. The possible values are from 1 through 25000.

MaxConnectionsPerUser

Optional

System.Int32

The MaxConnectionsPerUser parameter specifies the maximum number of connections that the Client Access server accepts from a particular user. The default value is 16. The possible values are from 1 through 25000.

MessageRetrievalMimeFormat

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.MimeTextFormat

The MessageRetrievalMimeFormat parameter specifies the format of the messages retrieved from the server. The possible values are:

  • 0:Text Only
  • 1:HTML Only
  • 2:HTML and Text
  • 3:Rich Text Only
  • 4:Best Body Format

MessageRetrievalSortOrder

Optional

Microsoft.Exchange.Data.SortOrder

The MessageRetrievalSortOrder parameter specifies the order in which the retrieved messages are sorted. This value can be either 0 (ascending) or 1 (descending).

OwaServerUrl

Optional

System.Uri

The OwaServerUrl parameter specifies the Client Access server from which to retrieve calendar information for instances of custom Microsoft Office Outlook Web App calendar items.

PreAuthenticatedConnectionTimeout

Optional

Microsoft.Exchange.Data.EnhancedTimeSpan

The PreAuthenticatedConnectionTimeout parameter specifies the time to wait before closing an idle connection that isn't authenticated. The default setting is 60 seconds. The possible values are from 10 through 3600 seconds.

ProtocolLogEnabled

Optional

System.Boolean

The ProtocolLogEnabled parameter specifies whether to enable protocol logging. For more information, see Enable Protocol Logging for POP3 and IMAP4.

ProxyTargetPort

Optional

System.Int32

The ProxyTargetPort parameter specifies the port on the Exchange Server 2003 back-end server to which the Microsoft Exchange POP3 service on a Client Access server relays commands.

Server

Optional

Microsoft.Exchange.Configuration.Tasks.ServerIdParameter

The Server parameter specifies an individual Client Access server in your organization for which you're specifying POP3 settings.

SSLBindings

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The SSLBindings parameter specifies whether the command sets the IP address and port number to use for an SSL session. This is a multivalued property. Enter a value using the format: <IP address>:<Port number>.

UnencryptedOrTLSBindings

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The UnencryptedOrTLSBindings parameter specifies the IP address and port number for communication over the TLS–encrypted connection or the connection that isn't encrypted. This is a multivalued property. Enter a value using the format: <IP address>:<Port number>.

WhatIf

Optional

System.Management.Automation.SwitchParameter

The WhatIf switch instructs the command to simulate the actions that it would take on the object. By using the WhatIf switch, you can view what changes would occur without having to apply any of those changes. You don't have to specify a value with the WhatIf switch.

X509CertificateName

Optional

System.String

The X509CertificateName parameter specifies the host name in the SSL certificate from the Associated Subject field. This is a multivalued property that contains both the IP address and the port setting. Enter a value using the format: <IP address>:<Port number>.

You can run the Set-PopSettings cmdlet for a single Client Access server that has the Microsoft Exchange POP3 service installed, or for all Exchange Client Access servers that have the Microsoft Exchange POP3 service installed.

For more information, see Configure IP Addresses and Ports for POP3 and IMAP4 Access.

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 Client Access Permissions topic.

Error Description

 

 

Exceptions Description

 

 

This example sets the plain text or TLS connection to the Client Access server CAS01. In this example, the connection uses an IP address of 10.0.0.0 and a port number of 993.

Set-PopSettings -Server "CAS01" -UnencryptedOrTLSBindings 10.0.0.0:993
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft