Documentation

Subaccounts
in package

Manage your subaccounts, including the abilitiy to pause and resume sending.

Table of Contents

Properties

$master  : mixed

Methods

__construct()  : mixed
add()  : struct
Add a new subaccount.
delete()  : struct
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.
getList()  : array<string|int, mixed>
Get the list of subaccounts defined for the account, optionally filtered by a prefix.
info()  : struct
Given the ID of an existing subaccount, return the data about it.
pause()  : struct
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.
resume()  : struct
Resume a paused subaccount's sending.
update()  : struct
Update an existing subaccount.

Properties

Methods

add()

Add a new subaccount.

public add(string $id[, string $name = null ][, string $notes = null ][, int $customQuota = null ]) : struct
Parameters
$id : string

a unique identifier for the subaccount to be used in sending calls

$name : string = null

an optional display name to further identify the subaccount

$notes : string = null

optional extra text to associate with the subaccount

$customQuota : int = null

an optional manual hourly quota for the subaccount. If not specified, Mandrill will manage this based on reputation

Return values
struct —

the information saved about the new subaccount

  • id string a unique indentifier for the subaccount
  • name string an optional display name for the subaccount
  • custom_quota integer an optional manual hourly quota for the subaccount. If not specified, the hourly quota will be managed based on reputation
  • status string the current sending status of the subaccount, one of "active" or "paused"
  • reputation integer the subaccount's current reputation on a scale from 0 to 100
  • created_at string the date and time that the subaccount was created as a UTC string in YYYY-MM-DD HH:MM:SS format
  • first_sent_at string the date and time that the subaccount first sent as a UTC string in YYYY-MM-DD HH:MM:SS format
  • sent_weekly integer the number of emails the subaccount has sent so far this week (weeks start on midnight Monday, UTC)
  • sent_monthly integer the number of emails the subaccount has sent so far this month (months start on midnight of the 1st, UTC)
  • sent_total integer the number of emails the subaccount has sent since it was created

delete()

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.

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

the unique identifier of the subaccount to delete

Return values
struct —

the information for the deleted subaccount

  • id string a unique indentifier for the subaccount
  • name string an optional display name for the subaccount
  • custom_quota integer an optional manual hourly quota for the subaccount. If not specified, the hourly quota will be managed based on reputation
  • status string the current sending status of the subaccount, one of "active" or "paused"
  • reputation integer the subaccount's current reputation on a scale from 0 to 100
  • created_at string the date and time that the subaccount was created as a UTC string in YYYY-MM-DD HH:MM:SS format
  • first_sent_at string the date and time that the subaccount first sent as a UTC string in YYYY-MM-DD HH:MM:SS format
  • sent_weekly integer the number of emails the subaccount has sent so far this week (weeks start on midnight Monday, UTC)
  • sent_monthly integer the number of emails the subaccount has sent so far this month (months start on midnight of the 1st, UTC)
  • sent_total integer the number of emails the subaccount has sent since it was created

getList()

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

public getList([string $q = null ]) : array<string|int, mixed>
Parameters
$q : string = null

an optional prefix to filter the subaccounts' ids and names

Return values
array<string|int, mixed> —

the subaccounts for the account, up to a maximum of 1,000

  • return[] struct the individual subaccount info
  • id string a unique indentifier for the subaccount
  • name string an optional display name for the subaccount
  • custom_quota integer an optional manual hourly quota for the subaccount. If not specified, the hourly quota will be managed based on reputation
  • status string the current sending status of the subaccount, one of "active" or "paused"
  • reputation integer the subaccount's current reputation on a scale from 0 to 100
  • created_at string the date and time that the subaccount was created as a UTC string in YYYY-MM-DD HH:MM:SS format
  • first_sent_at string the date and time that the subaccount first sent as a UTC string in YYYY-MM-DD HH:MM:SS format
  • sent_weekly integer the number of emails the subaccount has sent so far this week (weeks start on midnight Monday, UTC)
  • sent_monthly integer the number of emails the subaccount has sent so far this month (months start on midnight of the 1st, UTC)
  • sent_total integer the number of emails the subaccount has sent since it was created

info()

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

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

the unique identifier of the subaccount to query

Return values
struct —

