Class: Mailtrap::EmailLogMessage

Inherits:

Struct

• Object
• Struct
• Mailtrap::EmailLogMessage

Defined in:

lib/mailtrap/email_log_message.rb

Overview

Data Transfer Object for an email log message (summary in list, full details when fetched by ID)

See Also:

• https://docs.mailtrap.io/developers/email-sending/email-logs

Instance Attribute Summary

• #category ⇒ String^? readonly

  Message category.

• #clicks_count ⇒ Integer readonly

  Number of clicks.

• #client_ip ⇒ String^? readonly

  Client IP that sent the email.

• #custom_variables ⇒ Hash^? readonly

  Custom variables.

• #events ⇒ Array<EmailLogEvent>^? readonly

  Event list (only when fetched by ID).

• #from ⇒ String readonly

  Sender address.

• #message_id ⇒ String readonly

  Message UUID.

• #opens_count ⇒ Integer readonly

  Number of opens.

• #raw_message_url ⇒ String^? readonly

  Signed URL to download raw .eml (only when fetched by ID).

• #sending_domain_id ⇒ Integer readonly

  Sending domain ID.

• #sending_stream ⇒ String readonly

  transactional or bulk.

• #sent_at ⇒ String readonly

  ISO 8601 timestamp.

• #status ⇒ String readonly

  delivered, not_delivered, enqueued, opted_out.

• #subject ⇒ String^? readonly

  Email subject.

• #template_id ⇒ Integer^? readonly

  Template ID if sent from template.

• #template_variables ⇒ Hash^? readonly

  Template variables.

• #to ⇒ String readonly

  Recipient address.

Instance Attribute Details

#category ⇒ String^? (readonly)

Message category

Returns:

• (String, nil) —

  the current value of category

# File 'lib/mailtrap/email_log_message.rb', line 23

def category
  @category
end

#clicks_count ⇒ Integer (readonly)

Number of clicks

Returns:

• (Integer) —

  the current value of clicks_count

# File 'lib/mailtrap/email_log_message.rb', line 23

def clicks_count
  @clicks_count
end

#client_ip ⇒ String^? (readonly)

Client IP that sent the email

Returns:

• (String, nil) —

  the current value of client_ip

# File 'lib/mailtrap/email_log_message.rb', line 23

def client_ip
  @client_ip
end

#custom_variables ⇒ Hash^? (readonly)

Custom variables

Returns:

• (Hash, nil) —

  the current value of custom_variables

# File 'lib/mailtrap/email_log_message.rb', line 23

def custom_variables
  @custom_variables
end

#events ⇒ Array<EmailLogEvent>^? (readonly)

Event list (only when fetched by ID)

Returns:

• (Array<EmailLogEvent>, nil) —

  the current value of events

# File 'lib/mailtrap/email_log_message.rb', line 23

def events
  @events
end

#from ⇒ String (readonly)

Sender address

Returns:

• (String) —

  the current value of from

# File 'lib/mailtrap/email_log_message.rb', line 23

def from
  @from
end

#message_id ⇒ String (readonly)

Message UUID

Returns:

• (String) —

  the current value of message_id

# File 'lib/mailtrap/email_log_message.rb', line 23

def message_id
  @message_id
end

#opens_count ⇒ Integer (readonly)

Number of opens

Returns:

• (Integer) —

  the current value of opens_count

# File 'lib/mailtrap/email_log_message.rb', line 23

def opens_count
  @opens_count
end

#raw_message_url ⇒ String^? (readonly)

Signed URL to download raw .eml (only when fetched by ID)

Returns:

• (String, nil) —

  the current value of raw_message_url

# File 'lib/mailtrap/email_log_message.rb', line 23

def raw_message_url
  @raw_message_url
end

#sending_domain_id ⇒ Integer (readonly)

Sending domain ID

Returns:

• (Integer) —

  the current value of sending_domain_id

# File 'lib/mailtrap/email_log_message.rb', line 23

def sending_domain_id
  @sending_domain_id
end

#sending_stream ⇒ String (readonly)

transactional or bulk

Returns:

• (String) —

  the current value of sending_stream

# File 'lib/mailtrap/email_log_message.rb', line 23

def sending_stream
  @sending_stream
end

#sent_at ⇒ String (readonly)

ISO 8601 timestamp

Returns:

• (String) —

  the current value of sent_at

# File 'lib/mailtrap/email_log_message.rb', line 23

def sent_at
  @sent_at
end

#status ⇒ String (readonly)

delivered, not_delivered, enqueued, opted_out

Returns:

• (String) —

  the current value of status

# File 'lib/mailtrap/email_log_message.rb', line 23

def status
  @status
end

#subject ⇒ String^? (readonly)

Email subject

Returns:

• (String, nil) —

  the current value of subject

# File 'lib/mailtrap/email_log_message.rb', line 23

def subject
  @subject
end

#template_id ⇒ Integer^? (readonly)

Template ID if sent from template

Returns:

• (Integer, nil) —

  the current value of template_id

# File 'lib/mailtrap/email_log_message.rb', line 23

def template_id
  @template_id
end

#template_variables ⇒ Hash^? (readonly)

Template variables

Returns:

• (Hash, nil) —

  the current value of template_variables

# File 'lib/mailtrap/email_log_message.rb', line 23

def template_variables
  @template_variables
end

#to ⇒ String (readonly)

Recipient address

Returns:

• (String) —

  the current value of to

# File 'lib/mailtrap/email_log_message.rb', line 23

def to
  @to
end