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

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Telnyx::Models::EmailInboxes::EmailDraft

Defined in:

lib/telnyx/models/email_inboxes/email_draft.rb,
sig/telnyx/models/email_inboxes/email_draft.rbs

Overview

See Also:

• Telnyx::Resources::EmailInboxes::Drafts#list

Defined Under Namespace

Modules: RecordType, Status

Instance Attribute Summary

• #attachments ⇒ Array<Hash{Symbol=>Object}>^?
• #bcc ⇒ Array<Telnyx::Models::EmailInboxes::EmailAddress>^?
• #cc ⇒ Array<Telnyx::Models::EmailInboxes::EmailAddress>^?
• #created_at ⇒ Time^?
• #from ⇒ String^?

  Sender address.

• #from_name ⇒ String^?
• #headers ⇒ Hash{Symbol=>String}^?

  Custom headers.

• #html_body ⇒ String^?
• #id ⇒ String
• #inbox_id ⇒ String
• #labels ⇒ Array<String>^?

  Mutable mailbox-state labels.

• #metadata ⇒ Hash{Symbol=>Object}^?

  Arbitrary customer-defined metadata.

• #record_type ⇒ Symbol, Telnyx::Models::EmailInboxes::EmailDraft::RecordType
• #reply_to ⇒ String^?
• #reply_to_message_id ⇒ String^?

  Inbound message this draft replies to.

• #sent_at ⇒ Time^?
• #sent_message_id ⇒ String^?

  The email message created when this draft was sent.

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

  draft until the draft is sent.

• #subject ⇒ String^?
• #tags ⇒ Array<String>^?

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

• #text_body ⇒ String^?
• #thread_id ⇒ String^?

  Conversation thread inherited from the parent message.

• #to ⇒ Array<Telnyx::Models::EmailInboxes::EmailAddress>^?
• #updated_at ⇒ Time^?

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #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 constructor

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

• #to_hash ⇒ {

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<Hash{Symbol=>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 (Hash{Symbol=>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 140

Instance Attribute Details

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

Returns:

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

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

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

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

Returns:

• (Array<Telnyx::Models::EmailInboxes::EmailAddress>, nil)

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

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

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

Returns:

• (Array<Telnyx::Models::EmailInboxes::EmailAddress>, nil)

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

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

#created_at ⇒ Time^?

Parameters:

• (Time)

Returns:

• (Time, nil)

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

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)

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

optional :from, String, nil?: true

#from_name ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

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

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)

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

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

#html_body ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

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

optional :html_body, String, nil?: true

#id ⇒ String

Parameters:

• value (String)

Returns:

• (String)

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

required :id, String

#inbox_id ⇒ String

Parameters:

• value (String)

Returns:

• (String)

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

required :inbox_id, String

#labels ⇒ Array<String>^?

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

Parameters:

• (::Array[String])

Returns:

• (Array<String>, nil)

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

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

#metadata ⇒ Hash{Symbol=>Object}^?

Arbitrary customer-defined metadata.

Parameters:

• (::Hash[Symbol, top])

Returns:

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

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

optional :metadata, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]

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

Parameters:

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

Returns:

• (Symbol, Telnyx::Models::EmailInboxes::EmailDraft::RecordType)

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

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

#reply_to ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

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

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)

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

optional :reply_to_message_id, String, nil?: true

#sent_at ⇒ Time^?

Parameters:

• value (Time, nil)

Returns:

• (Time, nil)

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

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)

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

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:

• (Symbol, Telnyx::Models::EmailInboxes::EmailDraft::Status)

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

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

#subject ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

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

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)

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

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

#text_body ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

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

optional :text_body, String, nil?: true

#thread_id ⇒ String^?

Conversation thread inherited from the parent message.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

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

optional :thread_id, String, nil?: true

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

Returns:

• (Array<Telnyx::Models::EmailInboxes::EmailAddress>, nil)

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

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

#updated_at ⇒ Time^?

Parameters:

• (Time)

Returns:

• (Time, nil)

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

optional :updated_at, Time

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

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

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

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

def to_hash: -> {