Class: Mailtrap::SuppressionsAPI

Inherits:

Object

• Object
• Mailtrap::SuppressionsAPI

Includes:

BaseAPI

Defined in:

lib/mailtrap/suppressions_api.rb

Instance Attribute Summary

Attributes included from BaseAPI

#account_id, #client

Instance Method Summary

• #delete(suppression_id) ⇒ Object

  Deletes a suppression.

• #list(email: nil) ⇒ Array<Suppression>

  Lists all suppressions for the account.

Methods included from BaseAPI

included, #initialize

Instance Method Details

#delete(suppression_id) ⇒ Object

Deletes a suppression

Parameters:

• suppression_id (String) —

  The suppression UUID

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/suppressions_api.rb', line 27

def delete(suppression_id)
  client.delete("#{base_path}/#{suppression_id}")
end

#list(email: nil) ⇒ Array<Suppression>

Lists all suppressions for the account

Parameters:

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

  Email address to filter suppressions (optional)

Returns:

• (Array<Suppression>) —

  Array of suppression 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/suppressions_api.rb', line 16

def list(email: nil)
  query_params = {}
  query_params[:email] = email if email

  base_list(query_params)
end