Skip to Content

The TrafficEvent type of the TypeScript SDK, which domains.listEvents take or answer.

type TrafficEvent = {
  attempt: number | null
  blobHash: string | null
  deliveryId: string | null
  detail: string | null
  envelopeFrom: string | null
  envelopeTo: string | null
  eventTime: number
  mailboxId: string | null
  matchedBy: string | null
  messageId: string | null
  messageIdHeader: string | null
  originalAddress: string | null
  outcome: string
  response: string | null
  routeKind: string | null
  routeTarget: string | null
  size: number | null
  source: string
  subject: string | null
  template: TrafficEventTemplate | null
}

Fields

FieldTypeDescription
attemptnumber | nullDelivery retry attempt number, or null
blobHashstring | nullStorage blob SHA-256 hash, or null
deliveryIdstring | nullDelivery ID identifier, or null
detailstring | nullDiagnostic detail or error message, or null
envelopeFromstring | nullSMTP envelope sender address, or null
envelopeTostring | nullSMTP envelope recipient address, or null
eventTimenumberEvent timestamp in epoch seconds
mailboxIdstring | nullAssociated mailbox ULID, or null
matchedBystring | nullRoute ID or rule that handled the message, or null
messageIdstring | nullInternal message ULID, or null
messageIdHeaderstring | nullRFC 5322 Message-ID header, or null
originalAddressstring | nullOriginal recipient before alias expansion, or null
outcomestringResult outcome ('delivered', 'rejected', 'tempfail', 'bounced')
responsestring | nullRemote SMTP server response line, or null
routeKindstring | nullRoute kind ('mailbox', 'forward', 'pipe', 'discard'), or null
routeTargetstring | nullRoute target destination address or mailbox ID, or null
sizenumber | nullMessage size in bytes, or null
sourcestringEvent source component ('inbound', 'outbound', 'relay', 'imap')
subjectstring | nullMessage subject line, or null
templateTrafficEventTemplate | nullThe prepared email this message was sent from, or null for any other mail. Present on each recipient's admission row and on every relay attempt after it; filter on it with template.

Used by

MethodWhat it does
domains.listEventsQuery domain delivery event log

Used in

AccountTrafficEvent, DomainEvents.