Skip to main content
Version: 0.23.1

Email Actions

The Email group reads, sends and files e-mail. It was rebuilt from scratch since 0.14.2.

Migrating from 0.14.2

There is no Create Client action any more. Every action in this group takes an Email Account entry from the Secure Vault instead of receiving a client object built inside the scenario.

The old actions still appear in saved scenarios as Create Client (deprecated), Read Emails (deprecated), Send Email (deprecated), Move Email (deprecated) and Delete Email (deprecated). They keep working, but they are no longer offered in the actions menu. Rebuild those steps with the actions below.

Before you start

Create an Email Account entry in the Vault — see Email Account entries. An entry can hold an IMAP half, an SMTP half, or both:

ActionNeeds
Read Emails, Move Email, Copy Email, Delete Email, Mark Email Seen / UnseenIMAP
Send Email, Forward EmailSMTP

Every action then has an Email Account parameter where you pick the Vault entry by its key.

📸 Screenshot needed — /img/editor/actions/email/email_account_select.png

Capture: any e-mail action's form with the Email Account dropdown open, listing the Email Account entries available from the Vault. Why it is new: this replaces the two Create Client screenshots (email_client_basic.png, email_client_smtp.png), which document a deprecated action and should be deleted.


Read Emails

Fetches messages and exposes them as a list you can loop over.

📸 Screenshot needed — /img/editor/actions/email/email_read.png

Capture: the Read Emails form with Filter by seen status open, plus the Variables panel showing the structure of one fetched message. Why it must be retaken: the form no longer has an Email Client Var field, and Filter by seen status is new.

ParameterDescription
Email AccountVault entry with an IMAP half.
FolderMailbox folder to read. Default INBOX.
LimitMaximum number of messages to fetch. Default 10. Optional.
Filter by seen statusunset (default) fetches regardless of read state, seen only already-read messages, unseen only unread ones.
Save Emails To VariableVariable that receives the list. Default emails.
tip

Combine Filter by seen status: unseen with Mark Email Seen / Unseen at the end of the loop body. The scenario then processes each message exactly once, even if it runs every five minutes.

Send Email

📸 Screenshot needed — /img/editor/actions/email/email_send.png

Capture: the Send Email form with Send as HTML visible. Why it must be retaken: the Email Client Var field is gone and Send as HTML is new.

ParameterDescription
Email AccountVault entry with an SMTP half.
RecipientsAddresses separated by semicolons.
SubjectMessage subject. Optional.
MessageBody text. Accepts variables.
Send as HTMLSends the body as HTML instead of plain text. Default off.

Forward Email

Forwards a message from a Read Emails result to other recipients.

📸 Screenshot needed — /img/editor/actions/email/email_forward.png

Capture: the Forward Email form inside a loop, with Email Message bound to the loop's current item. Why it is new: this action did not exist in 0.14.2.

ParameterDescription
Email AccountVault entry with an SMTP half.
Email MessageThe message to forward — normally the current item of a loop over Read Emails.
RecipientsAddresses separated by semicolons.
SubjectOverrides the forwarded subject. Optional.
Additional MessageText prepended above the forwarded content. Optional.

Move Email / Copy Email

Files a message into another folder. Move removes it from the source folder; Copy leaves it in place.

📸 Screenshot needed — /img/editor/actions/email/email_move.png

Capture: the Move Email form. Why it must be retaken: the form now takes an Email Account and an Email Message instead of a client variable, a source folder and a UID.

ParameterDescription
Email AccountVault entry with an IMAP half.
Email MessageThe message to file.
Destination FolderTarget folder. Default Archive.

Delete Email

📸 Screenshot needed — /img/editor/actions/email/email_delete.png

Capture: the Delete Email form.

ParameterDescription
Email AccountVault entry with an IMAP half.
Email MessageThe message to delete.
warning

Whether this moves the message to Trash or removes it permanently depends on the mail server. Prefer Move Email into an archive folder when the message might be needed again.

Mark Email Seen / Unseen

📸 Screenshot needed — /img/editor/actions/email/email_mark_seen.png

Capture: the Mark Email Seen / Unseen form showing the Mark as seen toggle. Why it is new: this action did not exist in 0.14.2.

ParameterDescription
Email AccountVault entry with an IMAP half.
Email MessageThe message to flag.
Mark as seenOn (default) marks it read; off marks it unread.

Typical mailbox-processing scenario

StepActionNotes
1Read EmailsINBOX, Filter by seen status: unseen, into emails
2ConditionExit early if emails is empty
3Repeat for each item inover emails, current item email
4… processing …inside the loop — save attachments, read data, enter it into the target system
5Mark Email Seen / Unseeninside the loop, so the message is not picked up again
6Move Emailinside the loop, into Processed
7Send As Emailafter the loop — the run report, see Notification