Module: Mailkube::Events

Defined in:

lib/mailkube/events/node.rb,
lib/mailkube/events/contexts.rb,
lib/mailkube/events/payloads.rb,
lib/mailkube/events/registry.rb,
lib/mailkube/events/envelopes.rb,
sig/mailkube/events/node.rbs,
sig/mailkube/events/contexts.rbs,
sig/mailkube/events/payloads.rbs,
sig/mailkube/events/registry.rbs,
sig/mailkube/events/envelopes.rbs

Overview

Typed models for inbound webhook payloads.

Defined Under Namespace

Classes: BouncedData, ClickContext, ClickedData, DelayedData, DeliveredData, DeliveryContext, DomainStatusData, DomainStatusEvent, DomainStatusPrevious, EmailBouncedEvent, EmailClickedEvent, EmailDeliveredEvent, EmailDeliveryDelayedEvent, EmailFailedEvent, EmailOpenedEvent, EmailScheduledEvent, EmailSentEvent, EmailSuppressedEvent, EngagementContext, Event, FailedData, FailureContext, MessageContext, Node, OpenedData, ScheduledContext, ScheduledData, SendFailureContext, SentData, SuppressedData, SuppressionContext, UnknownEvent, WebhookStatusData, WebhookStatusEvent, WebhookStatusPrevious

Constant Summary

REGISTRY =

The catalogue. The known-type set is REGISTRY.keys; there is no parallel list.

Returns:

• (Hash[String, singleton(Event)])

{
  "email.sent" => EmailSentEvent,
  "email.delivered" => EmailDeliveredEvent,
  "email.bounced" => EmailBouncedEvent,
  "email.delivery_delayed" => EmailDeliveryDelayedEvent,
  "email.suppressed" => EmailSuppressedEvent,
  "email.scheduled" => EmailScheduledEvent,
  "email.failed" => EmailFailedEvent,
  "email.opened" => EmailOpenedEvent,
  "email.clicked" => EmailClickedEvent,
  "domain.status" => DomainStatusEvent,
  "webhook.status" => WebhookStatusEvent
}.freeze