Add POP3 Connector

Audience: Low-code Engineers, System/Security Administrators

Skill Prerequisites: Actions, Tokens, Connectors

Adds a POP3 connector to a connector group and saves the new connector's ID in a token. A POP3 connector holds the server and sign-in details of a mailbox. The POP Mail trigger of an Automation job uses it to check for new email.

The action has one field for each POP3 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

The POP Mail trigger is obsolete. For new applications, use IMAP with Add Imap Connector instead.

Typical Use Cases

• Add a POP3 mailbox for an existing application that still uses the POP Mail trigger
• Let users connect a mailbox that only supports POP3

Don't use it to

• Change an existing POP3 connector. Use Update POP3 Connector instead.
• Add an IMAP connector. Use Add Imap 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 POP3 Connector	Changes a POP3 connector.
Delete Connector	Deletes a connector.
Add Imap Connector	Adds an IMAP connector.
Add Connector	Adds a connector of any type.

Input Parameter Reference

Parameter	Description	Supports Tokens	Default	Required
Group Title	The POP3 group to add the connector to. The list shows the POP3 groups. The value is the group's ID, so it can also be a token, for example [Pop3GroupId] from Add Group or Find Group.	Yes	None	Yes
Entry title	The name of the connector, for example Orders mailbox.	Yes	empty string	No
POP3 Server	The POP3 server, for example pop.example.com. To use a port other than the default, add it after a colon, for example pop.example.com:1995.	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.	Yes	None	No
EntryId Token Name	The name of the token that gets the new connector's ID, for example Pop3EntryId.	No	empty string	No

Output Parameters Reference

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

Considerations

• Fill in all four connection settings. The action saves the connector even if some are empty, but the POP Mail trigger can't connect without them.
• Default ports. The connection uses port 995 when Use SSL is true and port 110 when it's false, unless the server 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 a POP3 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.
• There's no test action for POP3. Test IMAP Connector only works with IMAP connectors.

Examples

tip

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

1. Add a POP3 mailbox from a form

This action adds a POP3 connector to the group whose ID is in [Pop3GroupId]. The mailbox details come from the MailboxName, Pop3Server, Email and MailboxPassword form fields. The new connector's ID is saved in [Pop3EntryId].

{
    "Title": "Add POP3 Connector",
    "ActionType": "cs.ss.trigger.pop3",
    "Description": "Add the user's POP3 mailbox",
    "Parameters": {
        "Group": "[Pop3GroupId]",
        "EntryName": "[MailboxName]",
        "Hostname": "[Pop3Server]",
        "UseSSL": "true",
        "Username": "[Email]",
        "Password": "[MailboxPassword]",
        "EntryIdTokenName": "Pop3EntryId"
    }
}

Revised 09/26/2026