Documentation

Ips
in package

Request and manage Dedicated IPs for your account, and set up reverse DNS.

Table of Contents

Properties

$master  : mixed

Methods

__construct()  : mixed
cancelWarmup()  : struct
Cancels the warmup process for a dedicated IP.
checkCustomDns()  : struct
Tests whether a domain name is valid for use as the custom reverse DNS for a dedicated IP.
createPool()  : struct
Creates a pool and returns it. If a pool already exists with this name, no action will be performed.
delete()  : struct
Deletes a dedicated IP. This is permanent and cannot be undone.
deletePool()  : struct
Deletes a pool. A pool must be empty before you can delete it, and you cannot delete your default pool.
getList()  : array<string|int, mixed>
Lists your dedicated IPs.
info()  : struct
Retrieves information about a single dedicated ip.
listPools()  : array<string|int, mixed>
Lists your dedicated IP pools.
poolInfo()  : struct
Describes a single dedicated IP pool.
provision()  : struct
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.
setCustomDns()  : struct
Configures the custom DNS name for a dedicated IP.
setPool()  : struct
Moves a dedicated IP to a different pool.
startWarmup()  : struct
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.

Properties

$master

public mixed $master

Methods

__construct()

public __construct(Client $master) : mixed
Parameters
$master : Client

cancelWarmup()

Cancels the warmup process for a dedicated IP.

public cancelWarmup(string $ip) : struct
Parameters
$ip : string

a dedicated ip address

Return values
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

checkCustomDns()

Tests whether a domain name is valid for use as the custom reverse DNS for a dedicated IP.

public checkCustomDns(string $ip, string $domain) : struct
Parameters
$ip : string

a dedicated ip address

$domain : string

the domain name to test

Return values
struct —

validation results for the domain

  • valid string whether the domain name has a correctly-configured A record pointing to the ip address
  • error string if valid is false, this will contain details about why the domain's A record is incorrect

createPool()

Creates a pool and returns it. If a pool already exists with this name, no action will be performed.

public createPool(string $pool) : struct
Parameters
$pool : string

the name of a pool to create

Return values
struct —

Information about the dedicated ip pool

  • name string this pool's name
  • created_at string the date and time that this pool was created as a UTC timestamp in YYYY-MM-DD HH:MM:SS format
  • ips array the dedicated IPs in this pool
  • ips[] struct information about each 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

delete()

Deletes a dedicated IP. This is permanent and cannot be undone.

public delete(string $ip) : struct
Parameters
$ip : string

the dedicated ip to remove from your account

Return values
struct —

a description of the ip that was removed from your account.

  • ip string the ip address
  • deleted string a boolean indicating whether the ip was successfully deleted

deletePool()

Deletes a pool. A pool must be empty before you can delete it, and you cannot delete your default pool.

public deletePool(string $pool) : struct
Parameters
$pool : string

the name of the pool to delete

Return values
struct —

information about the status of the pool that was deleted

  • pool string the name of the pool
  • deleted boolean whether the pool was deleted

getList()

Lists your dedicated IPs.

public getList() : array<string|int, mixed>
Return values
array<string|int, mixed> —

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

info()

Retrieves information about a single dedicated ip.

public info(string $ip) : struct
Parameters
$ip : string

a dedicated IP address

Return values
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

listPools()

Lists your dedicated IP pools.

public listPools() : array<string|int, mixed>
Return values
array<string|int, mixed> —

the dedicated IP pools for your account, up to a maximum of 1,000

  • return[] struct information about each dedicated IP pool
  • name string this pool's name
  • created_at string the date and time that this pool was created as a UTC timestamp in YYYY-MM-DD HH:MM:SS format
  • ips array the dedicated IPs in this pool
  • ips[] struct information about each 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

poolInfo()

Describes a single dedicated IP pool.

public poolInfo(string $pool) : struct
Parameters
$pool : string

a pool name

Return values
struct —

Information about the dedicated ip pool

  • name string this pool's name
  • created_at string the date and time that this pool was created as a UTC timestamp in YYYY-MM-DD HH:MM:SS format
  • ips array the dedicated IPs in this pool
  • ips[] struct information about each 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

provision()

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.

public provision([bool $warmup = false ][, string $pool = null ]) : struct
Parameters
$warmup : bool = false

whether to enable warmup mode for the ip

$pool : string = null

the id of the pool to add the dedicated ip to, or null to use your account's default pool

Return values
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

setCustomDns()

Configures the custom DNS name for a dedicated IP.

public setCustomDns(string $ip, string $domain) : struct
Parameters
$ip : string

a dedicated ip address

$domain : string

a domain name to set as the dedicated IP's custom dns name

Return values
struct —

information about the dedicated IP's new configuration

  • 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

setPool()

Moves a dedicated IP to a different pool.

public setPool(string $ip, string $pool[, bool $createPool = false ]) : struct
Parameters
$ip : string

a dedicated ip address

$pool : string

the name of the new pool to add the dedicated ip to

$createPool : bool = false

whether to create the pool if it does not exist; if false and the pool does not exist, an Unknown_Pool will be thrown

Return values
struct —

Information about the updated state of 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

startWarmup()

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.

public startWarmup(string $ip) : struct
Parameters
$ip : string

a dedicated ip address

Return values
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

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results