Skip to content

Mandrill_Ips

Jump to bottom
Mathieu Nayrolles edited this page Jan 20, 2016 · 1 revision

Mandrill_Ips

  • Class name: Mandrill_Ips
  • Namespace:

Methods

__construct

mixed Mandrill_Ips::__construct(\Mandrill $master)
  • Visibility: public

Arguments

getList

array Mandrill_Ips::getList()

Lists your dedicated IPs.

  • Visibility: public

info

\struct Mandrill_Ips::info(string $ip)

Retrieves information about a single dedicated ip.

  • Visibility: public

Arguments

  • $ip string - <p>a dedicated IP address</p>

provision

\struct Mandrill_Ips::provision(boolean $warmup, string $pool)

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.

  • Visibility: public

Arguments

  • $warmup boolean - <p>whether to enable warmup mode for the ip</p>
  • $pool string - <p>the id of the pool to add the dedicated ip to, or null to use your account's default pool</p>

startWarmup

\struct Mandrill_Ips::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.

  • Visibility: public

Arguments

  • $ip string - <p>a dedicated ip address</p>

cancelWarmup

\struct Mandrill_Ips::cancelWarmup(string $ip)

Cancels the warmup process for a dedicated IP.

  • Visibility: public

Arguments

  • $ip string - <p>a dedicated ip address</p>

setPool

\struct Mandrill_Ips::setPool(string $ip, string $pool, boolean $create_pool)

Moves a dedicated IP to a different pool.

  • Visibility: public

Arguments

  • $ip string - <p>a dedicated ip address</p>
  • $pool string - <p>the name of the new pool to add the dedicated ip to</p>
  • $create_pool boolean - <p>whether to create the pool if it does not exist; if false and the pool does not exist, an Unknown_Pool will be thrown.</p>

delete

\struct Mandrill_Ips::delete(string $ip)

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

  • Visibility: public

Arguments

  • $ip string - <p>the dedicated ip to remove from your account</p>

listPools

array Mandrill_Ips::listPools()

Lists your dedicated IP pools.

  • Visibility: public

poolInfo

\struct Mandrill_Ips::poolInfo(string $pool)

Describes a single dedicated IP pool.

  • Visibility: public

Arguments

  • $pool string - <p>a pool name</p>

createPool

\struct Mandrill_Ips::createPool(string $pool)

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

  • Visibility: public

Arguments

  • $pool string - <p>the name of a pool to create</p>

deletePool

\struct Mandrill_Ips::deletePool(string $pool)

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

  • Visibility: public

Arguments

  • $pool string - <p>the name of the pool to delete</p>

checkCustomDns

\struct Mandrill_Ips::checkCustomDns(string $ip, string $domain)

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

  • Visibility: public

Arguments

  • $ip string - <p>a dedicated ip address</p>
  • $domain string - <p>the domain name to test</p>

setCustomDns

\struct Mandrill_Ips::setCustomDns(string $ip, string $domain)

Configures the custom DNS name for a dedicated IP.

  • Visibility: public

Arguments

  • $ip string - <p>a dedicated ip address</p>
  • $domain string - <p>a domain name to set as the dedicated IP's custom dns name.</p>
Clone this wiki locally