Applies to: Exchange Server 2013, Exchange Online

Topic Last Modified: 2012-12-10

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

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

Syntax

Set-ImapSettings [-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>] [-LiveIdBasicAuthReplacement <$true | $false>] [-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>] [-OwaServerUrl <Uri>] [-PreAuthenticatedConnectionTimeout <EnhancedTimeSpan>] [-ProtocolLogEnabled <$true | $false>] [-ProxyTargetPort <Int32>] [-Server <ServerIdParameter>] [-ShowHiddenFoldersEnabled <$true | $false>] [-SSLBindings <MultiValuedProperty>] [-SuppressReadReceipt <$true | $false>] [-UnencryptedOrTLSBindings <MultiValuedProperty>] [-WhatIf [<SwitchParameter>]] [-X509CertificateName <String>]

Examples

EXAMPLE 1

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

Copy Code 
Set-ImapSettings -Server "CAS01" -UnencryptedOrTLSBindings 10.0.0.0:995

EXAMPLE 2

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

Copy Code 
Set-ImapSettings -ProtocolLogEnabled $true -LogFileLocation "C:\Imap4Logging"

EXAMPLE 3

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

Copy Code 
Set-ImapSettings -LogPerFileSizeQuota 2000000

EXAMPLE 4

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

Copy Code 
Set-ImapSettings -LogPerFileSizeQuota 0 -LogFileRollOverSettings Hourly

Detailed Description

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

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 "IMAP4 settings" entry in the Clients and Mobile Devices Permissions topic.

Parameters

Parameter Required Type Description

AuthenticatedConnectionTimeout

Optional

Microsoft.Exchange.Data.EnhancedTimeSpan

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

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

Valid input for this parameter is 00:00:30 to 1:00:00. The default setting is 00:30:00 or 30 minutes.

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 IMAP4. The default value is iCalendar. You can specify the value for this parameter by using a numerical value or text string. The following values are available:

  • 0 or iCalendar

  • 1 or intranetUrl

  • 2 or InternetUrl

  • 3 or Custom

If you're using 3 or 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.

Note:
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.

EnableGSSAPIAndNTLMAuth

Optional

System.Boolean

The EnableGSSAPIAndNTLMAuth parameter specifies whether connections can use Integrated Windows authentication (NTLM) using the Generic Security Services application programming interface (GSSAPI). This setting applies to connections where Transport Layer Security (TLS) is disabled. This parameter is set to $true by default. You can disable NTLM for IMAP4 connections by setting the parameter value to $false. NTLM authentication isn't supported for IMAP4 connections in Microsoft Exchange Server 2010 release to manufacturing (RTM). Support for NTLM authentication for IMAP4 connections was brought back in Exchange 2010 Service Pack 1 (SP1).

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.

ExtendedProtectionPolicy

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.ExtendedProtectionTokenCheckingMode

The ExtendedProtectionPolicy parameter specifies how you want to use Extended Protection for Authentication for IMAP4 connections. By default, this parameter is set to None. The possible values are:

  • None   Extended Protection for Authentication won't be used.

  • Allow   Extended Protection for Authentication will be used only if the connecting IMAP4 connection supports it. Otherwise, the connections will be established without Extended Protection for Authentication.

  • Require   Extended Protection for Authentication will be required for all IMAP4 connections. If the connecting host doesn't support Extended Protection for Authentication, the connection will be rejected.

Extended Protection for Authentication enhances the protection and handling of credentials when authenticating network connections using Integrated Windows authentication. Integrated Windows authentication is also known as NTLM. We strongly recommend that you use Extended Protection for Authentication if you're using Integrated Windows authentication. To use Extended Protection for Authentication, the client and server computers must meet specific requirements. These include operating system requirements and security update requirements. In addition, the IMAP4 client program must support the use of Extended Protection for Authentication.

ExternalConnectionSettings

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The ExternalConnectionSettings parameter specifies the host name, port, and encryption type that Exchange uses when IMAP4 clients connect to their email from outside the 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 IMAP4 clients connect to their email from inside the 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. If the server name is Server01 and the domain is Contoso.com, the default value is Server01.Contoso.com:993:SSL, Server01.Contoso.com:143:TLS.

