Mandrill_Subaccounts
===============


* Class name: Mandrill_Subaccounts
* Namespace: 


Methods
-------


### __construct

    mixed Mandrill_Subaccounts::__construct(\Mandrill $master)


* Visibility: **public**


#### Arguments
* $master **[Mandrill](Mandrill.md)**


### 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** - &lt;p&gt;an optional prefix to filter the subaccounts&#039; ids and names&lt;/p&gt;


### add

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

Add a new subaccount


* Visibility: **public**


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


### info

    \struct Mandrill_Subaccounts::info(string $id)

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


* Visibility: **public**


#### Arguments
* $id **string** - &lt;p&gt;the unique identifier of the subaccount to query&lt;/p&gt;


### update

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

Update an existing subaccount


* Visibility: **public**


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


### 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** - &lt;p&gt;the unique identifier of the subaccount to delete&lt;/p&gt;


### 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** - &lt;p&gt;the unique identifier of the subaccount to pause&lt;/p&gt;


### resume

    \struct Mandrill_Subaccounts::resume(string $id)

Resume a paused subaccount's sending


* Visibility: **public**


#### Arguments
* $id **string** - &lt;p&gt;the unique identifier of the subaccount to resume&lt;/p&gt;