Class Mandrill_Ips

Located at Mandrill/Ips.php

Methods summary
`public`	# `__construct( Mandrill $master )`
`public array`	# `getList( )` Lists your dedicated IPs. Lists your dedicated IPs. Returns `array` an array of structs for each dedicated IP - return[] struct information about a single dedicated IP - ip string the ip address - created_at string the date and time that the dedicated IP was created as a UTC string in YYYY-MM-DD HH:MM:SS format - pool string the name of the pool that this dedicated IP belongs to - domain string the domain name (reverse dns) of this dedicated IP - custom_dns struct information about the ip's custom dns, if it has been configured - enabled boolean a boolean indicating whether custom dns has been configured for this ip - valid boolean whether the ip's custom dns is currently valid - error string if the ip's custom dns is invalid, this will include details about the error - warmup struct information about the ip's warmup status - warming_up boolean whether the ip is currently in warmup mode - start_at string the start time for the warmup process as a UTC string in YYYY-MM-DD HH:MM:SS format - end_at string the end date and time for the warmup process as a UTC string in YYYY-MM-DD HH:MM:SS format
`public struct`	# `info( string $ip )` Retrieves information about a single dedicated ip. Retrieves information about a single dedicated ip. Parameters `$ip` a dedicated IP address Returns `struct` Information about the dedicated ip - ip string the ip address - created_at string the date and time that the dedicated IP was created as a UTC string in YYYY-MM-DD HH:MM:SS format - pool string the name of the pool that this dedicated IP belongs to - domain string the domain name (reverse dns) of this dedicated IP - custom_dns struct information about the ip's custom dns, if it has been configured - enabled boolean a boolean indicating whether custom dns has been configured for this ip - valid boolean whether the ip's custom dns is currently valid - error string if the ip's custom dns is invalid, this will include details about the error - warmup struct information about the ip's warmup status - warming_up boolean whether the ip is currently in warmup mode - start_at string the start time for the warmup process as a UTC string in YYYY-MM-DD HH:MM:SS format - end_at string the end date and time for the warmup process as a UTC string in YYYY-MM-DD HH:MM:SS format
`public struct`	# `provision( boolean $warmup = false, string $pool = null )` 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. 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. Parameters `$warmup` whether to enable warmup mode for the ip `$pool` the id of the pool to add the dedicated ip to, or null to use your account's default pool Returns `struct` a description of the provisioning request that was created - requested_at string the date and time that the request was created as a UTC timestamp in YYYY-MM-DD HH:MM:SS format
`public struct`	# `startWarmup( string $ip )` 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. 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. Parameters `$ip` a dedicated ip address Returns `struct` Information about the dedicated IP - ip string the ip address - created_at string the date and time that the dedicated IP was created as a UTC string in YYYY-MM-DD HH:MM:SS format - pool string the name of the pool that this dedicated IP belongs to - domain string the domain name (reverse dns) of this dedicated IP - custom_dns struct information about the ip's custom dns, if it has been configured - enabled boolean a boolean indicating whether custom dns has been configured for this ip - valid boolean whether the ip's custom dns is currently valid - error string if the ip's custom dns is invalid, this will include details about the error - warmup struct information about the ip's warmup status - warming_up boolean whether the ip is currently in warmup mode - start_at string the start time for the warmup process as a UTC string in YYYY-MM-DD HH:MM:SS format - end_at string the end date and time for the warmup process as a UTC string in YYYY-MM-DD HH:MM:SS format
`public struct`	# `cancelWarmup( string $ip )` Cancels the warmup process for a dedicated IP. Cancels the warmup process for a dedicated IP. Parameters `$ip` a dedicated ip address Returns `struct` Information about the dedicated IP - ip string the ip address - created_at string the date and time that the dedicated IP was created as a UTC string in YYYY-MM-DD HH:MM:SS format - pool string the name of the pool that this dedicated IP belongs to - domain string the domain name (reverse dns) of this dedicated IP - custom_dns struct information about the ip's custom dns, if it has been configured - enabled boolean a boolean indicating whether custom dns has been configured for this ip - valid boolean whether the ip's custom dns is currently valid - error string if the ip's custom dns is invalid, this will include details about the error - warmup struct information about the ip's warmup status - warming_up boolean whether the ip is currently in warmup mode - start_at string the start time for the warmup process as a UTC string in YYYY-MM-DD HH:MM:SS format - end_at string the end date and time for the warmup process as a UTC string in YYYY-MM-DD HH:MM:SS format
`public struct`	# `setPool( string $ip, string $pool, boolean $create_pool = false )` Moves a dedicated IP to a different pool. Moves a dedicated IP to a different pool. Parameters `$ip` a dedicated ip address