Applies to: Exchange Server 2007 SP3, Exchange Server
2007 SP2, Exchange Server 2007 SP1
Topic Last Modified: 2007-08-20
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 Exchange 2007 servers in the same Active Directory site.
Syntax
Test-ImapConnectivity [-ClientAccessServer
<ServerIdParameter>] [-Confirm [<SwitchParameter>]]
[-ConnectionType <Plaintext | Tls | Ssl>] [-DomainController
<Fqdn>] [-LightMode <SwitchParameter>]
[-MailboxCredential <PSCredential>] [-MailboxServer
<ServerIdParameter>] [-MonitoringContext
<SwitchParameter>] [-PerConnectionTimeout <Int32>]
[-PortClientAccessServer <Int32>]
[-ResetTestAccountCredentials <SwitchParameter>] [-Timeout
<UInt32>] [-TrustAnySSLCertificate <SwitchParameter>]
[-WhatIf [<SwitchParameter>]]
|
Parameters
| Parameter | Required | Type | Description | ||
|---|---|---|---|---|---|
|
ClientAccessServer |
Optional |
Microsoft.Exchange.Configuration.Tasks.ServerIdParameter |
This parameter specifies the name of the Client Access server to test. Do not use this parameter with the URL parameter. |
||
|
Confirm |
Optional |
System.Management.Automation.SwitchParameter |
The Confirm parameter causes the command to pause processing and requires you to acknowledge what the command will do before processing continues. You do not have to specify a value with the Confirm parameter. |
||
|
ConnectionType |
Optional |
Microsoft.Exchange.Monitoring.ProtocolConnectionType |
This parameter specifies the type of connection that is used to connect to the Client Access server. |
||
|
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 cmdlet. |
||
|
LightMode |
Optional |
System.Management.Automation.SwitchParameter |
This parameter is not implemented for the Test-ImapConnectivity cmdlet. Using this parameter does not change the behavior of the cmdlet.
|
||
|
MailboxCredential |
Optional |
System.Management.Automation.PSCredential |
This parameter includes the mailbox credential for a single URL test. |
||
|
MailboxServer |
Optional |
Microsoft.Exchange.Configuration.Tasks.ServerIdParameter |
This parameter specifies the name of the Mailbox server to test. If not specified, all Mailbox servers in the local Active Directory site will be tested. |
||
|
MonitoringContext |
Optional |
System.Management.Automation.SwitchParameter |
If this parameter is included, the task will be run by Microsoft Operations Manager (MOM) scheduling. Running the task with this parameter without MOM will cause the task to fail. If this parameter is excluded, the task must be run interactively by an administrator. |
||
|
PerConnectionTimeout |
Optional |
System.Int32 |
This parameter specifies the amount of time to wait per connection, in seconds, for the test operation to finish. The default value for PerConnectionTimeout is 24 seconds. You must specify a Timeout value greater than 0 seconds and less than 120 seconds. We recommend that you always configure this parameter with a value of 5 seconds or more. |
||
|
PortClientAccessServer |
Optional |
System.Int32 |
This parameter specifies the port to use to connect to the Client Access server that you will use with the Test-ImapConnectivity cmdlet. |
||
|
ResetTestAccountCredentials |
Optional |
System.Management.Automation.SwitchParameter |
Using this parameter will reset the test account credentials to use with the Test-ImapConnectivity cmdlet. |
||
|
Timeout |
Optional |
System.UInt32 |
This parameter specifies the amount of time to wait, in seconds, for the test operation to finish. The default value for Timeout is 30 seconds. You must specify a Timeout value greater than 0 seconds and less than 1 hour (3600 seconds). We recommend that you always configure this parameter with a value of 5 seconds or more. |
||
|
TrustAnySSLCertificate |
Optional |
System.Management.Automation.SwitchParameter |
If this parameter is used, Secure Sockets Layer (SSL) certificate validation failures will not be reported. This parameter lets the Test-ImapConnectivity cmdlet check the IMAP4 service without generating an error when the certificate does not match the URL of the Client Access server. |
||
|
WhatIf |
Optional |
System.Management.Automation.SwitchParameter |
The WhatIf parameter instructs the command to simulate the actions that it would take on the object. By using the WhatIf parameter, you can view what changes would occur without having to apply any of those changes. You do not have to specify a value with the WhatIf parameter. |
Note:Detailed Description
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.
To run the Test-PopConnectivity cmdlet to test IMAP4 functionality on a Client Access server, the account that you use must be delegated the Exchange Server Administrator role and membership in the 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.
Input Types
Return Types
Errors
| Error | Description |
|---|---|
|
|
|
Example
The first code example tests the IMAP4 connectivity for the Client Access server Contoso12 by using the credentials for the user contoso\kweku.
The second code example tests the IMAP4 connectivity of a specific Client Access server named Contoso12 and will test all Exchange 2007 mailboxes.
 Copy Code |
|
|---|---|
Test-ImapConnectivity -ClientAccessServer:Contoso12 -MailboxCredential:(get-credential contoso\kweku) Test-ImapConnectivity -ClientAccessServer:Contoso12 |
|