Class: Mailtrap::InboundThreadMessage

Inherits:
Struct
  • Object
show all
Defined in:
lib/mailtrap/inbound_thread_message.rb

Overview

Data Transfer Object for a message inside an inbound thread. Only visibility_status and direction are always present; placeholder entries omit the rest, and the delivery lifecycle fields are only set on available outbound messages.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#attachments ⇒ Array<InboundAttachment>? (readonly)

The message attachments

Returns:



29
30
31
 
# File 'lib/mailtrap/inbound_thread_message.rb', line 29

def attachments
  @attachments
end

#bcc ⇒ Array<String>? (readonly)

Bcc addresses

Returns:

  • (Array<String>, nil) —

    the current value of bcc



29
30
31
 
# File 'lib/mailtrap/inbound_thread_message.rb', line 29

def bcc
  @bcc
end

#bounced_at ⇒ String? (readonly)

Bounce timestamp (outbound messages only)

Returns:

  • (String, nil) —

    the current value of bounced_at



29
30
31
 
# File 'lib/mailtrap/inbound_thread_message.rb', line 29

def bounced_at
  @bounced_at
end

#cc ⇒ Array<String>? (readonly)

Cc addresses

Returns:

  • (Array<String>, nil) —

    the current value of cc



29
30
31
 
# File 'lib/mailtrap/inbound_thread_message.rb', line 29

def cc
  @cc
end

#created_at ⇒ String? (readonly)

ISO 8601 timestamp

Returns:

  • (String, nil) —

    the current value of created_at



29
30
31
 
# File 'lib/mailtrap/inbound_thread_message.rb', line 29

def created_at
  @created_at
end

#delivered_at ⇒ String? (readonly)

Delivery timestamp (outbound messages only)

Returns:

  • (String, nil) —

    the current value of delivered_at



29
30
31
 
# File 'lib/mailtrap/inbound_thread_message.rb', line 29

def delivered_at
  @delivered_at
end

#delivery_status ⇒ String? (readonly)

Delivery status (outbound messages only)

Returns:

  • (String, nil) —

    the current value of delivery_status



29
30
31
 
# File 'lib/mailtrap/inbound_thread_message.rb', line 29

def delivery_status
  @delivery_status
end

#direction ⇒ String (readonly)

inbound or outbound

Returns:

  • (String) —

    the current value of direction



29
30
31
 
# File 'lib/mailtrap/inbound_thread_message.rb', line 29

def direction
  @direction
end

#email_size ⇒ Integer? (readonly)

Message size in bytes

Returns:

  • (Integer, nil) —

    the current value of email_size



29
30
31
 
# File 'lib/mailtrap/inbound_thread_message.rb', line 29

def email_size
  @email_size
end

#from ⇒ String? (readonly)

Sender address

Returns:

  • (String, nil) —

    the current value of from



29
30
31
 
# File 'lib/mailtrap/inbound_thread_message.rb', line 29

def from
  @from
end

#html_body ⇒ String? (readonly)

Decoded HTML body

Returns:

  • (String, nil) —

    the current value of html_body



29
30
31
 
# File 'lib/mailtrap/inbound_thread_message.rb', line 29

def html_body
  @html_body
end

#id ⇒ String? (readonly)

The message ID

Returns:

  • (String, nil) —

    the current value of id



29
30
31
 
# File 'lib/mailtrap/inbound_thread_message.rb', line 29

def id
  @id
end

#in_reply_to ⇒ String? (readonly)

Value of the RFC 5322 In-Reply-To header

Returns:

  • (String, nil) —

    the current value of in_reply_to



29
30
31
 
# File 'lib/mailtrap/inbound_thread_message.rb', line 29

def in_reply_to
  @in_reply_to
end

#message_group_id ⇒ String? (readonly)

Groups messages sent together as one logical send

Returns:

  • (String, nil) —

    the current value of message_group_id



29
30
31
 
# File 'lib/mailtrap/inbound_thread_message.rb', line 29

def message_group_id
  @message_group_id
end

#references ⇒ Array<String>? (readonly)

Values of the RFC 5322 References header

Returns:

  • (Array<String>, nil) —

    the current value of references



29
30
31
 
# File 'lib/mailtrap/inbound_thread_message.rb', line 29

def references
  @references
end

#reply_to ⇒ String? (readonly)

Reply-To address

Returns:

  • (String, nil) —

    the current value of reply_to



29
30
31
 
# File 'lib/mailtrap/inbound_thread_message.rb', line 29

def reply_to
  @reply_to
end

#rfc_message_id ⇒ String? (readonly)

Value of the RFC 5322 Message-ID header

Returns:

  • (String, nil) —

    the current value of rfc_message_id



29
30
31
 
# File 'lib/mailtrap/inbound_thread_message.rb', line 29

def rfc_message_id
  @rfc_message_id
end

#subject ⇒ String? (readonly)

Email subject

Returns:

  • (String, nil) —

    the current value of subject



29
30
31
 
# File 'lib/mailtrap/inbound_thread_message.rb', line 29

def subject
  @subject
end

#text_body ⇒ String? (readonly)

Decoded text body

Returns:

  • (String, nil) —

    the current value of text_body



29
30
31
 
# File 'lib/mailtrap/inbound_thread_message.rb', line 29

def text_body
  @text_body
end

#to ⇒ Array<String>? (readonly)

Recipient addresses

Returns:

  • (Array<String>, nil) —

    the current value of to



29
30
31
 
# File 'lib/mailtrap/inbound_thread_message.rb', line 29

def to
  @to
end

#visibility_status ⇒ String (readonly)

available or placeholder

Returns:

  • (String) —

    the current value of visibility_status



29
30
31
 
# File 'lib/mailtrap/inbound_thread_message.rb', line 29

def visibility_status
  @visibility_status
end