Options
All
  • Public
  • Public/Protected
  • All
Menu

External module MailEvent

Index

Type aliases

BasePayload

BasePayload: { id: string; log_level: string; recipient: string; recipient_domain: string; tags: string[]; timestamp: string }

Type declaration

  • id: string
  • log_level: string
  • recipient: string
  • recipient_domain: string
  • tags: string[]
  • timestamp: string

Clicked

Clicked: BasePayload & { event: "clicked"; geolocation: Location; message: { headers: { message_id: string } } }

Complained

Complained: BasePayload & { envelope: { sending_ip: string }; event: "complained"; message: { headers: { from_dest: string; message_id: string; subject: string; to_dest: string } } }

Delivered

Delivered: BasePayload & { delivery_status: { attempt_no: number; certificate_verified: boolean; code: number; description: string; message: string; mx_host: string; session_seconds: number; tls: boolean }; envelope: Envelope; event: "delivered"; flags: Flags; message: { headers: { from_dest: string; message_id: string; subject: string; to_dest: string } } }

Envelope

Envelope: { sender: string; sending_ip: string; targets: string; transport: string }

Type declaration

  • sender: string
  • sending_ip: string
  • targets: string
  • transport: string

Failed

Failed: BasePayload & { delivery_status: { attempt_no: number; code: number; description: string; message: string; retry_seconds: number; session_seconds: number }; envelope: Envelope; event: "failed"; flags: Flags; message: { headers: { from_dest: string; message_id: string; subject: string; to_dest: string } }; reason: string; severity: string }

Flags

Flags: { is_authenticated: boolean; is_routed: boolean; is_system_test: boolean; is_test_mode: boolean }

Type declaration

  • is_authenticated: boolean
  • is_routed: boolean
  • is_system_test: boolean
  • is_test_mode: boolean

Location

Location: { city: string; country: string; region: string }

Type declaration

  • city: string
  • country: string
  • region: string

Opened

Opened: BasePayload & { event: "opened"; geolocation: Location; ip: string; message: { headers: { message_id: string } } }

Payload

Unsubscribed

Unsubscribed: BasePayload & { delivery_status: { attempt_no: number; code: number; description: string; message: string; retry_seconds: number; session_seconds: number }; event: "unsubscribed"; geolocation: Location; ip: string; message: { headers: { message_id: string } } }

Generated using TypeDoc