Class: Mailtrap::SandboxMessagesAPI

Inherits:

Object

• Object
• Mailtrap::SandboxMessagesAPI

Includes:

BaseAPI

Defined in:

lib/mailtrap/sandbox_messages_api.rb

Instance Attribute Summary

• #account_id ⇒ Object readonly

  Returns the value of attribute account_id.

• #client ⇒ Object readonly

  Returns the value of attribute client.

• #inbox_id ⇒ Object readonly

  Returns the value of attribute inbox_id.

Instance Method Summary

• #delete(message_id) ⇒ SandboxMessage

  Deletes a sandbox message.

• #eml_body(message_id) ⇒ String

  Get message as EML.

• #forward_message(message_id, email:) ⇒ String

  Forward message to an email address.

• #get(message_id) ⇒ SandboxMessage

  Retrieves a specific sandbox message from inbox.

• #html_analysis(message_id) ⇒ Hash

  Get message HTML analysis.

• #html_body(message_id) ⇒ String

  Get formatted HTML email body.

• #html_source(message_id) ⇒ String

  Get message source.

• #initialize(account_id, inbox_id, client = Mailtrap::Client.new) ⇒ SandboxMessagesAPI constructor

  A new instance of SandboxMessagesAPI.

• #list(search: nil, last_id: nil, page: nil) ⇒ Array<SandboxMessage>

  Lists all sandbox messages for the account, limited up to 30 at once Overrides page if both are given.

• #mail_headers(message_id) ⇒ Hash

  Get mail headers.

• #mark_as_read(message_id, is_read: true) ⇒ SandboxMessage

  Updates an existing sandbox message.

• #raw_body(message_id) ⇒ String

  Get raw message.

• #spam_score(message_id) ⇒ Hash

  Get message spam score.

• #text_body(message_id) ⇒ String

  Get text message.

Methods included from BaseAPI

included

Constructor Details

#initialize(account_id, inbox_id, client = Mailtrap::Client.new) ⇒ SandboxMessagesAPI

Returns a new instance of SandboxMessagesAPI.

Parameters:

• account_id (Integer) —

  The account ID

• inbox_id (Integer) —

  The inbox ID

• client (Mailtrap::Client) (defaults to: Mailtrap::Client.new) —

  The client instance

Raises:

• (ArgumentError) —

  If account_id is nil

• (ArgumentError) —

  If inbox_id is nil

# File 'lib/mailtrap/sandbox_messages_api.rb', line 21

def initialize(account_id, inbox_id, client = Mailtrap::Client.new)
  raise ArgumentError, 'inbox_id is required' if inbox_id.nil?

  @inbox_id = inbox_id

  super(account_id, client)
end

Instance Attribute Details

#account_id ⇒ Object (readonly)

Returns the value of attribute account_id.

# File 'lib/mailtrap/sandbox_messages_api.rb', line 10

def account_id
  @account_id
end

#client ⇒ Object (readonly)

Returns the value of attribute client.

# File 'lib/mailtrap/sandbox_messages_api.rb', line 10

def client
  @client
end

#inbox_id ⇒ Object (readonly)

Returns the value of attribute inbox_id.

# File 'lib/mailtrap/sandbox_messages_api.rb', line 10

def inbox_id
  @inbox_id
end

Instance Method Details

#delete(message_id) ⇒ SandboxMessage

Deletes a sandbox message

Parameters:

• message_id (Integer) —

  The sandbox message ID

Returns:

• (SandboxMessage) —

  Deleted Sandbox message object

Raises:

• (Mailtrap::Error) —

  If the API request fails with a client or server error

• (Mailtrap::AuthorizationError) —

  If the API key is invalid

• (Mailtrap::RejectionError) —

  If the server refuses to process the request

• (Mailtrap::RateLimitError) —

  If too many requests are made

# File 'lib/mailtrap/sandbox_messages_api.rb', line 41

def delete(message_id)
  base_delete(message_id)
end

#eml_body(message_id) ⇒ String

Get message as EML

Parameters:

• message_id (Integer) —

  The sandbox message ID

Returns:

• (String) —

  mail message body in EML format.

Raises:

• (Mailtrap::Error) —

  If the API request fails with a client or server error

