Class: Telnyx::Models::EmailInboxes::EmailDraft

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

Defined Under Namespace

Modules: RecordType, Status

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:, inbox_id:, record_type:, status:, attachments: nil, bcc: nil, cc: nil, created_at: nil, from: nil, from_name: nil, headers: nil, html_body: nil, labels: nil, metadata: nil, reply_to: nil, reply_to_message_id: nil, sent_at: nil, sent_message_id: nil, subject: nil, tags: nil, text_body: nil, thread_id: nil, to: nil, updated_at: nil) ⇒ Object

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

An unsent, mutable draft message belonging to an inbox.

Parameters:

  • id (String)
  • inbox_id (String)
  • record_type (Symbol, Telnyx::Models::EmailInboxes::EmailDraft::RecordType)
  • status (Symbol, Telnyx::Models::EmailInboxes::EmailDraft::Status) —

    draft until the draft is sent. A sent draft is retained for audit and

  • attachments (Array<Object>) (defaults to: nil)
  • bcc (Array<Telnyx::Models::EmailInboxes::EmailAddress>) (defaults to: nil)
  • cc (Array<Telnyx::Models::EmailInboxes::EmailAddress>) (defaults to: nil)
  • created_at (Time) (defaults to: nil)
  • from (String, nil) (defaults to: nil) —

    Sender address. Defaults to the inbox address at send time when null.

  • from_name (String, nil) (defaults to: nil)
  • headers (Hash{Symbol=>String}) (defaults to: nil) —

    Custom headers. Reply drafts carry In-Reply-To and References.

  • html_body (String, nil) (defaults to: nil)
  • labels (Array<String>) (defaults to: nil) —

    Mutable mailbox-state labels. Not propagated to Email Detail Records.

  • metadata (Object) (defaults to: nil) —

    Arbitrary customer-defined metadata.

  • reply_to (String, nil) (defaults to: nil)
  • reply_to_message_id (String, nil) (defaults to: nil) —

    Inbound message this draft replies to. Server-owned; set only on reply drafts.

  • sent_at (Time, nil) (defaults to: nil)
  • sent_message_id (String, nil) (defaults to: nil) —

    The email message created when this draft was sent.

  • subject (String, nil) (defaults to: nil)
  • tags (Array<String>) (defaults to: nil) —

    Transport/reporting attribution tags, propagated to Email Detail Records at send

  • text_body (String, nil) (defaults to: nil)
  • thread_id (String, nil) (defaults to: nil) —

    Conversation thread inherited from the parent message.

  • to (Array<Telnyx::Models::EmailInboxes::EmailAddress>) (defaults to: nil)
  • updated_at (Time) (defaults to: nil) 



# File 'lib/telnyx/models/email_inboxes/email_draft.rb', line 138

Instance Attribute Details

#attachments ⇒ Array<Object>?

Parameters:

  • (::Array[top])

Returns:

  • (Array<Object>, nil) 


32
 
# File 'lib/telnyx/models/email_inboxes/email_draft.rb', line 32

optional :attachments, Telnyx::Internal::Type::ArrayOf[Telnyx::Internal::Type::Unknown]

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

Returns:



37
 
# File 'lib/telnyx/models/email_inboxes/email_draft.rb', line 37

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

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

Returns:



42
 
# File 'lib/telnyx/models/email_inboxes/email_draft.rb', line 42

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

#created_at ⇒ Time?

Parameters:

  • (Time)

Returns:

  • (Time, nil) 


47
 
# File 'lib/telnyx/models/email_inboxes/email_draft.rb', line 47

optional :created_at, Time

#from ⇒ String?

Sender address. Defaults to the inbox address at send time when null.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


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

optional :from, String, nil?: true

#from_name ⇒ String?

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


58
 
# File 'lib/telnyx/models/email_inboxes/email_draft.rb', line 58

optional :from_name, String, nil?: true

#headers ⇒ Hash{Symbol=>String}?

Custom headers. Reply drafts carry In-Reply-To and References.

Parameters:

  • (::Hash[Symbol, String])

Returns:

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


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

optional :headers, Telnyx::Internal::Type::HashOf[String]

#html_body ⇒ String?

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


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

optional :html_body, String, nil?: true

#id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :id, String

#inbox_id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :inbox_id, String

#labels ⇒ Array<String>?

Mutable mailbox-state labels. Not propagated to Email Detail Records.

Parameters:

  • (::Array[String])

Returns:

  • (Array<String>, nil) 


75
 
# File 'lib/telnyx/models/email_inboxes/email_draft.rb', line 75

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

#metadata ⇒ Object?

Arbitrary customer-defined metadata.

Parameters:

  • (top)

Returns:

  • (Object, nil) 


81
 
# File 'lib/telnyx/models/email_inboxes/email_draft.rb', line 81

optional :metadata, Telnyx::Internal::Type::Unknown

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

Parameters:

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

Returns:



20
 
# File 'lib/telnyx/models/email_inboxes/email_draft.rb', line 20

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

#reply_to ⇒ String?

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


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

optional :reply_to, String, nil?: true

#reply_to_message_id ⇒ String?

Inbound message this draft replies to. Server-owned; set only on reply drafts.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


92
 
# File 'lib/telnyx/models/email_inboxes/email_draft.rb', line 92

optional :reply_to_message_id, String, nil?: true

#sent_at ⇒ Time?

Parameters:

  • value (Time, nil)

Returns:

  • (Time, nil) 


97
 
# File 'lib/telnyx/models/email_inboxes/email_draft.rb', line 97

optional :sent_at, Time, nil?: true

#sent_message_id ⇒ String?

The email message created when this draft was sent.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


103
 
# File 'lib/telnyx/models/email_inboxes/email_draft.rb', line 103

optional :sent_message_id, String, nil?: true

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

draft until the draft is sent. A sent draft is retained for audit and becomes immutable.

Parameters:

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

Returns:



27
 
# File 'lib/telnyx/models/email_inboxes/email_draft.rb', line 27

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

#subject ⇒ String?

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


108
 
# File 'lib/telnyx/models/email_inboxes/email_draft.rb', line 108

optional :subject, String, nil?: true

#tags ⇒ Array<String>?

Transport/reporting attribution tags, propagated to Email Detail Records at send time.

Parameters:

  • (::Array[String])

Returns:

  • (Array<String>, nil) 


115
 
# File 'lib/telnyx/models/email_inboxes/email_draft.rb', line 115

optional :tags, Telnyx::Internal::Type::ArrayOf[String]

#text_body ⇒ String?

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


120
 
# File 'lib/telnyx/models/email_inboxes/email_draft.rb', line 120

optional :text_body, String, nil?: true

#thread_id ⇒ String?

Conversation thread inherited from the parent message.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


126
 
# File 'lib/telnyx/models/email_inboxes/email_draft.rb', line 126

optional :thread_id, String, nil?: true

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

Returns:



131
 
# File 'lib/telnyx/models/email_inboxes/email_draft.rb', line 131

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

#updated_at ⇒ Time?

Parameters:

  • (Time)

Returns:

  • (Time, nil) 


136
 
# File 'lib/telnyx/models/email_inboxes/email_draft.rb', line 136

optional :updated_at, Time

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/telnyx/models/email_inboxes/email_draft.rb', line 198

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


134
 
# File 'sig/telnyx/models/email_inboxes/email_draft.rbs', line 134

def to_hash: -> {