Skip to main content
Go to the Studio
Email

E-mail connection

E-mail connection

Configures an IMAP connection that will be used for reading e-mails. This action does not access the inbox by itself — it only establishes the access credentials that other e-mail actions need in order to work, such as Read inbox and Move e-mail.


Options​

Host​

Enter the address of the IMAP server of the e-mail account. It is usually provided by the e-mail provider.

Port​

Enter the number of the IMAP connection port. The default port with TLS is 993 and without TLS it is 143.

User​

Enter the full e-mail address that will be used for authentication.

Password​

Enter the password of the e-mail account. On some providers, it may be necessary to generate a specific app password.

TLS security​

Defines whether the connection will use TLS encryption for greater security. Select Yes to enable it (recommended) or No to disable it.

Advanced parameters​

Optional field that allows you to provide additional connection settings in code format. Use it only if it is necessary for specific server cases.

Returns​

Custom code​

js
actions["action-id"].host     // address of the IMAP server configured (Text)
actions["action-id"].port     // connection port configured (Number)
actions["action-id"].tls      // indicates whether TLS is enabled (Yes/No)
actions["action-id"].user     // user of the account configured (Text)
actions["action-id"].password // password of the account configured (Text)

Field selection​

  • host — address of the IMAP server (Text)
  • port — connection port (Number)
  • tls — indicates whether TLS is enabled (Yes/No)
  • user — user of the connection (Text)
  • password — password of the connection (Text)

Rules and Conditions​

  • The Host, Port, User and Password fields are required.
  • This action only configures the connection — to read e-mails use Read inbox.
  • The ID of this action is used as a reference by the other e-mail actions that require authentication.