Docs »

Records »

Types »

Mailbox Account

Name (singular): Email Mailbox
Name (plural): Email Mailboxes
Alias (uri): mailbox
Identifier (ID): cerberusweb.contexts.mailbox

Usage tracking

Mailbox worklists offer a 'Usage' sparklines column charting messages received and errors, with a 2h/1d/30d range toggle. A matching usage: quick search filter queries the same data – for instance, usage:(since:today).

Records API

These fields are available in the Records API and packages:

Req'd Field Type Notes
  checked_at timestamp The date/time this mailbox was last checked for new messages
  connected_account_id number The optional connected account to use for XOAUTH2
x host text The mail server hostname
  is_enabled boolean Is this mailbox enabled? 1 for true and 0 for false
  links links An array of record type:id tuples to link to. Prefix with - to unlink.
  max_msg_size_kb number The maximum message size to download (in kilobytes); 0 to disable limits
x name text The name of this email mailbox
  num_fails number The number of consecutive failures
  password text The mailbox password
  port number The port to connect to; e.g. 587
  protocol text The protocol to use. One of six exact lowercase values – see below
  timeout_secs number The socket timeout in seconds when downloading mail
  updated_at timestamp The date/time when this record was last modified
x username text The mailbox username

Protocol values

protocol accepts six values, each stored exactly as written, in lowercase:

Value Connection Default port
pop3 Unencrypted 110
pop3-starttls STARTTLS upgrade on the plain port 110
pop3-ssl Implicit TLS on a dedicated port 995
imap Unencrypted 143
imap-starttls STARTTLS upgrade on the plain port 143
imap-ssl Implicit TLS on a dedicated port 993

-starttls and -ssl are not interchangeable. STARTTLS opens a plain connection on the standard port and upgrades it; implicit TLS is encrypted from the first byte on a dedicated port. Choosing imap-ssl when your server expects STARTTLS connects to the wrong port with the wrong handshake.

Values are matched exactly, in lowercase. The Records API, packages, and workflows reject anything else at validation rather than storing it, so IMAP-SSL, imaps, or imap_ssl fail with a validation error instead of being accepted. The editor's dropdown can only produce a valid value.

Dictionary Placeholders

These placeholders are available in dictionaries for automations, snippets, and API responses:

Field Type Description
_context text Record type extension ID
_label text Label
_type text Record type alias
checked_at date Checked At
connected_account_id number Connected Account
host text Host
id number Id
is_enabled boolean Enabled
max_msg_size_kb number Max Msg Size
name text Name
num_fails number Num Fails
port number Port
protocol text Protocol
record_url text Record Url
timeout_secs number Timeout Secs
updated_at date Updated
username text Username

These optional placeholders are also available with key expansion in dictionaries and the API:

Field Type Description
comment_count number Comment count on the record
comments comments Comments
custom_<id> mixed Custom Fields
links links Links
watchers watchers Watchers

Search Query Fields

These filters are available in mailbox account search queries:

Field Type Description
checkedAt: date Checked At
enabled: boolean Enabled
fail.count: number Num Fails
fieldset: record Fieldset
host: text Host
id: number Id
links: links Record Links
name: text Name
protocol: text Protocol
updated: date Updated
watchers: record Watchers

Worklist Columns

These columns are available on mailbox account worklists:

Column Description
cf_<id> Custom Field
p_checked_at Checked At
p_connected_account_id Connected Account
p_delay_until Delay Until
p_enabled Enabled
p_host Host
p_id Id
p_max_msg_size_kb Max Msg Size
p_name Name
p_num_fails Num Fails
p_port Port
p_protocol Protocol
p_timeout_secs Timeout Secs
p_updated_at Updated
p_username User