Set-POPSettings
Applies to: Exchange Server 2007 SP1, Exchange Server 2007 SP2, Exchange Server 2007 SP3
The Set-POPSettings cmdlet lets you set specific Post Office Protocol version 3 (POP3) settings for the server that is running Microsoft Exchange Server 2007 that has the Client Access server role installed and that is running the POP3 service.
Syntax
Set-PopSettings [-AuthenticatedConnectionTimeout <EnhancedTimeSpan>] [-Banner <String>] [-CalendarItemRetrievalOption <iCalendar | intranetUrl | InternetUrl | Custom>] [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-EnableExactRFC822Size <$true | $false>] [-Instance <Pop3AdConfiguration>] [-LoginType <PlainTextLogin | PlainTextAuthentication | SecureLogin>] [-MaxCommandSize <Int32>] [-MaxConnectionFromSingleIP <Int32>] [-MaxConnections <Int32>] [-MaxConnectionsPerUser <Int32>] [-MessageRetrievalMimeFormat <TextOnly | HtmlOnly | HtmlAndTextAlternative | TextEnrichedOnly | TextEnrichedAndTextAlternative | BestBodyFormat | Tnef>] [-MessageRetrievalSortOrder <Ascending | Descending>] [-OwaServerUrl <String>] [-PreAuthenticatedConnectionTimeout <EnhancedTimeSpan>] [-ProxyTargetPort <Int32>] [-Server <ServerIdParameter>] [-SSLBindings <MultiValuedProperty>] [-UnencryptedOrTLSBindings <MultiValuedProperty>] [-WhatIf [<SwitchParameter>]] [-X509CertificateName <String>]
Detailed Description
The Set-POPSettings cmdlet lets you set specific POP3 properties on a Client Access server. You can run this cmdlet for a single Client Access server that has the POP3 service installed, or for all Exchange 2007 computers in your organization that have the Client Access server role and the POP3 service installed.
To run the Set-POPSettings cmdlet, the account you use must be delegated the Exchange Server Administrator role and membership in the local Administrators group for the target server.
For more information about permissions, delegating roles, and the rights that are required to administer Exchange Server 2007, see Permission Considerations.
Parameters
Parameter | Required | Type | Description |
---|---|---|---|
AuthenticatedConnectionTimeout |
Optional |
Microsoft.Exchange.Data.EnhancedTimeSpan |
This parameter specifies the time to wait before closing an idle authenticated connection. The default setting is 1800 seconds. The possible values are from 30 to 86,400 seconds. |
Banner |
Optional |
System.String |
This parameter specifies the banner string that is displayed after a connection to a Client Access server has been established. |
CalendarItemRetrievalOption |
Optional |
Microsoft.Exchange.Data.Directory.SystemConfiguration.CalendarItemRetrievalOptions |
This parameter specifies the type of calendar item that is returned when the calendar is accessed by using POP3. The following values are available:
If you are using 3:Custom, you must specify the OWAServerUrl setting. |
Confirm |
Optional |
System.Management.Automation.SwitchParameter |
This parameter causes the command to pause processing and requires that you acknowledge what the command will do before processing continues. You do not have to specify a value with the Confirm parameter. |
DomainController |
Optional |
Microsoft.Exchange.Data.Fqdn |
To specify the fully qualified domain name (FQDN) of the domain controller that retrieves data from the Active Directory directory service, include the DomainController parameter in the command. |
EnableExactRFC822Size |
Optional |
System.Boolean |
The EnableExactRFC822Size parameter is used to return the correct RFC822.SIZE value of each e-mail message in a mailbox. By default, Exchange 2007 estimates the RFC822.SIZE value because Exchange 2007 must rebuild the MIME to determine the exact size. Rebuilding the MIME may have a performance impact if the mailbox includes large messages or messages that contain deeply nested attachments. However, some e-mail clients may require that the RFC822.SIZE value is the exact value and not an estimated value. To enable the exact size for everyone, use the following command: Set-ImapSettings -EnableExactRFC822Size:$true To enable the exact size for only a specific user, use the following command: Set-CASMailbox <IMAP_User_Name> -ImapUseProtocolDefaults:$false -ImapEnableExactRFC822Size:$true |
Instance |
Optional |
Microsoft.Exchange.Data.Directory.SystemConfiguration.Pop3AdConfiguration |
The Instance parameter specifies an instance of an Active Directory object that is piped to and consumed by this command. |
LoginType |
Optional |
Microsoft.Exchange.Data.Directory.SystemConfiguration.LoginOptions |
This parameter specifies the authentication setting that is used for the Client Access server that is running the POP3 service. The possible values are as follows:
|
MaxCommandSize |
Optional |
System.Int32 |
This parameter specifies the maximum size of a single command. The default size is 10240 bytes. The possible values are from 1024 to 16384 bytes. |
MaxConnectionFromSingleIP |
Optional |
System.Int32 |
This parameter specifies the number of connections that the specified server will accept from a single IP address. The default value is 20. The possible values are from 1 to 1000. |
MaxConnections |
Optional |
System.Int32 |
This parameter specifies the total number of connections that the specified server will accept. This includes authenticated and unauthenticated connections. The default size is 2,000 connections. The possible values are from 1 to 25,000. |
MaxConnectionsPerUser |
Optional |
System.Int32 |
This parameter specifies the maximum number of connections that the Client Access server will accept from a particular user. The default value is 10. The possible values are from 1 to 1000. |
MessageRetrievalMimeFormat |
Optional |
Microsoft.Exchange.Data.Directory.SystemConfiguration.MimeTextFormat |
This parameter specifies the format of the messages that are retrieved from the server. The possible values are as follows:
|
MessageRetrievalSortOrder |
Optional |
Microsoft.Exchange.Data.SortOrder |
This parameter specifies the order in which the retrieved messages are sorted. This value can be either 0 (Ascending) or 1 (Descending). |
OwaServerUrl |
Optional |
System.String |
This parameter specifies the Client Access server from which to retrieve calendar information for instances of custom Outlook Web Access calendar items. |
PreAuthenticatedConnectionTimeout |
Optional |
Microsoft.Exchange.Data.EnhancedTimeSpan |
This parameter specifies the time to wait before closing an idle connection that is not authenticated. The default setting is 60 seconds. The possible values are from 10 to 3600 seconds. |
ProxyTargetPort |
Optional |
System.Int32 |
This parameter specifies the port on the Exchange Server 2003 back-end server to which the POP3 service on a Client Access server will relay commands. |
Server |
Optional |
Microsoft.Exchange.Configuration.Tasks.ServerIdParameter |
This parameter specifies an individual Client Access server in your organization for which you are specifying POP3 settings. |
SSLBindings |
Optional |
Microsoft.Exchange.Data.MultiValuedProperty |
If this parameter is specified, the cmdlet returns the IP port to use for a Secure Sockets Layer (SSL) session. |
UnencryptedOrTLSBindings |
Optional |
Microsoft.Exchange.Data.MultiValuedProperty |
This parameter specifies the IP port for communication over the Transport Layer Security (TLS)–encrypted connection or the connection that is not encrypted. |
WhatIf |
Optional |
System.Management.Automation.SwitchParameter |
This parameter instructs the command to simulate the actions that it would take on the object. By using the WhatIf parameter, you can view what changes would occur without having to apply any of those changes. You do not have to specify a value with the WhatIf parameter. |
X509CertificateName |
Optional |
System.String |
This parameter specifies the host name in the SSL certificate from the Associated Subject field. |
Input Types
Return Types
Errors
Error | Description |
---|---|
|
|
Exceptions
Exceptions | Description |
---|---|
|
|
Example
The following code example sets the IP Address for TLS on the Client Access server that is named CAS01.
Set-PopSettings -Server "CAS01" -UnencryptedOrTLSBindings IPaddress:953