Class: Mailkube::Events::DomainStatusData

Inherits:
Node
  • Object
show all
Defined in:
lib/mailkube/events/payloads.rb,
sig/mailkube/events/payloads.rbs

Overview

The data of domain.status: a sending domain's new state, and its previous one.

Not a MessageContext: a domain lifecycle event is about the domain, not about a message. status and onboarding_state are server-controlled strings, not enums.

Instance Attribute Summary

Attributes inherited from Node

#raw

Instance Method Summary collapse

Methods inherited from Node

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

Constructor Details

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

Instance Method Details

#domain ⇒ String

Returns the domain.

Returns:

  • (String) —

    the domain.



65
66
 
# File 'lib/mailkube/events/payloads.rb', line 65

def domain = self["domain"]
# @return [String] the new status.

#onboarding_state ⇒ String

Returns the new onboarding state.

Returns:

  • (String) —

    the new onboarding state.



69
70
 
# File 'lib/mailkube/events/payloads.rb', line 69

def onboarding_state = self["onboarding_state"]
# @return [DomainStatusPrevious] the state before this change.

#previous ⇒ DomainStatusPrevious

Returns the state before this change.

Returns:



71
 
# File 'lib/mailkube/events/payloads.rb', line 71

def previous = block(DomainStatusPrevious, "previous")

#status ⇒ String

Returns the new status.

Returns:

  • (String) —

    the new status.



67
68
 
# File 'lib/mailkube/events/payloads.rb', line 67

def status = self["status"]
# @return [String] the new onboarding state.