Class: Inttegro::MessageTemplate::Mailbox

Inherits:
T::Struct
  • Object
show all
Defined in:
lib/inttegro/message_template/mailbox.rb

Overview

Typed representation of the mailbox object in the Inttegro API.

This generated model is immutable. Construct it with .new, or decode a string-keyed API payload with .from_hash. #serialize produces a string-keyed hash using the original wire field names and serialized enum values.

Instance Attribute Summary collapse

Instance Attribute Details

#address ⇒ String (readonly)

Literal or templated mailbox address, such as {{recipient_email}}.

Required in the API payload. Wire name: address.

Returns:

  • (String)


29
30
31
32
# File 'lib/inttegro/message_template/mailbox.rb', line 29

class Mailbox < T::Struct
  const :address, String
  const :name, T.nilable(String), default: nil
end

#name ⇒ String? (readonly)

Value of the name field in the Inttegro API payload.

Optional in the API payload; omitted values default to nil. Wire name: name.

Returns:

  • (String, nil)


29
30
31
32
# File 'lib/inttegro/message_template/mailbox.rb', line 29

class Mailbox < T::Struct
  const :address, String
  const :name, T.nilable(String), default: nil
end