the information about the subaccount

  • id string a unique indentifier for the subaccount
  • name string an optional display name for the subaccount
  • notes string optional extra text to associate with the subaccount
  • custom_quota integer an optional manual hourly quota for the subaccount. If not specified, the hourly quota will be managed based on reputation
  • status string the current sending status of the subaccount, one of "active" or "paused"
  • reputation integer the subaccount's current reputation on a scale from 0 to 100
  • created_at string the date and time that the subaccount was created as a UTC string in YYYY-MM-DD HH:MM:SS format
  • first_sent_at string the date and time that the subaccount first sent as a UTC string in YYYY-MM-DD HH:MM:SS format
  • sent_weekly integer the number of emails the subaccount has sent so far this week (weeks start on midnight Monday, UTC)
  • sent_monthly integer the number of emails the subaccount has sent so far this month (months start on midnight of the 1st, UTC)
  • sent_total integer the number of emails the subaccount has sent since it was created
  • sent_hourly integer the number of emails the subaccount has sent in the last hour
  • hourly_quota integer the current hourly quota for the subaccount, either manual or reputation-based
  • last_30_days struct stats for this subaccount in the last 30 days
  • sent integer the number of emails sent for this subaccount in the last 30 days
  • hard_bounces integer the number of emails hard bounced for this subaccount in the last 30 days
  • soft_bounces integer the number of emails soft bounced for this subaccount in the last 30 days
  • rejects integer the number of emails rejected for sending this subaccount in the last 30 days
  • complaints integer the number of spam complaints for this subaccount in the last 30 days
  • unsubs integer the number of unsbuscribes for this subaccount in the last 30 days
  • opens integer the number of times emails have been opened for this subaccount in the last 30 days
  • unique_opens integer the number of unique opens for emails sent for this subaccount in the last 30 days
  • clicks integer the number of URLs that have been clicked for this subaccount in the last 30 days
  • unique_clicks integer the number of unique clicks for emails sent for this subaccount in the last 30 days

pause()

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.

public pause(string $id) : struct
Parameters
$id : string

the unique identifier of the subaccount to pause

Return values
struct —

the information for the paused subaccount

  • id string a unique indentifier for the subaccount
  • name string an optional display name for the subaccount
  • custom_quota integer an optional manual hourly quota for the subaccount. If not specified, the hourly quota will be managed based on reputation
  • status string the current sending status of the subaccount, one of "active" or "paused"
  • reputation integer the subaccount's current reputation on a scale from 0 to 100
  • created_at string the date and time that the subaccount was created as a UTC string in YYYY-MM-DD HH:MM:SS format
  • first_sent_at string the date and time that the subaccount first sent as a UTC string in YYYY-MM-DD HH:MM:SS format
  • sent_weekly integer the number of emails the subaccount has sent so far this week (weeks start on midnight Monday, UTC)
  • sent_monthly integer the number of emails the subaccount has sent so far this month (months start on midnight of the 1st, UTC)
  • sent_total integer the number of emails the subaccount has sent since it was created

resume()

Resume a paused subaccount's sending.

public resume(string $id) : struct
Parameters
$id : string

the unique identifier of the subaccount to resume

Return values
struct —

the information for the resumed subaccount

  • id string a unique indentifier for the subaccount
  • name string an optional display name for the subaccount
  • custom_quota integer an optional manual hourly quota for the subaccount. If not specified, the hourly quota will be managed based on reputation
  • status string the current sending status of the subaccount, one of "active" or "paused"
  • reputation integer the subaccount's current reputation on a scale from 0 to 100
  • created_at string the date and time that the subaccount was created as a UTC string in YYYY-MM-DD HH:MM:SS format
  • first_sent_at string the date and time that the subaccount first sent as a UTC string in YYYY-MM-DD HH:MM:SS format
  • sent_weekly integer the number of emails the subaccount has sent so far this week (weeks start on midnight Monday, UTC)
  • sent_monthly integer the number of emails the subaccount has sent so far this month (months start on midnight of the 1st, UTC)
  • sent_total integer the number of emails the subaccount has sent since it was created

update()

Update an existing subaccount.

public update(string $id[, string $name = null ][, string $notes = null ][, int $customQuota = null ]) : struct
Parameters
$id : string

the unique identifier of the subaccount to update

$name : string = null

an optional display name to further identify the subaccount

$notes : string = null

optional extra text to associate with the subaccount

$customQuota : int = null

an optional manual hourly quota for the subaccount. If not specified, Mandrill will manage this based on reputation

Return values
struct —

the information for the updated subaccount

  • id string a unique indentifier for the subaccount
  • name string an optional display name for the subaccount
  • custom_quota integer an optional manual hourly quota for the subaccount. If not specified, the hourly quota will be managed based on reputation
  • status string the current sending status of the subaccount, one of "active" or "paused"
  • reputation integer the subaccount's current reputation on a scale from 0 to 100
  • created_at string the date and time that the subaccount was created as a UTC string in YYYY-MM-DD HH:MM:SS format
  • first_sent_at string the date and time that the subaccount first sent as a UTC string in YYYY-MM-DD HH:MM:SS format
  • sent_weekly integer the number of emails the subaccount has sent so far this week (weeks start on midnight Monday, UTC)
  • sent_monthly integer the number of emails the subaccount has sent so far this month (months start on midnight of the 1st, UTC)
  • sent_total integer the number of emails the subaccount has sent since it was created

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results