Test IMAP Connector

Audience: Low-code Engineers, System/Security Administrators

Skill Prerequisites: Actions, Tokens, Connectors

Checks that one or more IMAP connectors can sign in to their mail server. For each connector, it checks that the connection settings are filled in, connects to the server and signs in with the username and password. Then it disconnects. No mail is read.

The result goes into two tokens: a yes/no value that says whether all connectors passed, and a log with the details for each connector.

note

This action requires the Email Sync feature to be licensed.

Typical Use Cases

• Check a mailbox connector right after it's added with Add Imap Connector or changed with Update Imap Connector
• Check all connectors in a group before an IMAP trigger in an Automation job starts using them
• Tell a user that the mailbox details they entered are wrong

Don't use it to

• Test other connector types. Use Test Connector instead. There's no test action for POP3 connectors.
• Read or process email. Use the IMAP trigger of an Automation job.

Related Actions

Action Name	Description
Add Imap Connector	Adds an IMAP connector.
Update Imap Connector	Changes an IMAP connector.
Test Connector	Tests connectors of other types.
Get Connector	Reads a connector's data.

Input Parameter Reference

Parameter	Description	Supports Tokens	Default	Required
Connector	The IMAP connector to test. Pick a single connector, or a group to test every connector in it. In expression mode, enter a connector ID, for example a token such as [ImapEntryId].	Yes, in expression mode	None	Yes
Validation errors output token	The name of the token that gets the test log, for example ImapTestLog.	No	empty string	No
Is valid output token	The name of the token that gets True if every connector passed, or False if any failed, for example ImapIsValid.	No	empty string	No

Output Parameters Reference

Parameter	Description
Validation errors output token	A text log with a few lines for each connector. It starts with Verifying credential '<title>'. and ends with Credential '<title>' is valid. or the reason it failed.
Is valid output token	True if every connector passed, False if at least one failed.

What's checked

The action tests each connector in turn. A failure doesn't stop the test of the next connector.

Check	Message in the log when it fails
Hostname, UseSSL, Username and Password all have a value	<b>Hostname</b> information missing or empty. (one line for each empty value)
The server accepts the connection	Failed to connect to IMAP Server., followed by the underlying error
The server accepts the username and password	Failed to authenticate to the IMAP Server., followed by the underlying error

The connection uses port 993 when UseSSL is true, and port 143 when it's false. A port in the hostname, for example imap.example.com:1993, overrides this.

Considerations

• Check that a connector was found. If the selected connector or group can't be found, the log says No credentials selected. but the valid token is still True. When the connector comes from a token, check the log too.
• The log contains HTML. Missing-value messages include <b> tags. Remove them, or show the log where HTML is displayed.
• Groups can be slow. Every connector in a group is contacted one after another, so a large group or an unreachable server makes the action take longer.
• Nothing is changed. The test doesn't change the connector or read any mail.

Examples

tip

To understand how to use the below examples, please see Running Examples.

1. Test a newly added connector

This action tests the connector whose ID is in the ImapEntryId token, for example from Add Imap Connector. The result is saved in [ImapIsValid] and the log in [ImapTestLog].

{
    "Title": "Test IMAP Connector",
    "ActionType": "TestImapCredentials",
    "Description": "Check the new mailbox connector",
    "Parameters": {
        "Credentials": {
            "IsExpression": true,
            "Entry": "[ImapEntryId]"
        },
        "ValidationErrorsOutputToken": "ImapTestLog",
        "IsValidOutputToken": "ImapIsValid"
    }
}

Revised 09/26/2026