Skip to main content
Go to the Studio
Email

Read inbox

Read inbox

Searches for e-mails in a mailbox based on filtering criteria such as read status, sender, subject or content. It returns a list of e-mails matching the filters defined, which can be processed together with the Get e-mail from list action.


Options​

Connection ID​

Select the E-mail connection action that will be used to access the inbox.

Box name​

Enter the name of the mailbox to be read. The default value is INBOX for the main inbox. Custom boxes can be provided according to the account structure.

Types of email reading​

Select the main filter by e-mail status. The options available are:

  • All emails — returns every e-mail with no status filter
  • New and unviewed emails — returns only newly arrived and unread e-mails
  • Emails viewed — returns only e-mails already read
  • Emails not seen — returns e-mails that have not been opened yet
  • Flagged emails — returns e-mails marked with a flag
  • Draft emails pending delivery — returns e-mails saved as drafts waiting to be sent

Email search filters​

Add additional filters to refine the search. Each filter defines a field and the value to be searched for. The fields available include subject, sender, addressee, body and text. This field is optional.

Returns​

Custom code​

js
actions["action-id"].values // list of e-mails found matching the filters (List)
actions["action-id"].count  // number of e-mails found (Number)

Field selection​

  • values — list of e-mails found (List)
  • count — number of e-mails returned (Number)

Rules and Conditions​

  • The Connection ID field is required.
  • The default value of the Box name field is INBOX.
  • The additional filters can be combined for more precise results.
  • To access the e-mails individually, use the Get e-mail from list action referencing this one.