Class: Telnyx::Models::EmailInboxes::ThreadMessage

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

Direct Known Subclasses

InboundMessage

Defined Under Namespace

Modules: Direction, RecordType

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(id:, attachments:, bcc:, cc:, created_at:, direction:, from:, has_quoted_text:, headers:, html_body_url:, in_reply_to:, inbox_id:, inline_files:, labels:, message_id:, read_at:, received_at:, record_type:, references:, reply_text:, reply_to:, sent_at:, status:, subject:, text_body_url:, thread_id:, to:, updated_at:) ⇒ Object

Some parameter documentations has been truncated, see Telnyx::Models::EmailInboxes::ThreadMessage for more details.

Parameters:

  • id (String)
  • attachments (Array<Hash{Symbol=>Object}>)
  • bcc (Array<Telnyx::Models::EmailInboxes::InboundEmailAddress>)
  • cc (Array<Telnyx::Models::EmailInboxes::InboundEmailAddress>)
  • created_at (Time)
  • direction (Symbol, Telnyx::Models::EmailInboxes::ThreadMessage::Direction)
  • from (Telnyx::Models::EmailInboxes::InboundEmailAddress)
  • has_quoted_text (Boolean) —

    Whether conservative plain-text extraction detected a quoted tail. False does no

  • headers (Hash{Symbol=>Object})
  • html_body_url (String, nil) —

    URL for an offloaded HTML body. Null means the body is not offloaded to a URL; a

  • in_reply_to (String, nil)
  • inbox_id (String)
  • inline_files (Array<Hash{Symbol=>Object}>)
  • labels (Array<String>) —

    Mutable message labels used for agent workflow state (for example spam, `needs

  • message_id (String, nil) —

    RFC Message-ID header. Null is possible for legacy outbound messages.

  • read_at (Time, nil) —

    Time the inbound message was marked read. Null means unread.

  • received_at (Time, nil) —

    Receipt time for inbound messages; null for outbound messages.

  • record_type (Symbol, Telnyx::Models::EmailInboxes::ThreadMessage::RecordType)
  • references (Array<String>) —

    Ordered RFC Message-ID values from the References header.

  • reply_text (String, nil) —

    Conservatively extracted new-reply content persisted from the plain-text body du

  • reply_to (Array<Telnyx::Models::EmailInboxes::InboundEmailAddress>)
  • sent_at (Time, nil) —

    Creation/send-acceptance time for outbound messages; null for inbound messages.

  • status (String) —

    Received for inbound messages; the current send status for outbound messages.

  • subject (String, nil)
  • text_body_url (String, nil) —

    URL for an offloaded plain-text body. Null means the body is not offloaded to a

  • thread_id (String)
  • to (Array<Telnyx::Models::EmailInboxes::InboundEmailAddress>)
  • updated_at (Time) 



# File 'lib/telnyx/models/email_inboxes/thread_message.rb', line 172

Instance Attribute Details

#attachments ⇒ Array<Hash{Symbol=>Object}>

Parameters:

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

Returns:

  • (Array<Hash{Symbol=>Object}>) 


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

required :attachments,
Telnyx::Internal::Type::ArrayOf[Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]]

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

Parameters:

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

Returns:



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

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

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

Parameters:

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

Returns:



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

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

#created_at ⇒ Time

Parameters:

  • value (Time)

Returns:

  • (Time) 


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

required :created_at, Time

#direction ⇒ Symbol, Telnyx::Models::EmailInboxes::ThreadMessage::Direction

Parameters:

  • value (Telnyx::Models::EmailInboxes::ThreadMessage::direction)

Returns:



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

required :direction, enum: -> { Telnyx::EmailInboxes::ThreadMessage::Direction }

#from ⇒ Telnyx::Models::EmailInboxes::InboundEmailAddress

Parameters:

  • value (Telnyx::EmailInboxes::InboundEmailAddress)

Returns:



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

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

#has_quoted_text ⇒ Boolean

Whether conservative plain-text extraction detected a quoted tail. False does not prove that the source contains no quoted content.

Parameters:

  • value (Boolean)

Returns:

  • (Boolean) 


48
 
# File 'lib/telnyx/models/email_inboxes/thread_message.rb', line 48

required :has_quoted_text, Telnyx::Internal::Type::Boolean

#headers ⇒ Hash{Symbol=>Object}

Parameters:

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

Returns:

  • (Hash{Symbol=>Object}) 


53
 
# File 'lib/telnyx/models/email_inboxes/thread_message.rb', line 53

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

#html_body_url ⇒ String?

URL for an offloaded HTML body. Null means the body is not offloaded to a URL; an inline HTML body may still exist but is not returned on list reads. Reply extraction uses only the plain-text body during ingest.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


61
 
# File 'lib/telnyx/models/email_inboxes/thread_message.rb', line 61

required :html_body_url, String, nil?: true

#id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :id, String

#in_reply_to ⇒ String?

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


66
 
# File 'lib/telnyx/models/email_inboxes/thread_message.rb', line 66

required :in_reply_to, String, nil?: true

#inbox_id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


71
 
# File 'lib/telnyx/models/email_inboxes/thread_message.rb', line 71

required :inbox_id, String

#inline_files ⇒ Array<Hash{Symbol=>Object}>

Parameters:

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

Returns:

  • (Array<Hash{Symbol=>Object}>) 


76
77
 
# File 'lib/telnyx/models/email_inboxes/thread_message.rb', line 76

required :inline_files,
Telnyx::Internal::Type::ArrayOf[Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]]

#labels ⇒ Array<String>

Mutable message labels used for agent workflow state (for example spam, needs_review, processed). Distinct from the immutable send-time tags on outbound messages: labels are never propagated to Email Detail Records or Mission Control reporting. Always empty for outbound messages. Labels on a message are independent of the labels on its thread.

Parameters:

  • value (::Array[String])

Returns:

  • (Array<String>) 


87
 
# File 'lib/telnyx/models/email_inboxes/thread_message.rb', line 87

required :labels, Telnyx::Internal::Type::ArrayOf[String]

#message_id ⇒ String?

RFC Message-ID header. Null is possible for legacy outbound messages.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


93
 
# File 'lib/telnyx/models/email_inboxes/thread_message.rb', line 93

required :message_id, String, nil?: true

#read_at ⇒ Time?

Time the inbound message was marked read. Null means unread.

Parameters:

  • value (Time, nil)

Returns:

  • (Time, nil) 


99
 
# File 'lib/telnyx/models/email_inboxes/thread_message.rb', line 99

required :read_at, Time, nil?: true

#received_at ⇒ Time?

Receipt time for inbound messages; null for outbound messages.

Parameters:

  • value (Time, nil)

Returns:

  • (Time, nil) 


105
 
# File 'lib/telnyx/models/email_inboxes/thread_message.rb', line 105

required :received_at, Time, nil?: true

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

Parameters:

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

Returns:



110
 
# File 'lib/telnyx/models/email_inboxes/thread_message.rb', line 110

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

#references ⇒ Array<String>

Ordered RFC Message-ID values from the References header.

Parameters:

  • value (::Array[String])

Returns:

  • (Array<String>) 


116
 
# File 'lib/telnyx/models/email_inboxes/thread_message.rb', line 116

required :references, Telnyx::Internal::Type::ArrayOf[String]

#reply_text ⇒ String?

Conservatively extracted new-reply content persisted from the plain-text body during ingest. Null means no plain-text extraction input was available or extraction was skipped or failed; HTML bodies are not parsed.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


124
 
# File 'lib/telnyx/models/email_inboxes/thread_message.rb', line 124

required :reply_text, String, nil?: true

#reply_to ⇒ Array<Telnyx::Models::EmailInboxes::InboundEmailAddress>

Parameters:

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

Returns:



129
 
# File 'lib/telnyx/models/email_inboxes/thread_message.rb', line 129

required :reply_to, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::EmailInboxes::InboundEmailAddress] }

#sent_at ⇒ Time?

Creation/send-acceptance time for outbound messages; null for inbound messages.

Parameters:

  • value (Time, nil)

Returns:

  • (Time, nil) 


135
 
# File 'lib/telnyx/models/email_inboxes/thread_message.rb', line 135

required :sent_at, Time, nil?: true

#status ⇒ String

Received for inbound messages; the current send status for outbound messages.

Parameters:

  • value (String)

Returns:

  • (String) 


141
 
# File 'lib/telnyx/models/email_inboxes/thread_message.rb', line 141

required :status, String

#subject ⇒ String?

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


146
 
# File 'lib/telnyx/models/email_inboxes/thread_message.rb', line 146

required :subject, String, nil?: true

#text_body_url ⇒ String?

URL for an offloaded plain-text body. Null means the body is not offloaded to a URL; an inline plain-text body may still exist but is not returned on list reads. reply_text and has_quoted_text are persisted during ingest before any body offload.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


155
 
# File 'lib/telnyx/models/email_inboxes/thread_message.rb', line 155

required :text_body_url, String, nil?: true

#thread_id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


160
 
# File 'lib/telnyx/models/email_inboxes/thread_message.rb', line 160

required :thread_id, String

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

Parameters:

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

Returns:



165
 
# File 'lib/telnyx/models/email_inboxes/thread_message.rb', line 165

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

#updated_at ⇒ Time

Parameters:

  • value (Time)

Returns:

  • (Time) 


170
 
# File 'lib/telnyx/models/email_inboxes/thread_message.rb', line 170

required :updated_at, Time

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/telnyx/models/email_inboxes/thread_message.rb', line 239

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


124
 
# File 'sig/telnyx/models/email_inboxes/thread_message.rbs', line 124

def to_hash: -> {