Test-ImapConnectivity

 

Applies to: Exchange Server 2016

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

Use the Test-ImapConnectivity cmdlet to verify that connectivity to the Microsoft Exchange IMAP4 service is working as expected.

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>] [-WhatIf [<SwitchParameter>]]

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

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

This example tests the client IMAP4 connectivity of the server named Contoso12 and tests all Exchange mailboxes.

Test-ImapConnectivity -ClientAccessServer Contoso12

The Test-ImapConnectivity cmdlet tests IMAP4 connectivity by connecting to the specified mailbox, the specified Exchange server, or all Exchange servers that are available in the local Active Directory site.

The first time you use this cmdlet, you might be required to create a test user. To create a test user, run the following command.

& $env:ExchangeInstallPath\Scripts\New-TestCasConnectivityUser.ps1

The test results are displayed on-screen. The cmdlet returns the following information.

  • CasServer   The Exchange server that the client connected to.

  • LocalSite   The name of the local Active Directory site.

  • Scenario   The operations that are tested.

    Test IMAP4 Connectivity   Connects to the server using the IMAP4 protocol, searches for the test message, and deletes it along with any messages that are older than 24 hours.

  • Result   The values returned are typically Success, Skipped, or Failure.

  • Latency(MS)   The time required to complete the test in milliseconds.

  • Error   Any error messages that were encountered.

You can write the results to a file by piping the output to ConvertTo-Html or ConvertTo-Csv and adding > <filename> to the command. For example:

Test-IMAPConnectivity -ClientAccessServer MBX01 | ConvertTo-Html > "C:\My Documents\IMAP Test.html"

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.

 

Parameter Required Type Description

ClientAccessServer

Optional

Microsoft.Exchange.Configuration.Tasks.ServerIdParameter

The ClientAccessServer parameter specifies the server to test that's responsible for accepting client connections. For example:

  • An Exchange 2016 Mailbox server.

  • An Exchange 2013 Client Access server.

You can use any value that uniquely identifies the server. For example:

  • Name

  • Distinguished name (DN)

  • ExchangeLegacyDN

  • GUID

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.

ConnectionType

Optional

Microsoft.Exchange.Monitoring.ProtocolConnectionType

The ConnectionType parameter specifies the type of connection that's used to connect to the IMAP4 service. Valid values are:

  • Plaintext

  • Ssl

  • Tls

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.

LightMode

Optional

System.Management.Automation.SwitchParameter

The LightMode switch tells the command to perform only a test logon to the server by using the IMAP4 protocol. You don't need to specify a value with this switch.

If you don't use this switch, the command also tests sending and receiving a message using the IMAP4 protocol.

MailboxCredential

Optional

System.Management.Automation.PSCredential

The MailboxCredential parameter specifies the mailbox credential to use for a single mailbox test.

This parameter requires you to create a credentials object by using the Get-Credential cmdlet. For more information, see Get-Credential.

MailboxServer

Optional

Microsoft.Exchange.Configuration.Tasks.ServerIdParameter

The MailboxServer parameter specifies the Exchange 2016 or Exchange 2013 Mailbox server that you want to test. This parameter identifies the backend server that accepts proxied connections from the frontend server where clients connect.

You can use any value that uniquely identifies the server. For example:

  • Name

  • Distinguished name (DN)

  • ExchangeLegacyDN

  • GUID

If you don't use this parameter, connections to 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. Typically, you include the monitoring events and performance counters in the results when the output is passed to MicrosoftSystem Center Operations Manager (SCOM). You don't need to specify a value with this switch.

PerConnectionTimeout

Optional

System.Int32

The PerConnectionTimeout parameter specifies the amount of time, in seconds, to wait per connection for the test operation to finish. Valid values are between 0 and 120 seconds. The default value is 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 switch resets the password for the test account that's used to run this command. The password for the test account is typically reset every seven days. Use this switch to force a password reset any time 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. Valid values are between 0 and 3600 seconds (1 hour). The default value is 180 seconds (3 minutes).

We recommend that you configure this parameter with a value of 5 seconds or more.

TrustAnySSLCertificate

Optional

System.Management.Automation.SwitchParameter

The TrustAnySSLCertificate switch specifies whether to ignore Secure Sockets Layer (SSL) certificate validation failures. You don't need to specify a value with this switch.

This switch is useful for testing internal URLs, because a URL that has an associated certificate is typically an external URL. This switch lets the task check an internal URL without generating an error when the certificate doesn't match the URL.

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.

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: