Any suggestions? Export (0) Print
Expand All
Collapse the table of content
Expand the table of content
Expand Minimize

Set-ImapSettings

 

Applies to: Exchange Server 2016

This cmdlet is available only in on-premises Exchange Server 2016.

Use the Set-ImapSettings cmdlet to modify the settings of the Microsoft Exchange IMAP4 service on Exchange servers. This service exists on Exchange servers that have the Client Access server role installed, and is used by IMAP4 clients to connect to Exchange.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet 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>] [-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>]

This example sets the plain text or TLS connection to the IMAP4 service on the server named MBX01. In this example, the connection uses an IP address of 10.0.0.0 and a port number of 995.

Set-ImapSettings -Server "MBX01" -UnencryptedOrTLSBindings 10.0.0.0:995

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

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

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

Set-ImapSettings -LogPerFileSizeQuota 2000000

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

Set-ImapSettings -LogPerFileSizeQuota 0 -LogFileRollOverSettings Hourly

You can run the Set-ImapSettings cmdlet for a single Exchange server that's running the Microsoft Exchange IMAP4 service, or for all Exchange servers that are running the Microsoft Exchange IMAP4 service.

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.

 

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 dd = days, hh = hours, mm = minutes, and ss = 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 text string that's displayed when after an IMAP4 connection is established. The default value is: The Microsoft Exchange IMAP4 service is ready..

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 specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding.

  • Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false.

  • Most other cmdlets (for example, New-* and Set-* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com.

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.

noteNote:
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. Support for NTLM authentication for IMAP4 connections is available in Exchange 2010 Service Pack 1 (SP1) and later.

EnforceCertificateErrors

Optional

System.Boolean

The EnforceCertificateErrors parameter specifies whether to enforce valid Secure Sockets Layer (SSL) certificates. To use this parameter, specify the destination Exchange 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 (optionally) the encryption type that's used when IMAP4 clients connect to their mailbox from outside the corporate network.

Enter a value using the format: <HostName>:<Port>:[<TLS | SSL>]. The encryption type value is optional.

To enter multiple values and overwrite any existing entries, use the following syntax: <value1>,<value2>.... If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "<value1>","<value2>"....

To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="<value1>","<value2>"...; Remove="<value1>","<value2>"...}.

InternalConnectionSettings

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The InternalConnectionSettings parameter specifies the host name, port, and (optionally) the encryption type that's 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 Exchange server that's running the Microsoft Exchange IMAP4 service.

The default value for this parameter is <ServerFQDN>:993:SSL,<ServerFQDN>:143:TLS.

LogFileLocation

Optional

System.String

The LogFileLocation parameter specifies the location for the IMAP4 protocol log files. The default location is %ExchangeInstallPath%Logging\Imap4.

LogFileRollOverSettings

Optional

Microsoft.Exchange.Diagnostics.LogFileRollOver

The LogFileRollOverSettings parameter specifies how frequently IMAP4 protocol logging creates a new log file. Valid values are:

  • 1 or Hourly.

  • 2 or Daily. This is the default value

  • 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 method for IMAP4 connections. Valid values are:

  • 1 or PlainTextLogin.

  • 2 or PlainTextAuthentication.

  • 3 or SecureLogin. This is the default value.

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 IMAP4 connections by a particular user. The default value is 16. Valid values are from 1 through 2147483647.

MessageRetrievalMimeFormat

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.MimeTextFormat

The MessageRetrievalMimeFormat parameter specifies the MIME encoding of messages. Valid values are:

  • 0 or TextOnly.

  • 1 or HtmlOnly.

  • 2 or HtmlAndTextAlternative.

  • 3 or TextEnrichedOnly.

  • 4 or TextEnrichedAndTextAlternative.

  • 5 or BestBodyFormat. This is the default value.

  • 6 or Tnef.

For more information, see Configure POP3 and IMAP4 message retrieval format options.

OwaServerUrl

Optional

System.Uri

The OwaServerUrl parameter specifies where to retrieve calendar information for instances of custom Outlook on the web 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 dd = days, hh = hours, mm = minutes, and ss = seconds.

Valid values are 00:00:30 to 1:00:00. The default value is 00:01:00 (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 Microsoft Exchange IMAP4 Backend service that listens for client connections that are proxied from the Microsoft Exchange IMAP4 service. The default value is 1993.

Server

Optional

Microsoft.Exchange.Configuration.Tasks.ServerIdParameter

The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example:

  • Name

  • FQDN

  • Distinguished name (DN)

  • Exchange Legacy DN

If you don't use this parameter, the command is run on the local server.

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 simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this 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>.

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.

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.

 
Show:
© 2016 Microsoft