Share via

Set-IMAPSettings (RTM)

  • Article

Microsoft Exchange Server 2007 will reach end of support on April 11, 2017. To stay supported, you will need to upgrade. For more information, see Resources to help you upgrade your Office 2007 servers and clients.

 

Applies to: Exchange Server 2007

The Set-IMAPSettings cmdlet lets you set specific Internet Message Access Protocol version 4rev1 (IMAP4) settings for the Microsoft Exchange Server 2007 server that has the Client Access server role installed and that is running the IMAP4 service.

Syntax

Set-ImapSettings [-AuthenticatedConnectionTimeout <EnhancedTimeSpan>] [-Banner <String>] [-CalendarItemRetrievalOption <iCalendar | intranetUrl | InternetUrl | Custom>] [-DomainController <Fqdn>] [-Instance <Imap4AdConfiguration>] [-LoginType <PlainTextLogin | PlainTextAuthentication | SecureLogin>] [-MaxCommandSize <Int32>] [-MaxConnectionFromSingleIP <Int32>] [-MaxConnections <Int32>] [-MaxConnectionsPerUser <Int32>] [-MessageRetrievalMimeFormat <TextOnly | HtmlOnly | HtmlAndTextAlternative | TextEnrichedOnly | TextEnrichedAndTextAlternative | BestBodyFormat>] [-OwaServerUrl <String>] [-PreAuthenticatedConnectionTimeout <EnhancedTimeSpan>] [-ProxyTargetPort <Int32>] [-Server <ServerIdParameter>] [-ShowHiddenFoldersEnabled <$true | $false>] [-SSLBindings <MultiValuedProperty>] [-UnencryptedOrTLSBindings <MultiValuedProperty>] [-X509CertificateName <String>]

Detailed Description

The Set-IMAPSettings cmdlet lets you set specific IMAP4 settings for the Exchange 2007 Client Access server that is running the IMAP4 service. You can run this cmdlet for a single Client Access server that has the IMAP4 service installed, or for all Exchange 2007 Client Access servers that have the IMAP4 service installed.

To run the Set-IMAPSettings cmdlet, the account you use must be delegated the following:

  • Exchange Server Administrator role and 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 period of 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 IMAP4. The following values are available:

  • 0:Calendar

  • 1:IntranetUrl

  • 2:InternetUrl

  • 3:Custom

If you are using 3:Custom, you must specify the OWAServerUrl setting.

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.

Instance

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.Imap4AdConfiguration

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 IMAP4 service. The possible values are as follows:

  • 1:PlainTextLogin

  • 2:PlainTextAuthentication

  • 3:SecureLogin

MaxCommandSize

Optional

System.Int32

This parameter specifies the maximum size of a single command. The default size is 40 bytes. The possible values are from 40 to 1024 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

Specifies the total number of connections the specified server will accept. This includes authenticated and unauthenticated connections. The default size is 2,000 bytes. 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:

  • 0:Text Only

  • 1:HTML Only

  • 2:HTML and Text

  • 3:Rich Text Only

  • 4:UUEncode

  • 5:UUEncodeBinHex

  • 6:Best Body Format

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 period of 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 IMAP4 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 IMAP settings.

ShowHiddenFoldersEnabled

Optional

System.Boolean

If this parameter is specified, hidden folders will be visible. The default value is $false. 

SSLBindings

Optional

Microsoft.Exchange.Data.MultiValuedProperty

If this parameter is specified, the cmdlet returns the IP port to use for communication 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.

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 IPAddress for TLS on the Client Access server that is named CAS01.

Set-ImapSettings -Server "CAS01" -UnencryptedOrTLSBindings IPaddress:953