PowerShell.ws >_

The unOfficial PowerShell Website!

PowerShell Command Reference:
A short synopsis of Set-PopSettings: 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.

A Description of Set-PopSettings:
You can run the Set-PopSettings cmdlet for a single Client Access server that has the Microsoft Exchange POP3 service i nstalled, 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. T o see what permissions you need, see the "POP3 settings" entry in the Client Access Permissions topic.

The Possible Inputs for Set-PopSettings:

The Correct Syntax for Set-PopSettings:
Set-PopSettings [-AuthenticatedConnectionTimeout ] [-Banner ] [-CalendarItemRetrievalOption < iCalendar | intranetUrl | InternetUrl | Custom>] [-Confirm []] [-DomainController ] [-EnableExac tRFC822Size <$true | $false>] [-EnforceCertificateErrors <$true | $false>] [-ExternalConnectionSettings ] [-InternalConnectionSettings ] [-LiveIdBasicAuthReplacement <$true | $false>] [-LoginType ] [-MaxCommandSize ] [-MaxConnectionFromSingleIP ] [-MaxConnections ] [-MaxConnectionsPerUser ] [-MessageRetrievalMimeFormat ] [-MessageRetrievalSortOr der ] [-OwaServerUrl ] [-PreAuthenticatedConnectionTimeout ] [-ProtocolL ogEnabled <$true | $false>] [-ProxyTargetPort ] [-Server ] [-SSLBindings ] [-UnencryptedOrTLSBindings ] [-WhatIf []] [-X509CertificateName ] []

The Return Values for Set-PopSettings:

Usage Examples for Set-PopSettings:

-------------------------- EXAMPLE 1 --------------------------




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

Set-PopSettings -Server "CAS01" -UnencryptedOrTLSBindings 10.0.0.0:993








Possible Parameters for Set-PopSettings:


-AuthenticatedConnectionTimeout

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

nnection. The default setting is 1800 seconds. The possible values are from 30 through 86400 seconds.



Required? false

Position? Named

Default value

Accept pipeline input? False

Accept wildcard characters? false



-Banner

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

n established.



Required? false

Position? Named

Default value

Accept pipeline input? False

Accept wildcard characters? false



-CalendarItemRetrievalOption

The CalendarItemRetrievalOption parameter specifies the type of calendar item returned when the calendar is acc

essed 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.



Required? false

Position? Named

Default value

Accept pipeline input? False

Accept wildcard characters? false



-Confirm []

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.



Required? false

Position? Named

Default value

Accept pipeline input? False

Accept wildcard characters? false



-DomainController

The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that w

rites this configuration change to Active Directory.



Required? false

Position? Named

Default value

Accept pipeline input? False

Accept wildcard characters? false



-EnableExactRFC822Size <$true | $false>

The EnableExactRFC822Size parameter calculates the exact size of each MIME message that can be retrieved from t

he 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.

This parameter is set to $false by default. If you don't set this option to $true, the size of each MIME messag

e that the Exchange server returns to POP3 and IMAP4 client programs may be slightly different than the exact s

ize 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.



Required? false

Position? Named

Default value

Accept pipeline input? False

Accept wildcard characters? false



-EnforceCertificateErrors <$true | $false>

The EnforceCertificateErrors parameter specifies whether to enforce valid Secure Sockets Layer (SSL) certificat

es. 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.



Required? false

Position? Named

Default value

Accept pipeline input? False

Accept wildcard characters? false



-ExternalConnectionSettings

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: ::. The part of the multival

ued value is optional. Valid values for are either TLS (Transport Layer Security) or SSL.



Required? false

Position? Named

Default value

Accept pipeline input? False

Accept wildcard characters? false



-InternalConnectionSettings

The InternalConnectionSettings parameter specifies the host name, port, and encryption type used when POP3 clie

nts connect to their e-mail from inside your corporate network. This setting is also used to specify the host n

ame, port, and encryption type used when a user connection is forwarded to another Client Access server.

Enter a value using the format: :: . The part of the multiva

lued value is optional. Valid values for are either TLS or SSL.



Required? false

Position? Named

Default value

Accept pipeline input? False

Accept wildcard characters? false



-LiveIdBasicAuthReplacement <$true | $false>

This parameter is reserved for internal Microsoft use.



Required? false

Position? Named

Default value

Accept pipeline input? False

