Update Imap Connector

Audience: Low-code Engineers, System/Security Administrators

Skill Prerequisites: Actions, Tokens, Connectors

Changes an existing IMAP connector, found by its ID. It replaces the connector's title, server, sign-in details and custom data with the values in the action.

The action has one field for each IMAP setting, so you don't need to know the property names. To change connectors of any type, use Update 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.update'. Plant an App can't find the license feature for the IMAP connector type, so the license check stops the action. Use Update Connector instead, or manage the connector on the Connectors page.

Typical Use Cases

• Save a new password after a user changes their mailbox password
• Move a mailbox connector to a new mail server

Don't use it to

• Add a connector. Use Add Imap Connector instead.
• Change a POP3 connector. Use Update POP3 Connector instead.
• Move a connector to another group. The group can't be changed.

Related Actions

Action Name	Description
Add Imap Connector	Adds an IMAP connector and returns its ID.
Get Connector	Reads a connector's data.
Test IMAP Connector	Checks that the connector can sign in.
Update Connector	Changes a connector of any type.
Delete Connector	Deletes a connector.

Input Parameter Reference

Parameter	Description	Supports Tokens	Default	Required
Entry Id	The ID of the connector to change, a GUID. It's usually a token, for example [ImapEntryId].	Yes	empty string	Yes
Entry title	The new name of the connector.	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. Enter ****** to keep the current password.	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

Considerations

• Every value is replaced. Empty fields clear the stored value, including Entry title. Custom data that isn't in the action is removed. Fill in every field, not just the ones that change. To keep the password, enter ******.
• Get the current values first. To change only one value, read the connector with Get Connector and pass the other values back as tokens.
• The connector must exist. If Entry Id is empty, the action fails with Data was not saved due to an invalid EntryId!. If no connector has that ID, the action fails with Requested connector, with id '<Entry Id>', does not exist. An ID that isn't a valid GUID also fails.
• The type isn't checked. Only use this action with IMAP connectors.
• Running triggers pick up the change. An IMAP trigger that's already listening with this connector reconnects with the new details.
• Fill in all four connection settings. The IMAP trigger and Test IMAP Connector reject a connector with an empty Hostname, Use SSL, Username or Password.

Examples

tip

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

1. Save a new mailbox password

This action updates the connector whose ID is in [ImapEntryId] with the new password from the NewPassword form field. The other values are passed back from tokens, so they don't change.

{
    "Title": "Update Imap Connector",
    "ActionType": "cs.ss.trigger.imap.update",
    "Description": "Save the new mailbox password",
    "Parameters": {
        "EntryId": "[ImapEntryId]",
        "EntryName": "[MailboxName]",
        "Hostname": "[ImapServer]",
        "UseSSL": "true",
        "Username": "[Email]",
        "Password": "[NewPassword]"
    }
}

Revised 09/26/2026