Mandrill_Subaccounts

Mandrill_Subaccounts

• Class name: Mandrill_Subaccounts
• Namespace:

Methods

__construct

mixed Mandrill_Subaccounts::__construct(\Mandrill $master)

• Visibility: public

Arguments

• $master Mandrill

getList

array Mandrill_Subaccounts::getList(string $q)

Get the list of subaccounts defined for the account, optionally filtered by a prefix

• Visibility: public

Arguments

• $q string - <p>an optional prefix to filter the subaccounts' ids and names</p>

add

\struct Mandrill_Subaccounts::add(string $id, string $name, string $notes, integer $custom_quota)

Add a new subaccount

• Visibility: public

Arguments

• $id string - <p>a unique identifier for the subaccount to be used in sending calls</p>
• $name string - <p>an optional display name to further identify the subaccount</p>
• $notes string - <p>optional extra text to associate with the subaccount</p>
• $custom_quota integer - <p>an optional manual hourly quota for the subaccount. If not specified, Mandrill will manage this based on reputation</p>

info

\struct Mandrill_Subaccounts::info(string $id)

Given the ID of an existing subaccount, return the data about it

• Visibility: public

Arguments

• $id string - <p>the unique identifier of the subaccount to query</p>

update

\struct Mandrill_Subaccounts::update(string $id, string $name, string $notes, integer $custom_quota)

Update an existing subaccount

• Visibility: public

Arguments

• $id string - <p>the unique identifier of the subaccount to update</p>
• $name string - <p>an optional display name to further identify the subaccount</p>
• $notes string - <p>optional extra text to associate with the subaccount</p>
• $custom_quota integer - <p>an optional manual hourly quota for the subaccount. If not specified, Mandrill will manage this based on reputation</p>

delete

\struct Mandrill_Subaccounts::delete(string $id)

Delete an existing subaccount. Any email related to the subaccount will be saved, but stats will be removed and any future sending calls to this subaccount will fail.

• Visibility: public

Arguments

• $id string - <p>the unique identifier of the subaccount to delete</p>

pause

\struct Mandrill_Subaccounts::pause(string $id)

Pause a subaccount's sending. Any future emails delivered to this subaccount will be queued for a maximum of 3 days until the subaccount is resumed.

• Visibility: public

Arguments

• $id string - <p>the unique identifier of the subaccount to pause</p>

resume

\struct Mandrill_Subaccounts::resume(string $id)

Resume a paused subaccount's sending

• Visibility: public

Arguments

• $id string - <p>the unique identifier of the subaccount to resume</p>