Applies to: Exchange Server 2013, Exchange Online

Topic Last Modified: 2012-09-17

Use the Test-ImapConnectivity cmdlet to verify that the IMAP4 service is running as expected. The Test-ImapConnectivity cmdlet can be used to test the IMAP4 functionality for a specified Client Access server for all mailboxes on servers running Microsoft Exchange Server 2013 in the same Active Directory site.

Syntax


Test-ImapConnectivity [-ClientAccessServer <ServerIdParameter>] [-ConnectionType <Plaintext \| Tls \| Ssl>] [-MailboxCredential <PSCredential>] [-PerConnectionTimeout <Int32>] [-PortClientAccessServer <Int32>] [-TrustAnySSLCertificate <SwitchParameter>] [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-LightMode <SwitchParameter>] [-MailboxServer <ServerIdParameter>] [-MonitoringContext <SwitchParameter>] [-ResetTestAccountCredentials <SwitchParameter>] [-Timeout <UInt32>] [-UserType <LEGACY \| EDU \| BPOS>] [-WhatIf [<SwitchParameter>]]

Test-ImapConnectivity [-ClientAccessServer
<ServerIdParameter>] [-ConnectionType <Plaintext | Tls |
Ssl>] [-MailboxCredential <PSCredential>]
[-PerConnectionTimeout <Int32>] [-PortClientAccessServer
<Int32>] [-TrustAnySSLCertificate <SwitchParameter>]
[-Confirm [<SwitchParameter>]] [-DomainController
<Fqdn>] [-LightMode <SwitchParameter>] [-MailboxServer
<ServerIdParameter>] [-MonitoringContext
<SwitchParameter>] [-ResetTestAccountCredentials
<SwitchParameter>] [-Timeout <UInt32>] [-UserType
<LEGACY | EDU | BPOS>] [-WhatIf
[<SwitchParameter>]]

Examples

EXAMPLE 1

This example tests the IMAP4 connectivity for the Client Access server Contoso12 by using the credentials for the user contoso\kweku.

	Copy Code
Test-ImapConnectivity -ClientAccessServer:Contoso12 -MailboxCredential:(Get-Credential contoso\kweku)

EXAMPLE 2

This example tests the IMAP4 connectivity of the specific Client Access server Contoso12 and tests all Exchange mailboxes.

	Copy Code
Test-ImapConnectivity -ClientAccessServer:Contoso12

Detailed Description

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

Parameters

Parameter	Required	Type	Description
ClientAccessServer	Optional	Microsoft.Exchange.Configuration.Tasks.ServerIdParameter	The ClientAccessServer parameter specifies the name of the Client Access server to test.
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.
ConnectionType	Optional	Microsoft.Exchange.Monitoring.ProtocolConnectionType	The ConnectionType parameter specifies the type of connection used to connect to the Client Access server. This setting can be set to `Plaintext`, `Tls`, or `Ssl`.
DomainController	Optional	Microsoft.Exchange.Data.Fqdn	The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that retrieves data from Active Directory.
LightMode	Optional	System.Management.Automation.SwitchParameter	The LightMode parameter instructs the command to perform only a test logon to the server using the IMAP4 protocol. If you don't use this parameter, the test also tests the sending and receiving of a message using the IMAP4 protocol.
MailboxCredential	Optional	System.Management.Automation.PSCredential	The MailboxCredential parameter specifies the mailbox credential for a single mailbox test.
MailboxServer	Optional	Microsoft.Exchange.Configuration.Tasks.ServerIdParameter	The MailboxServer parameter specifies the name of the Mailbox server to test. If not specified, all Mailbox servers in the local Active Directory site are tested.
MonitoringContext	Optional	System.Management.Automation.SwitchParameter	The MonitoringContext switch includes the associated monitoring events and performance counters in the results. You don't need to specify a value with this switch. Typically, you include the monitoring events and performance counters in the results when the output is passed to Microsoft System Center Operations Manager 2007 or System Center 2012 - Operations Manager.
PerConnectionTimeout	Optional	System.Int32	The PerConnectionTimeout parameter specifies the amount of time, in seconds, to wait per connection for the test operation to finish. The default value for the PerConnectionTimeout parameter is 120 seconds. You must specify a time-out value greater than 0 seconds and less than 120 seconds. We recommend that you configure this parameter with a value of 5 seconds or more.
PortClientAccessServer	Optional	System.Int32	The PortClientAccessServer parameter specifies the port to use to connect to the Client Access server. The default port is 143 for IMAP4. The valid range is from 0 through 65,535.
ResetTestAccountCredentials	Optional	System.Management.Automation.SwitchParameter	The ResetTestAccountCredentials parameter resets the password for the test account used to perform this command. The password for the test account is typically reset every seven days if you're using Microsoft System Center Operations Manager to manage your Exchange environment. Use of this flag forces a password reset at any time if it's required for security reasons.
Timeout	Optional	System.UInt32	The Timeout parameter specifies the amount of time, in seconds, to wait for the test operation to finish. The default value for the Timeout parameter is 180 seconds. You must specify a time-out value greater than 0 seconds and less than 1 hour (3,600 seconds). We recommend that you configure this parameter with a value of 5 seconds or more.
TrustAnySSLCertificate	Optional	System.Management.Automation.SwitchParameter	The TrustAnySSLCertificate parameter specifies whether Secure Sockets Layer (SSL) certificate validation failures are reported. This parameter instructs the command to check the IMAP4 service without generating an error when the certificate doesn't match the URL of the Client Access server.
UserType	Optional	Microsoft.Exchange.Monitoring.DatacenterUserType	This parameter is reserved for internal Microsoft use.
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.

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.