Accept wildcard characters? false



-LoginType

The LoginType parameter specifies the authentication setting used for the Client Access server running the Micr

osoft Exchange POP3 service. The possible values are:

* 1:PlainTextLogin

* 2:PlainTextAuthentication

* 3:SecureLogin



Required? false

Position? Named

Default value

Accept pipeline input? False

Accept wildcard characters? false



-MaxCommandSize

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.



Required? false

Position? Named

Default value

Accept pipeline input? False

Accept wildcard characters? false



-MaxConnectionFromSingleIP

The MaxConnectionFromSingleIP parameter specifies the number of connections that the specified server accepts f

rom a single IP address. The default value is 2000. The possible values are from 1 through 25000.



Required? false

Position? Named

Default value

Accept pipeline input? False

Accept wildcard characters? false



-MaxConnections

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.



Required? false

Position? Named

Default value

Accept pipeline input? False

Accept wildcard characters? false



-MaxConnectionsPerUser

The MaxConnectionsPerUser parameter specifies the maximum number of connections that the Client Access server a

ccepts from a particular user. The default value is 16. The possible values are from 1 through 25000.



Required? false

Position? Named

Default value

Accept pipeline input? False

Accept wildcard characters? false



-MessageRetrievalMimeFormat
lternative | BestBodyFormat | Tnef>

The MessageRetrievalMimeFormat parameter specifies the format of the messages retrieved from the server. The po

ssible values are:

* 0:Text Only

* 1:HTML Only

* 2:HTML and Text

* 3:Rich Text Only

* 4:Best Body Format



Required? false

Position? Named

Default value

Accept pipeline input? False

Accept wildcard characters? false



-MessageRetrievalSortOrder

The MessageRetrievalSortOrder parameter specifies the order in which the retrieved messages are sorted. This va

lue can be either 0 (ascending) or 1 (descending).



Required? false

Position? Named

Default value

Accept pipeline input? False

Accept wildcard characters? false



-OwaServerUrl

The OwaServerUrl parameter specifies the Client Access server from which to retrieve calendar information for i

nstances of custom Microsoft Office Outlook Web App calendar items.



Required? false

Position? Named

Default value

Accept pipeline input? False

Accept wildcard characters? false



-PreAuthenticatedConnectionTimeout

The PreAuthenticatedConnectionTimeout parameter specifies the time to wait before closing an idle connection th

at isn't authenticated. The default setting is 60 seconds. The possible values are from 10 through 3600 seconds

.



Required? false

Position? Named

Default value

Accept pipeline input? False

Accept wildcard characters? false



-ProtocolLogEnabled <$true | $false>

The ProtocolLogEnabled parameter specifies whether to enable protocol logging. For more information, see Enable

Protocol Logging for POP3 and IMAP4.



Required? false

Position? Named

Default value

Accept pipeline input? False

Accept wildcard characters? false



-ProxyTargetPort

The ProxyTargetPort parameter specifies the port on the Exchange Server 2003 back-end server to which the Micro

soft Exchange POP3 service on a Client Access server relays commands.



Required? false

Position? Named

Default value

Accept pipeline input? False

Accept wildcard characters? false



-Server

The Server parameter specifies an individual Client Access server in your organization for which you're specify

ing POP3 settings.



Required? false

Position? Named

Default value

Accept pipeline input? True

Accept wildcard characters? false



-SSLBindings

The SSLBindings parameter specifies whether the command sets the IP address and port number to use for an SSL s

ession. This is a multivalued property. Enter a value using the format: :.



Required? false

Position? Named

Default value

Accept pipeline input? False

Accept wildcard characters? false



-UnencryptedOrTLSBindings

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 usin

g the format: :.



Required? false

Position? Named

Default value

Accept pipeline input? False

Accept wildcard characters? false



-WhatIf []

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 ha

ve to specify a value with the WhatIf switch.



Required? false

Position? Named

Default value

Accept pipeline input? False

Accept wildcard characters? false



-X509CertificateName

The X509CertificateName parameter specifies the host name in the SSL certificate from the Associated Subject fi

eld. This is a multivalued property that contains both the IP address and the port setting. Enter a value using

the format: :.



Required? false

Position? Named

Default value

Accept pipeline input? False

Accept wildcard characters? false





This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer and OutVariable. For more information, type,

"get-help about_commonparameters".