Class: Mailtrap::InboundInboxesAPI

Inherits:

Object

• Object
• Mailtrap::InboundInboxesAPI

Includes:

BaseAPI

Defined in:

lib/mailtrap/inbound_inboxes_api.rb

Constant Summary

CREATE_OPTIONS =

%i[name domain_id].freeze

UPDATE_OPTIONS =

%i[name].freeze

Instance Attribute Summary

Attributes included from BaseAPI

#account_id, #client

Instance Method Summary

• #create(folder_id, options) ⇒ InboundInbox

  Creates a new inbox in a folder.

• #delete(folder_id, inbox_id) ⇒ Object

  Deletes an inbox.

• #get(folder_id, inbox_id) ⇒ InboundInbox

  Retrieves a specific inbox.

• #initialize(client = Mailtrap::Client.new) ⇒ InboundInboxesAPI constructor

  A new instance of InboundInboxesAPI.

• #list(folder_id) ⇒ Array<InboundInbox>

  Lists all inboxes in a folder.

• #update(folder_id, inbox_id, options) ⇒ InboundInbox

  Updates an inbox.

Methods included from BaseAPI

included

Constructor Details

#initialize(client = Mailtrap::Client.new) ⇒ InboundInboxesAPI

Returns a new instance of InboundInboxesAPI.

Parameters:

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

  The client instance

# File 'lib/mailtrap/inbound_inboxes_api.rb', line 16

def initialize(client = Mailtrap::Client.new)
  @client = client
end

Instance Method Details

#create(folder_id, options) ⇒ InboundInbox

Creates a new inbox in a folder

Parameters:

• folder_id (Integer) —

  The folder ID

• options (Hash) —

  The parameters to create

Options Hash (options):

• :name (String) —

  The inbox name

• :domain_id (Integer) —

  Attach to a custom domain; omit for a Mailtrap-hosted inbox

Returns:

• (InboundInbox) —

  Created inbox

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

• (ArgumentError) —

  If invalid options are provided

# File 'lib/mailtrap/inbound_inboxes_api.rb', line 45

def create(folder_id, options)
  validate_options!(options, CREATE_OPTIONS)
  handle_response(client.post(inboxes_path(folder_id), options))
end

#delete(folder_id, inbox_id) ⇒ Object

Deletes an inbox

Parameters:

• folder_id (Integer) —

  The folder ID

• inbox_id (Integer) —

  The inbox ID

Returns:

• nil

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/inbound_inboxes_api.rb', line 68

def delete(folder_id, inbox_id)
  client.delete("#{inboxes_path(folder_id)}/#{inbox_id}")
end

#get(folder_id, inbox_id) ⇒ InboundInbox

Retrieves a specific inbox

Parameters:

• folder_id (Integer) —

  The folder ID

• inbox_id (Integer) —

  The inbox ID

Returns:

• (InboundInbox) —

  Inbox 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/inbound_inboxes_api.rb', line 33

def get(folder_id, inbox_id)
  handle_response(client.get("#{inboxes_path(folder_id)}/#{inbox_id}"))
end

#list(folder_id) ⇒ Array<InboundInbox>

Lists all inboxes in a folder

Parameters:

• folder_id (Integer) —

  The folder ID

Returns:

• (Array<InboundInbox>) —

  Array of inboxes

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/inbound_inboxes_api.rb', line 24

def list(folder_id)
  client.get(inboxes_path(folder_id)).map { |item| handle_response(item) }
end

#update(folder_id, inbox_id, options) ⇒ InboundInbox

Updates an inbox

Parameters:

• folder_id (Integer) —

  The folder ID

• inbox_id (Integer) —

  The inbox ID

• options (Hash) —

  The parameters to update

Options Hash (options):

• :name (String) —

  The inbox name

Returns:

• (InboundInbox) —

  Updated inbox

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

• (ArgumentError) —

  If invalid options are provided

# File 'lib/mailtrap/inbound_inboxes_api.rb', line 58

def update(folder_id, inbox_id, options)
  validate_options!(options, UPDATE_OPTIONS)
  handle_response(client.patch("#{inboxes_path(folder_id)}/#{inbox_id}", options))
end