• (Mailtrap::AuthorizationError) —

  If the API key is invalid

• (Mailtrap::RejectionError) —

  If the server refuses to process the request

• (Mailtrap::RateLimitError) —

  If too many requests are made

# File 'lib/mailtrap/sandbox_messages_api.rb', line 133

def eml_body(message_id)
  client.get("#{base_path}/#{message_id}/body.eml")
end

#forward_message(message_id, email:) ⇒ String

Forward message to an email address.

Parameters:

• message_id (Integer) —

  The sandbox message ID

• email (String) —

  The email to forward sandbox message to

Returns:

• (String) —

  Forwarded message confirmation

Raises:

• (Mailtrap::Error) —

  If the API request fails with a client or server error

• (Mailtrap::AuthorizationError) —

  If the API key is invalid

• (Mailtrap::RejectionError) —

  If the server refuses to process the request

• (Mailtrap::RateLimitError) —

  If too many requests are made

# File 'lib/mailtrap/sandbox_messages_api.rb', line 77

def forward_message(message_id, email:)
  client.post("#{base_path}/#{message_id}/forward", { email: email })
end

#get(message_id) ⇒ SandboxMessage

Retrieves a specific sandbox message from inbox

Parameters:

• message_id (Integer) —

  The sandbox message ID

Returns:

• (SandboxMessage) —

  Sandbox message object

Raises:

• (Mailtrap::Error) —

  If the API request fails with a client or server error

• (Mailtrap::AuthorizationError) —

  If the API key is invalid

• (Mailtrap::RejectionError) —

  If the server refuses to process the request

• (Mailtrap::RateLimitError) —

  If too many requests are made

# File 'lib/mailtrap/sandbox_messages_api.rb', line 33

def get(message_id)
  base_get(message_id)
end

#html_analysis(message_id) ⇒ Hash

Get message HTML analysis

Parameters:

• message_id (Integer) —

  The sandbox message ID

Returns:

• (Hash) —

  brief HTML report

Raises:

• (Mailtrap::Error) —

  If the API request fails with a client or server error

• (Mailtrap::AuthorizationError) —

  If the API key is invalid

• (Mailtrap::RejectionError) —

  If the server refuses to process the request

• (Mailtrap::RateLimitError) —

  If too many requests are made

# File 'lib/mailtrap/sandbox_messages_api.rb', line 93

def html_analysis(message_id)
  client.get("#{base_path}/#{message_id}/analyze")
end

#html_body(message_id) ⇒ String

Get formatted HTML email body. Not applicable for plain text emails.

Parameters:

• message_id (Integer) —

  The sandbox message ID

Returns:

• (String) —

  message body in html format.

Raises:

• (Mailtrap::Error) —

  If the API request fails with a client or server error

• (Mailtrap::AuthorizationError) —

  If the API key is invalid

• (Mailtrap::RejectionError) —

  If the server refuses to process the request

• (Mailtrap::RateLimitError) —

  If too many requests are made

# File 'lib/mailtrap/sandbox_messages_api.rb', line 125

def html_body(message_id)
  client.get("#{base_path}/#{message_id}/body.html")
end

#html_source(message_id) ⇒ String

Get message source

Parameters:

• message_id (Integer) —

  The sandbox message ID

Returns:

• (String) —

  HTML source of a message.

Raises:

• (Mailtrap::Error) —

  If the API request fails with a client or server error

• (Mailtrap::AuthorizationError) —

  If the API key is invalid

• (Mailtrap::RejectionError) —

  If the server refuses to process the request

• (Mailtrap::RateLimitError) —

  If too many requests are made

# File 'lib/mailtrap/sandbox_messages_api.rb', line 117

def html_source(message_id)
  client.get("#{base_path}/#{message_id}/body.htmlsource")
end

#list(search: nil, last_id: nil, page: nil) ⇒ Array<SandboxMessage>

Lists all sandbox messages for the account, limited up to 30 at once Overrides page if both are given.

Parameters:

• search (String) (defaults to: nil) —

  Search query string. Matches subject, to_email, and to_name.

• last_id (Integer) (defaults to: nil) —

  If specified, a page of records before last_id is returned.

• page (Integer) (defaults to: nil) —

  Page number for paginated results.

