Add Imap Connector

Audience: Low-code Engineers, System/Security Administrators

Skill Prerequisites: Actions, Tokens, Connectors

Adds an IMAP connector to a connector group and saves the new connector's ID in a token. An IMAP connector holds the server and sign-in details of a mailbox. The IMAP trigger of an Automation job uses it to listen for new email.

The action has one field for each IMAP setting, so you don't need to know the property names. To add connectors of any type, use Add Connector.

note

This action requires the Email Sync feature to be licensed.

caution

In 1.28, this action fails in apps with the error Could not get Type handler for Feature of 'cs.ss.trigger.imap'. Plant an App can't find the license feature for the IMAP connector type, so the license check stops the action. Use Add Connector with the IMAP connector type instead, or manage the connector on the Connectors page.

Typical Use Cases

• Let users connect their own mailbox from a form, so incoming email can be processed automatically
• Add a mailbox for each new customer or department during onboarding

Don't use it to

• Change an existing IMAP connector. Use Update Imap Connector instead.
• Add a POP3 connector. Use Add POP3 Connector instead.

Related Actions

Action Name	Description
Add Group	Creates the group the connector goes in.
Find Group	Gets the ID of an existing group.
Update Imap Connector	Changes an IMAP connector.
Test IMAP Connector	Checks that the connector can sign in.
Delete Connector	Deletes a connector.
Add Connector	Adds a connector of any type.

Input Parameter Reference

Parameter	Description	Supports Tokens	Default	Required
Group Title	The IMAP group to add the connector to. The list shows the IMAP groups. The value is the group's ID, so it can also be a token, for example [ImapGroupId] from Add Group or Find Group.	Yes	None	Yes
Entry title	The name of the connector, for example Support mailbox.	Yes	empty string	No
Hostname	The IMAP server, for example imap.example.com. To use a port other than the default, add it after a colon, for example imap.example.com:1993.	Yes	empty string	No
Use SSL	true to connect with SSL/TLS, false to connect without it.	Yes	empty string	No
Username	The username or email address used to sign in.	Yes	empty string	No
Password	The password used to sign in. It's stored encrypted.	Yes	empty string	No
Custom Data	Extra name/value pairs to store with the connector. The IMAP trigger turns each one into a [CredentialData:<Key>] token.	Yes	None	No
EntryId Token Name	The name of the token that gets the new connector's ID, for example ImapEntryId.	No	empty string	No

Output Parameters Reference

Parameter	Description
EntryId Token Name	The ID of the new connector, a GUID. Use it with Update Imap Connector, Test IMAP Connector or Delete Connector.

Considerations

• Fill in all four connection settings. The action saves the connector even if some are empty. But the IMAP trigger and Test IMAP Connector reject a connector with an empty Hostname, Use SSL, Username or Password.
• Default ports. The connection uses port 993 when Use SSL is true and port 143 when it's false, unless the hostname includes a port.
• The group must exist. If Group Title is empty or doesn't hold the ID of an existing group, the action fails, for example with Invalid GroupId. Use an IMAP group. The action doesn't check the group's type.
• Titles aren't unique. Running the action twice adds two connectors. Keep the ID from the first run if you need to change the connector later.
• Don't expose the password. Don't write the password to logs or messages. Only pass it from a secure source, for example a password field on a form.
• Test after adding. Run Test IMAP Connector with the new ID to check the details before you rely on them.

Examples

tip

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

1. Add a mailbox from a form

This action adds an IMAP connector to the group whose ID is in [ImapGroupId]. The mailbox details come from the MailboxName, ImapServer, Email and MailboxPassword form fields. The new connector's ID is saved in [ImapEntryId].

{
    "Title": "Add Imap Connector",
    "ActionType": "cs.ss.trigger.imap",
    "Description": "Add the user's mailbox",
    "Parameters": {
        "Group": "[ImapGroupId]",
        "EntryName": "[MailboxName]",
        "Hostname": "[ImapServer]",
        "UseSSL": "true",
        "Username": "[Email]",
        "Password": "[MailboxPassword]",
        "EntryIdTokenName": "ImapEntryId"
    }
}

Revised 09/26/2026