Class: Mailtrap::InboundFoldersAPI

Inherits:
Object
  • Object
show all
Includes:
BaseAPI
Defined in:
lib/mailtrap/inbound_folders_api.rb

Instance Attribute Summary

Attributes included from BaseAPI

#account_id, #client

Instance Method Summary collapse

Methods included from BaseAPI

included

Constructor Details

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

Returns a new instance of InboundFoldersAPI.

Parameters:

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

    The client instance



14
15
16
 
# File 'lib/mailtrap/inbound_folders_api.rb', line 14

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

Instance Method Details

#create(options) ⇒ InboundFolder

Creates a new inbound folder

Parameters:

  • options (Hash) —

    The parameters to create

Options Hash (options):

  • :name (String) —

    The folder name

Returns:

Raises:



39
40
41
 
# File 'lib/mailtrap/inbound_folders_api.rb', line 39

def create(options)
  base_create(options)
end

#delete(folder_id) ⇒ Object

Deletes an inbound folder along with all of its inboxes

Parameters:

  • folder_id (Integer) —

    The folder ID

Returns:

  • nil

Raises:



58
59
60
 
# File 'lib/mailtrap/inbound_folders_api.rb', line 58

def delete(folder_id)
  base_delete(folder_id)
end

#get(folder_id) ⇒ InboundFolder

Retrieves a specific inbound folder

Parameters:

  • folder_id (Integer) —

    The folder ID

Returns:

Raises:



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

def get(folder_id)
  base_get(folder_id)
end

#list ⇒ Array<InboundFolder>

Lists all inbound folders in the account

Returns:

Raises:



21
22
23
 
# File 'lib/mailtrap/inbound_folders_api.rb', line 21

def list
  base_list
end

#update(folder_id, options) ⇒ InboundFolder

Updates an inbound folder

Parameters:

  • folder_id (Integer) —

    The folder ID

  • options (Hash) —

    The parameters to update

Options Hash (options):

  • :name (String) —

    The folder name

Returns:

Raises:



50
51
52
 
# File 'lib/mailtrap/inbound_folders_api.rb', line 50

def update(folder_id, options)
  base_update(folder_id, options)
end