Returns:

• (Array<SandboxMessage>) —

  Array of sandbox message objects

Raises:

• (Mailtrap::Error) —

  If the API request fails with a client or server error

• (Mailtrap::AuthorizationError) —

  If the API key is invalid

• (Mailtrap::RejectionError) —

  If the server refuses to process the request

• (Mailtrap::RateLimitError) —

  If too many requests are made

# File 'lib/mailtrap/sandbox_messages_api.rb', line 61

def list(search: nil, last_id: nil, page: nil)
  raise ArgumentError, 'Provide either last_id or page, not both' unless last_id.nil? || page.nil?

  query_params = {}
  query_params[:search] = search unless search.nil?
  query_params[:last_id] = last_id unless last_id.nil?
  query_params[:page] = page unless page.nil?

  base_list(query_params)
end

#mail_headers(message_id) ⇒ Hash

Get mail headers

Parameters:

• message_id (Integer) —

  The sandbox message ID

Returns:

• (Hash) —

  mail headers of the message.

Raises:

• (Mailtrap::Error) —

  If the API request fails with a client or server error

• (Mailtrap::AuthorizationError) —

  If the API key is invalid

• (Mailtrap::RejectionError) —

  If the server refuses to process the request

• (Mailtrap::RateLimitError) —

  If too many requests are made

# File 'lib/mailtrap/sandbox_messages_api.rb', line 141

def mail_headers(message_id)
  client.get("#{base_path}/#{message_id}/mail_headers")
end

#mark_as_read(message_id, is_read: true) ⇒ SandboxMessage

Updates an existing sandbox message

Parameters:

• message_id (Integer) —

  The sandbox message ID

• is_read (Boolean) (defaults to: true)

Returns:

• (SandboxMessage) —

  Updated Sandbox message object

Raises:

• (Mailtrap::Error) —

  If the API request fails with a client or server error

• (Mailtrap::AuthorizationError) —

  If the API key is invalid

• (Mailtrap::RejectionError) —

  If the server refuses to process the request

• (Mailtrap::RateLimitError) —

  If too many requests are made

# File 'lib/mailtrap/sandbox_messages_api.rb', line 50

def mark_as_read(message_id, is_read: true)
  base_update(message_id, { is_read: is_read })
end

#raw_body(message_id) ⇒ String

Get raw message

Parameters:

• message_id (Integer) —

  The sandbox message ID

Returns:

• (String) —

  raw email body

Raises:

• (Mailtrap::Error) —

  If the API request fails with a client or server error

• (Mailtrap::AuthorizationError) —

  If the API key is invalid

• (Mailtrap::RejectionError) —

  If the server refuses to process the request

• (Mailtrap::RateLimitError) —

  If too many requests are made

# File 'lib/mailtrap/sandbox_messages_api.rb', line 109

def raw_body(message_id)
  client.get("#{base_path}/#{message_id}/body.raw")
end

#spam_score(message_id) ⇒ Hash

Get message spam score

Parameters:

• message_id (Integer) —

  The sandbox message ID

Returns:

• (Hash) —

  Spam report

Raises:

• (Mailtrap::Error) —

  If the API request fails with a client or server error

• (Mailtrap::AuthorizationError) —

  If the API key is invalid

• (Mailtrap::RejectionError) —

  If the server refuses to process the request

• (Mailtrap::RateLimitError) —

  If too many requests are made

# File 'lib/mailtrap/sandbox_messages_api.rb', line 85

def spam_score(message_id)
  client.get("#{base_path}/#{message_id}/spam_report")
end

#text_body(message_id) ⇒ String

Get text message

Parameters:

• message_id (Integer) —

  The sandbox message ID

Returns:

• (String) —

  text email body

Raises:

• (Mailtrap::Error) —

  If the API request fails with a client or server error

• (Mailtrap::AuthorizationError) —

  If the API key is invalid

• (Mailtrap::RejectionError) —

  If the server refuses to process the request

• (Mailtrap::RateLimitError) —

  If too many requests are made

# File 'lib/mailtrap/sandbox_messages_api.rb', line 101

def text_body(message_id)
  client.get("#{base_path}/#{message_id}/body.txt")
end