Class: Mandrill::Ips
- Inherits:
-
Object
- Object
- Mandrill::Ips
- Defined in:
- lib/mandrill/api.rb
Instance Attribute Summary collapse
-
#master ⇒ Object
Returns the value of attribute master.
Instance Method Summary collapse
-
#cancel_warmup(ip) ⇒ Hash
Cancels the warmup process for a dedicated IP.
-
#check_custom_dns(ip, domain) ⇒ Hash
Tests whether a domain name is valid for use as the custom reverse DNS for a dedicated IP.
-
#create_pool(pool) ⇒ Hash
Creates a pool and returns it.
-
#delete(ip) ⇒ Hash
Deletes a dedicated IP.
-
#delete_pool(pool) ⇒ Hash
Deletes a pool.
-
#info(ip) ⇒ Hash
Retrieves information about a single dedicated ip.
-
#initialize(master) ⇒ Ips
constructor
A new instance of Ips.
-
#list ⇒ Array
Lists your dedicated IPs.
-
#list_pools ⇒ Array
Lists your dedicated IP pools.
-
#pool_info(pool) ⇒ Hash
Describes a single dedicated IP pool.
-
#provision(warmup = false, pool = nil) ⇒ Hash
Requests an additional dedicated IP for your account.
-
#set_custom_dns(ip, domain) ⇒ Hash
Configures the custom DNS name for a dedicated IP.
-
#set_pool(ip, pool, create_pool = false) ⇒ Hash
Moves a dedicated IP to a different pool.
-
#start_warmup(ip) ⇒ Hash
Begins the warmup process for a dedicated IP.
Constructor Details
#initialize(master) ⇒ Ips
Returns a new instance of Ips.
1194 1195 1196 |
# File 'lib/mandrill/api.rb', line 1194 def initialize(master) @master = master end |
Instance Attribute Details
#master ⇒ Object
Returns the value of attribute master.
1192 1193 1194 |
# File 'lib/mandrill/api.rb', line 1192 def master @master end |
Instance Method Details
#cancel_warmup(ip) ⇒ Hash
Cancels the warmup process for a dedicated IP.
1283 1284 1285 1286 |
# File 'lib/mandrill/api.rb', line 1283 def cancel_warmup(ip) _params = {:ip => ip} return @master.call 'ips/cancel-warmup', _params end |
#check_custom_dns(ip, domain) ⇒ Hash
Tests whether a domain name is valid for use as the custom reverse DNS for a dedicated IP.
1408 1409 1410 1411 |
# File 'lib/mandrill/api.rb', line 1408 def check_custom_dns(ip, domain) _params = {:ip => ip, :domain => domain} return @master.call 'ips/check-custom-dns', _params end |
#create_pool(pool) ⇒ Hash
Creates a pool and returns it. If a pool already exists with this name, no action will be performed.
1387 1388 1389 1390 |
# File 'lib/mandrill/api.rb', line 1387 def create_pool(pool) _params = {:pool => pool} return @master.call 'ips/create-pool', _params end |
#delete(ip) ⇒ Hash
Deletes a dedicated IP. This is permanent and cannot be undone.
1315 1316 1317 1318 |
# File 'lib/mandrill/api.rb', line 1315 def delete(ip) _params = {:ip => ip} return @master.call 'ips/delete', _params end |
#delete_pool(pool) ⇒ Hash
Deletes a pool. A pool must be empty before you can delete it, and you cannot delete your default pool.
1397 1398 1399 1400 |
# File 'lib/mandrill/api.rb', line 1397 def delete_pool(pool) _params = {:pool => pool} return @master.call 'ips/delete-pool', _params end |
#info(ip) ⇒ Hash
Retrieves information about a single dedicated ip.
1233 1234 1235 1236 |
# File 'lib/mandrill/api.rb', line 1233 def info(ip) _params = {:ip => ip} return @master.call 'ips/info', _params end |
#list ⇒ Array
Lists your dedicated IPs.
1213 1214 1215 1216 |
# File 'lib/mandrill/api.rb', line 1213 def list() _params = {} return @master.call 'ips/list', _params end |
#list_pools ⇒ Array
Lists your dedicated IP pools.
1339 1340 1341 1342 |
# File 'lib/mandrill/api.rb', line 1339 def list_pools() _params = {} return @master.call 'ips/list-pools', _params end |
#pool_info(pool) ⇒ Hash
Describes a single dedicated IP pool.
1363 1364 1365 1366 |
# File 'lib/mandrill/api.rb', line 1363 def pool_info(pool) _params = {:pool => pool} return @master.call 'ips/pool-info', _params end |
#provision(warmup = false, pool = nil) ⇒ Hash
Requests an additional dedicated IP for your account. Accounts may have one outstanding request at any time, and provisioning requests are processed within 24 hours.
1243 1244 1245 1246 |
# File 'lib/mandrill/api.rb', line 1243 def provision(warmup=false, pool=nil) _params = {:warmup => warmup, :pool => pool} return @master.call 'ips/provision', _params end |
#set_custom_dns(ip, domain) ⇒ Hash
Configures the custom DNS name for a dedicated IP.
1429 1430 1431 1432 |
# File 'lib/mandrill/api.rb', line 1429 def set_custom_dns(ip, domain) _params = {:ip => ip, :domain => domain} return @master.call 'ips/set-custom-dns', _params end |
#set_pool(ip, pool, create_pool = false) ⇒ Hash
Moves a dedicated IP to a different pool.
1305 1306 1307 1308 |
# File 'lib/mandrill/api.rb', line 1305 def set_pool(ip, pool, create_pool=false) _params = {:ip => ip, :pool => pool, :create_pool => create_pool} return @master.call 'ips/set-pool', _params end |
#start_warmup(ip) ⇒ Hash
Begins the warmup process for a dedicated IP. During the warmup process, Mandrill will gradually increase the percentage of your mail that is sent over the warming-up IP, over a period of roughly 30 days. The rest of your mail will be sent over shared IPs or other dedicated IPs in the same pool.
1263 1264 1265 1266 |
# File 'lib/mandrill/api.rb', line 1263 def start_warmup(ip) _params = {:ip => ip} return @master.call 'ips/start-warmup', _params end |