Skip to content

Commit c14a52b

Browse files
author
Dustin Shields-Cloues
committed
Add API calls for managing custom DNS records for dedicated IPs
1 parent 0bfdf56 commit c14a52b

2 files changed

Lines changed: 33 additions & 1 deletion

File tree

lib/mandrill/api.rb

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1282,6 +1282,38 @@ def delete_pool(pool)
12821282
return @master.call 'ips/delete-pool', _params
12831283
end
12841284

1285+
# Tests whether a domain name is valid for use as the custom reverse DNS for a dedicated IP.
1286+
# @param [String] ip a dedicated ip address
1287+
# @param [String] domain the domain name to test
1288+
# @return [Hash] validation results for the domain
1289+
# - [String] valid whether the domain name has a correctly-configured A record pointing to the ip address
1290+
# - [String] error if valid is false, this will contain details about why the domain's A record is incorrect
1291+
def check_custom_dns(ip, domain)
1292+
_params = {:ip => ip, :domain => domain}
1293+
return @master.call 'ips/check-custom-dns', _params
1294+
end
1295+
1296+
# Configures the custom DNS name for a dedicated IP.
1297+
# @param [String] ip a dedicated ip address
1298+
# @param [String] domain a domain name to set as the dedicated IP's custom dns name.
1299+
# @return [Hash] information about the dedicated IP's new configuration
1300+
# - [String] ip the ip address
1301+
# - [String] created_at the date and time that the dedicated IP was created as a UTC string in YYYY-MM-DD HH:MM:SS format
1302+
# - [String] pool the name of the pool that this dedicated IP belongs to
1303+
# - [String] domain the domain name (reverse dns) of this dedicated IP
1304+
# - [Hash] custom_dns information about the ip's custom dns, if it has been configured
1305+
# - [Boolean] enabled a boolean indicating whether custom dns has been configured for this ip
1306+
# - [Boolean] valid whether the ip's custom dns is currently valid
1307+
# - [String] error if the ip's custom dns is invalid, this will include details about the error
1308+
# - [Hash] warmup information about the ip's warmup status
1309+
# - [Boolean] warming_up whether the ip is currently in warmup mode
1310+
# - [String] start_at the start time for the warmup process as a UTC string in YYYY-MM-DD HH:MM:SS format
1311+
# - [String] end_at the end date and time for the warmup process as a UTC string in YYYY-MM-DD HH:MM:SS format
1312+
def set_custom_dns(ip, domain)
1313+
_params = {:ip => ip, :domain => domain}
1314+
return @master.call 'ips/set-custom-dns', _params
1315+
end
1316+
12851317
end
12861318
class Internal
12871319
attr_accessor :master

mandrill-api.gemspec

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
Gem::Specification.new do |s|
22
s.name = 'mandrill-api'
3-
s.version = '1.0.46'
3+
s.version = '1.0.47'
44
s.summary = 'A Ruby API library for the Mandrill email as a service platform.'
55
s.description = s.summary
66
s.authors = ['Mandrill Devs']

0 commit comments

Comments
 (0)