Class: Mailkube::Events::Event

Inherits:

Node

• Object
• Node
• Mailkube::Events::Event

Defined in:

lib/mailkube/events/envelopes.rb,
sig/mailkube/events/envelopes.rbs

Overview

data is declared per concrete subclass rather than on Event, which is what lets UnknownEvent#data return a raw Hash without conflicting with a typed sibling.

There is no id: the delivery id travels in the X-Webhook-Id header.

Direct Known Subclasses

DomainStatusEvent, EmailBouncedEvent, EmailClickedEvent, EmailDeliveredEvent, EmailDeliveryDelayedEvent, EmailFailedEvent, EmailOpenedEvent, EmailScheduledEvent, EmailSentEvent, EmailSuppressedEvent, UnknownEvent, WebhookStatusEvent

Instance Attribute Summary

Attributes inherited from Node

#raw

Instance Method Summary

• #created_at ⇒ String

  When the event occurred.

• #type ⇒ String

  The event type, e.g.

Methods inherited from Node

#==, #[], #block, #hash, #initialize, #to_h

Constructor Details

This class inherits a constructor from Mailkube::Events::Node

Instance Method Details

#created_at ⇒ String

Returns when the event occurred.

Returns:

• (String) —

  when the event occurred.

# File 'lib/mailkube/events/envelopes.rb', line 17

def created_at = self["created_at"]

#type ⇒ String

Returns the event type, e.g. email.delivered.

Returns:

• (String) —

  the event type, e.g. email.delivered.

# File 'lib/mailkube/events/envelopes.rb', line 15

def type = self["type"]
# @return [String] when the event occurred.