Skip to content

Email

The Email object describes the email metadata such as sender, recipients, and direction, and can include embedded URLs and files.

Attributes

Section titled “Attributes”

data_classification

The Data Classification object includes information about data classification levels and data category types.

data_classifications

A list of Data Classification objects, that include information about data classification levels and data category types, identified by a classifier.

from

  • Type: email_t
  • Requirement: recommended

The machine-readable email header From value, as defined by RFC 5322. For example example.user@usersdomain.com.

message_uid

  • Type: string_t
  • Requirement: recommended

The email header Message-ID value, as defined by RFC 5322.

reply_to

  • Type: email_t
  • Requirement: recommended

The machine-readable email header Reply-To value, as defined by RFC 5322. For example example.user@usersdomain.com

size

  • Type: long_t
  • Requirement: recommended

The size in bytes of the email, including attachments.

smtp_from

  • Type: email_t
  • Requirement: recommended

The value of the SMTP MAIL FROM command.

smtp_to

  • Type: email_t
  • Requirement: recommended

The value of the SMTP envelope RCPT TO command.

subject

  • Type: string_t
  • Requirement: recommended

The email header Subject value, as defined by RFC 5322.

to

  • Type: email_t
  • Requirement: recommended

The machine-readable email header To values, as defined by RFC 5322. For example example.user@usersdomain.com

uid

  • Type: string_t
  • Requirement: recommended

The unique identifier of the email thread.

cc

  • Type: email_t
  • Requirement: optional

The machine-readable email header Cc values, as defined by RFC 5322. For example example.user@usersdomain.com.

cc_mailboxes

  • Type: string_t
  • Requirement: optional

The human-readable email header Cc Mailbox values. For example 'Example User <example.user@usersdomain.com>'.

delivered_to

  • Type: email_t
  • Requirement: optional

The machine-readable Delivered-To email header field. For example example.user@usersdomain.com

delivered_to_list

  • Type: email_t
  • Requirement: optional

The machine-readable Delivered-To email header values. For example example.user@usersdomain.com

files

  • Type: file
  • Requirement: optional

The files embedded or attached to the email.

from_list

  • Type: email_t
  • Requirement: optional

The machine-readable email header From values. This array should contain the value in from. For example example.user@usersdomain.com.

from_mailbox

  • Type: string_t
  • Requirement: optional

The human-readable email header From Mailbox value. For example 'Example User <example.user@usersdomain.com>'.

from_mailboxes

  • Type: email_t
  • Requirement: optional

The human-readable email header From Mailbox values. This array should contain the value in from_mailbox. For example 'Example User <example.user@usersdomain.com>'.

http_headers

Additional HTTP headers of an HTTP request or response.

is_read

  • Type: boolean_t
  • Requirement: optional

The indication of whether the email has been read.

raw_header

  • Type: string_t
  • Requirement: optional

The email authentication header.

reply_to_list

  • Type: email_t
  • Requirement: optional

The machine-readable email header Reply-To values, as defined by RFC 5322. For example example.user@usersdomain.com

reply_to_mailboxes

  • Type: string_t
  • Requirement: optional

The human-readable email header Reply To Mailbox values. For example 'Example User <example.user@usersdomain.com>'.

return_path

  • Type: email_t
  • Requirement: optional

The address found in the ‘Return-Path’ header, which indicates where bounce messages (non-delivery reports) should be sent. This address is often set by the sending system and may differ from the ‘From’ or ‘Sender’ addresses. For example, mailer-daemon@senderserver.com.

sender

  • Type: email_t
  • Requirement: optional

The machine readable email address of the system or server that actually transmitted the email message, extracted from the email headers per RFC 5322. This differs from the from field, which shows the message author. The sender field is most commonly used when multiple addresses appear in the from_list field, or when the transmitting system is different from the message author (such as when sending on behalf of someone else).

sender_mailbox

  • Type: string_t
  • Requirement: optional

The human readable email address of the system or server that actually transmitted the email message, extracted from the email headers per RFC 5322. This differs from the from_mailbox field, which shows the message author. The sender mailbox field is most commonly used when multiple addresses appear in the from_mailboxes field, or when the transmitting system is different from the message author (such as when sending on behalf of someone else).

to_mailboxes

  • Type: string_t
  • Requirement: optional

The human-readable email header To Mailbox values. For example 'Example User <example.user@usersdomain.com>'.

urls

  • Type: url
  • Requirement: optional

The URLs embedded in the email.

x_originating_ip

  • Type: ip_t
  • Requirement: optional

The X-Originating-IP header identifying the emails originating IP address(es).

Constraints

Section titled “Constraints”

At least one of: from, to

Used By

Section titled “Used By”