Class: SendGridWebApi::Modules::AddressWhitelist

Inherits:
Client
  • Object
show all
Defined in:
lib/web_api/address_whitelist.rb

Constant Summary collapse

ADDRESS_WHITELIST_URL = 
"mail_settings/address_whitelist"

Instance Attribute Summary

Attributes inherited from Base

#api_key

Instance Method Summary collapse

Methods included from SendGridWebApi::Modules

#address_whitelist, #apikey, #blocks, #bounces, #event_notification, #invalid_emails, #mail, #parse_email, #profile, #spam, #stats, #sub_user, #unsubscribes

Methods inherited from Base

#builder_options, #initialize, #make_request_url, #query_api, #query_delete_api, #query_patch_api, #query_post_api, #query_post_json_api, #session, #to_query

Constructor Details

This class inherits a constructor from SendGridWebApi::Base

Instance Method Details

#add(options = {}) ⇒ Object

Add an email address to the whitelist.



15
16
17
 
# File 'lib/web_api/address_whitelist.rb', line 15

def add options = {}
  query_patch_api(ADDRESS_WHITELIST_URL, process_header_options(options))
end

#base_url ⇒ Object 



5
6
7
 
# File 'lib/web_api/address_whitelist.rb', line 5

def base_url
  "https://api.sendgrid.com/v3/"
end

#delete(options = {}) ⇒ Object

Delete an email address from the whitelist.



20
21
22
 
# File 'lib/web_api/address_whitelist.rb', line 20

def delete options = {}
  query_patch_api(ADDRESS_WHITELIST_URL, process_header_options(options))
end

#get(options = {}) ⇒ Object

Retrieve a list of all email addresses whitelist.



10
11
12
 
# File 'lib/web_api/address_whitelist.rb', line 10

def get options = {}
  query_api(ADDRESS_WHITELIST_URL, process_header_options(options))
end