Class: Telnyx::Models::EmailInboxes::EmailMessage

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/telnyx/models/email_inboxes/email_message.rb,
sig/telnyx/models/email_inboxes/email_message.rbs

Defined Under Namespace

Modules: RecordType, Status Classes: Attachment

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(content_id:, content_type:, disposition:, filename:, sha256:, size_bytes:, url:) ⇒ Object

Some parameter documentations has been truncated, see Attachment for more details.

EDR-aligned attachment metadata. The base64 content is never returned.

Parameters:

  • content_id (String, nil) —

    MIME Content-ID for inline references.

  • content_type (String)
  • disposition (String) —

    MIME disposition (e.g. attachment or inline). Runtime passes through the sto

  • filename (String)
  • sha256 (String, nil) —

    SHA-256 hex digest of the attachment content.

  • size_bytes (Integer, nil) —

    Attachment size in bytes.

  • url (String, nil) —

    Telnyx-hosted public URL for the attachment content.




# File 'lib/telnyx/models/email_inboxes/email_message.rb', line 191

Instance Attribute Details

#attachments ⇒ Array<Telnyx::Models::EmailInboxes::EmailMessage::Attachment>

Parameters:

  • value (::Array[Telnyx::EmailInboxes::EmailMessage::Attachment])

Returns:



15
16
 
# File 'lib/telnyx/models/email_inboxes/email_message.rb', line 15

required :attachments,
-> { Telnyx::Internal::Type::ArrayOf[Telnyx::EmailInboxes::EmailMessage::Attachment] }

#bcc ⇒ Array<Telnyx::Models::EmailInboxes::EmailAddress>

Parameters:

  • value (::Array[Telnyx::EmailInboxes::EmailAddress])

Returns:



21
 
# File 'lib/telnyx/models/email_inboxes/email_message.rb', line 21

required :bcc, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::EmailInboxes::EmailAddress] }

#cc ⇒ Array<Telnyx::Models::EmailInboxes::EmailAddress>

Parameters:

  • value (::Array[Telnyx::EmailInboxes::EmailAddress])

Returns:



26
 
# File 'lib/telnyx/models/email_inboxes/email_message.rb', line 26

required :cc, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::EmailInboxes::EmailAddress] }

#created_at ⇒ Time

Parameters:

  • value (Time)

Returns:

  • (Time) 


31
 
# File 'lib/telnyx/models/email_inboxes/email_message.rb', line 31

required :created_at, Time

#events ⇒ Array<Telnyx::Models::MessageEvent>

Parameters:

Returns:



36
 
# File 'lib/telnyx/models/email_inboxes/email_message.rb', line 36

required :events, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::MessageEvent] }

#from ⇒ Telnyx::Models::EmailInboxes::EmailAddress

Parameters:

  • value (Telnyx::EmailInboxes::EmailAddress)

Returns:



41
 
# File 'lib/telnyx/models/email_inboxes/email_message.rb', line 41

required :from, -> { Telnyx::EmailInboxes::EmailAddress }

#id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


10
 
# File 'lib/telnyx/models/email_inboxes/email_message.rb', line 10

required :id, String

#inline_css ⇒ Boolean?

Present when true in the immediate create response. Not persisted; absent on subsequent GET requests.

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


86
 
# File 'lib/telnyx/models/email_inboxes/email_message.rb', line 86

optional :inline_css, Telnyx::Internal::Type::Boolean

#recipient_statuses ⇒ Hash{Symbol=>Integer}?

Per-status recipient counts for the message. Present only for outbound messages with recipient rows. Keys are recipient statuses, values are counts. Example: {"delivered": 998, "bounced": 2}.

Returns:

  • (Hash{Symbol=>Integer}, nil) 


94
 
# File 'lib/telnyx/models/email_inboxes/email_message.rb', line 94

optional :recipient_statuses, Telnyx::Internal::Type::HashOf[Integer]

#record_type ⇒ Symbol, Telnyx::Models::EmailInboxes::EmailMessage::RecordType

Parameters:

  • value (Telnyx::Models::EmailInboxes::EmailMessage::record_type)

Returns:



46
 
# File 'lib/telnyx/models/email_inboxes/email_message.rb', line 46

required :record_type, enum: -> { Telnyx::EmailInboxes::EmailMessage::RecordType }

#reply_to ⇒ String?

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


51
 
# File 'lib/telnyx/models/email_inboxes/email_message.rb', line 51

required :reply_to, String, nil?: true

#sandbox ⇒ Boolean?

Present when sandbox mode was used.

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


100
 
# File 'lib/telnyx/models/email_inboxes/email_message.rb', line 100

optional :sandbox, Telnyx::Internal::Type::Boolean

#scheduled_at ⇒ Time?

Present when a scheduled_at value was stored. Persists even after the scheduled send has been processed or cancelled.

Parameters:

  • (Time)

Returns:

  • (Time, nil) 


107
 
# File 'lib/telnyx/models/email_inboxes/email_message.rb', line 107

optional :scheduled_at, Time

#status ⇒ Symbol, Telnyx::Models::EmailInboxes::EmailMessage::Status

Current status of an email message. Lifecycle statuses (queued, scheduled, etc.) are set on creation. Delivery statuses (delivered, bounced, etc.) are updated by delivery event consumers.

Parameters:

  • value (Telnyx::Models::EmailInboxes::EmailMessage::status)

Returns:



59
 
# File 'lib/telnyx/models/email_inboxes/email_message.rb', line 59

required :status, enum: -> { Telnyx::EmailInboxes::EmailMessage::Status }

#subject ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


64
 
# File 'lib/telnyx/models/email_inboxes/email_message.rb', line 64

required :subject, String

#template_id ⇒ String?

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


69
 
# File 'lib/telnyx/models/email_inboxes/email_message.rb', line 69

required :template_id, String, nil?: true

#template_variables ⇒ Hash{Symbol=>Object}

Parameters:

  • value (::Hash[Symbol, top])

Returns:

  • (Hash{Symbol=>Object}) 


74
 
# File 'lib/telnyx/models/email_inboxes/email_message.rb', line 74

required :template_variables, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]

#to ⇒ Array<Telnyx::Models::EmailInboxes::EmailAddress>

Parameters:

  • value (::Array[Telnyx::EmailInboxes::EmailAddress])

Returns:



79
 
# File 'lib/telnyx/models/email_inboxes/email_message.rb', line 79

required :to, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::EmailInboxes::EmailAddress] }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/telnyx/models/email_inboxes/email_message.rb', line 218

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


94
 
# File 'sig/telnyx/models/email_inboxes/email_message.rbs', line 94

def to_hash: -> {