Skip to main content
Fires when a message sent from one of the workspace’s connected mailboxes shows up in a connected mailbox and its thread is a conversation in Custral. Mail sent from Custral and mail sent from the mailbox’s own mail app both count, because Custral sees the sent copy either way.

Payload

string
required
The mail provider’s id for the message. Always present.
string
The mail provider’s id for the thread.
string
The connected mailbox the copy turned up in.
string
The conversation the thread belongs to. Present on every delivery.
string
The address the message was sent from: one of the workspace’s connected mailboxes.
string
The sender’s display name. Omitted when the message carries none.
string[]
The addresses the message was sent to.
string[]
The addresses copied. An empty array when nobody was copied.
string
The subject line. An empty string when the message has none.
string
The message’s date, as an ISO 8601 timestamp. For mail your team sent, this is when it was sent.
string
The provider’s id for the first folder or label the message is filed under. Omitted when the provider lists none.
string[]
Records the message is linked to. Mail from a connected mailbox does not carry them today, so this is omitted.

When it fires

  • The sender is one of the workspace’s connected mailboxes, a teammate’s included, whichever connected mailbox the copy turns up in.
  • The thread is a conversation. A message in a thread that is already a conversation counts. A new outgoing thread counts when the New mail handling setting turns it into one, judged on its recipients, so mail sent only to teammates never counts.

What sends nothing

  • A repeat of the same message. Custral skips a message it has processed in the last five minutes, so a message that lands in several connected mailboxes, such as the sender’s copy and a copied teammate’s, is delivered once.
  • A message in a spam folder. Mail the provider files as spam or junk sends no email event at all.
  • Replies from a forwarding address. When a mailbox forwards its incoming mail to another address, a reply sent from that address is handled by the forwarding and usually sends nothing.

Worth knowing

  • Opens and clicks are separate events, and only for mail a workflow or a sequence sent: email.opened and email.clicked.
  • No body. Read the message itself from the conversation through the Conversations API.
  • Ids belong to one mailbox. Each connected mailbox has its own messageId and threadId for the same mail. Key on conversationId to follow a conversation.

Example