LiveIdBasicAuthReplacement

Optional

System.Boolean

This parameter is reserved for internal Microsoft use.

LogFileLocation

Optional

System.String

The LogFileLocation parameter specifies the location for the IMAP4 protocol log files. By default, IMAP4 protocol log files are located in the C:\Program Files\Microsoft\Exchange Server\V15\Logging\Imap4 directory.

LogFileRollOverSettings

Optional

Microsoft.Exchange.Diagnostics.LogFileRollOver

The LogFileRollOverSettings parameter specifies how frequently IMAP4 protocol logging creates a new log file. By default, a new log file is created daily. You can specify the value for this parameter by using a numerical value or text string. The possible values are:

  • 1 or Hourly

  • 2 or Daily

  • 3 or Weekly

  • 4 or Monthly

This setting only applies when the value for the LogPerFileSizeQuota parameter is set to 0.

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 IMAP4 service. The default value is SecureLogin. You can specify the value for this parameter by using a numerical value or text string. The possible values are:

  • 1 or PlainTextLogin

  • 2 or PlainTextAuthentication

  • 3 or SecureLogin

LogPerFileSizeQuota

Optional

Microsoft.Exchange.Data.Unlimited

The LogPerFileSizeQuota parameter specifies the maximum size of an IMAP4 protocol log file in bytes. By default, this value is set to 0. When this value is set to 0, a new protocol log file is created at the frequency specified by the LogFileRollOverSettings parameter.

MaxCommandSize

Optional

System.Int32

The MaxCommandSize parameter specifies the maximum size of a single command. The default size is 10240 bytes. The possible values are from 1024 through 16384 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 2147483647. The possible values are from 1 through 2147483647.

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 value is 2147483647. The possible values are from 1 through 2147483647.

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

MessageRetrievalMimeFormat

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.MimeTextFormat

The MessageRetrievalMimeFormat parameter specifies the format of the messages retrieved from the server. The default value is BestBodyFormat. You can specify the value for this parameter by using a numerical value or text string. The possible values are:

  • 0 or TextOnly

  • 1 or HtmlOnly

  • 2 or HtmlAndTextAlternative

  • 3 or TextEnrichedOnly

  • 4 or TextEnrichedAndTextAlternative

  • 5 or BestBodyFormat

  • 6 or Tnef

For more information, see Configure POP3 and IMAP4 Message Retrieval Format Options.

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 period of time to wait before closing an idle connection that isn't authenticated.

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

Valid input for this parameter is 00:00:30 to 1:00:00.The default value is 00:01:00 or one minute.

ProtocolLogEnabled

Optional

System.Boolean

The ProtocolLogEnabled parameter specifies whether to enable protocol logging. For more information, see Configure 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 IMAP4 service on a Client Access server relays commands. The default port is 9933.

Server

Optional

Microsoft.Exchange.Configuration.Tasks.ServerIdParameter

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

ShowHiddenFoldersEnabled

Optional

System.Boolean

The ShowHiddenFoldersEnabled parameter specifies whether hidden folders are visible. If the value is set to $true, hidden folders are visible. The default value is $false.

SSLBindings

Optional

Microsoft.Exchange.Data.MultiValuedProperty

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

SuppressReadReceipt

Optional

System.Boolean

The SuppressReadReceipt parameter specifies whether to stop duplicate read receipts from being sent to IMAP4 senders that are using the Send read receipts for messages I send option in their IMAP4 email program. By default, this option is set to $false. By default, IMAP4 senders that use the Send read receipts for messages I send option receive a read receipt in both of the following circumstances:

  • When messages they send are downloaded by the recipient.

  • When the recipient opens the message.

The following are valid values and descriptions for this parameter:

  • $false   IMAP4 users are sent a read receipt each time a recipient downloads a message. IMAP4 users are also sent a read receipt when the user opens the message.

  • $true   IMAP4 users that use the Send read receipts for messages I send option in their email client programs only receive a read receipt when the recipient opens the message.

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>. The default value is 0.0.0.0:143.

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

Input Types

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.

Return Types

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.