Class: Mailtrap::ContactListsAPI

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

Instance Attribute Summary

Attributes included from BaseAPI

#account_id, #client

Instance Method Summary collapse

Methods included from BaseAPI

included, #initialize

Instance Method Details

#create(options) ⇒ ContactList

Creates a new contact list

Parameters:

  • options (Hash) —

    The parameters to create

Options Hash (options):

  • :name (String) —

    The contact list name

Returns:

Raises:



28
29
30
 
# File 'lib/mailtrap/contact_lists_api.rb', line 28

def create(options)
  base_create(options)
end

#delete(list_id) ⇒ Object

Deletes a contact list

Parameters:

  • list_id (Integer) —

    The contact list ID

Returns:

  • nil

Raises:



47
48
49
 
# File 'lib/mailtrap/contact_lists_api.rb', line 47

def delete(list_id)
  base_delete(list_id)
end

#get(list_id) ⇒ ContactList

Retrieves a specific contact list

Parameters:

  • list_id (Integer) —

    The contact list identifier

Returns:

Raises:



18
19
20
 
# File 'lib/mailtrap/contact_lists_api.rb', line 18

def get(list_id)
  base_get(list_id)
end

#list(search: nil) ⇒ Array<ContactList>

Lists all contact lists for the account

Parameters:

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

    Filters contact lists by name (case-insensitive prefix match)

Returns:

  • (Array<ContactList>) —

    Array of contact list objects

Raises:



55
56
57
58
59
60
 
# File 'lib/mailtrap/contact_lists_api.rb', line 55

def list(search: nil)
  query_params = {}
  query_params[:search] = search unless search.nil?

  base_list(query_params)
end

#update(list_id, options) ⇒ ContactList

Updates an existing contact list

Parameters:

  • list_id (Integer) —

    The contact list ID

  • options (Hash) —

    The parameters to update

Options Hash (options):

  • :name (String) —

    The contact list name

Returns:

Raises:



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

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