Module: SendGrid4r::REST::InvalidEmails

Includes:
Request
Included in:
API
Defined in:
lib/sendgrid4r/rest/invalid_emails.rb

Overview

SendGrid Web API v3 InvalidEmails

Defined Under Namespace

Classes: InvalidEmail

Constant Summary

Constants included from Request

Request::BASE_URL

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Request

#create_args, #delete, #execute, #finish, #get, #patch, #post, #process_array_params, #process_url_params, #put

Class Method Details

.create_invalid_email(resp) ⇒ Object 



25
26
27
28
29
 
# File 'lib/sendgrid4r/rest/invalid_emails.rb', line 25

def self.create_invalid_email(resp)
  return resp if resp.nil?
  created = Time.at(resp['created']) unless resp['created'].nil?
  InvalidEmail.new(created, resp['email'], resp['reason'])
end

.create_invalid_emails(resp) ⇒ Object 



18
19
20
21
22
23
 
# File 'lib/sendgrid4r/rest/invalid_emails.rb', line 18

def self.create_invalid_emails(resp)
  return resp if resp.nil?
  resp.map do |invalid_email|
    InvalidEmails.create_invalid_email(invalid_email)
  end
end

.url(email = nil) ⇒ Object 



12
13
14
15
16
 
# File 'lib/sendgrid4r/rest/invalid_emails.rb', line 12

def self.url(email = nil)
  url = "#{BASE_URL}/suppression/invalid_emails"
  url = "#{url}/#{email}" unless email.nil?
  url
end

Instance Method Details

#delete_invalid_email(email:, &block) ⇒ Object 



57
58
59
 
# File 'lib/sendgrid4r/rest/invalid_emails.rb', line 57

def delete_invalid_email(email:, &block)
  delete(@auth, InvalidEmails.url(email), &block)
end

#delete_invalid_emails(delete_all: nil, emails: nil, &block) ⇒ Object 



43
44
45
46
47
48
49
50
 
# File 'lib/sendgrid4r/rest/invalid_emails.rb', line 43

def delete_invalid_emails(delete_all: nil, emails: nil, &block)
  if delete_all
    payload = { delete_all: delete_all }
  else
    payload = { emails: emails }
  end
  delete(@auth, InvalidEmails.url, nil, payload, &block)
end

#get_invalid_email(email:, &block) ⇒ Object 



52
53
54
55
 
# File 'lib/sendgrid4r/rest/invalid_emails.rb', line 52

def get_invalid_email(email:, &block)
  resp = get(@auth, InvalidEmails.url(email), &block)
  finish(resp, @raw_resp) { |r| InvalidEmails.create_invalid_emails(r) }
end

#get_invalid_emails(start_time: nil, end_time: nil, limit: nil, offset: nil, &block) ⇒ Object 



31
32
33
34
35
36
37
38
39
40
41
 
# File 'lib/sendgrid4r/rest/invalid_emails.rb', line 31

def get_invalid_emails(
  start_time: nil, end_time: nil, limit: nil, offset: nil, &block
)
  params = {}
  params[:start_time] = start_time.to_i unless start_time.nil?
  params[:end_time] = end_time.to_i unless end_time.nil?
  params[:limit] = limit.to_i unless limit.nil?
  params[:offset] = offset.to_i unless offset.nil?
  resp = get(@auth, InvalidEmails.url, params, &block)
  finish(resp, @raw_resp) { |r| InvalidEmails.create_invalid_emails(r) }
end