Mandrill_Templates
===============


* Class name: Mandrill_Templates
* Namespace: 


Methods
-------


### __construct

    mixed Mandrill_Templates::__construct(\Mandrill $master)


* Visibility: **public**


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


### add

    \struct Mandrill_Templates::add(string $name, string $from_email, string $from_name, string $subject, string $code, string $text, boolean $publish, array $labels)

Add a new template


* Visibility: **public**


#### Arguments
* $name **string** - &lt;p&gt;the name for the new template - must be unique&lt;/p&gt;
* $from_email **string** - &lt;p&gt;a default sending address for emails sent using this template&lt;/p&gt;
* $from_name **string** - &lt;p&gt;a default from name to be used&lt;/p&gt;
* $subject **string** - &lt;p&gt;a default subject line to be used&lt;/p&gt;
* $code **string** - &lt;p&gt;the HTML code for the template with mc:edit attributes for the editable elements&lt;/p&gt;
* $text **string** - &lt;p&gt;a default text part to be used when sending with this template&lt;/p&gt;
* $publish **boolean** - &lt;p&gt;set to false to add a draft template without publishing&lt;/p&gt;
* $labels **array** - &lt;p&gt;an optional array of up to 10 labels to use for filtering templates&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;labels[] string a single label&lt;/li&gt;
&lt;/ul&gt;


### info

    \struct Mandrill_Templates::info(string $name)

Get the information for an existing template


* Visibility: **public**


#### Arguments
* $name **string** - &lt;p&gt;the immutable name of an existing template&lt;/p&gt;


### update

    \struct Mandrill_Templates::update(string $name, string $from_email, string $from_name, string $subject, string $code, string $text, boolean $publish, array $labels)

Update the code for an existing template. If null is provided for any fields, the values will remain unchanged.


* Visibility: **public**


#### Arguments
* $name **string** - &lt;p&gt;the immutable name of an existing template&lt;/p&gt;
* $from_email **string** - &lt;p&gt;the new default sending address&lt;/p&gt;
* $from_name **string** - &lt;p&gt;the new default from name&lt;/p&gt;
* $subject **string** - &lt;p&gt;the new default subject line&lt;/p&gt;
* $code **string** - &lt;p&gt;the new code for the template&lt;/p&gt;
* $text **string** - &lt;p&gt;the new default text part to be used&lt;/p&gt;
* $publish **boolean** - &lt;p&gt;set to false to update the draft version of the template without publishing&lt;/p&gt;
* $labels **array** - &lt;p&gt;an optional array of up to 10 labels to use for filtering templates&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;labels[] string a single label&lt;/li&gt;
&lt;/ul&gt;


### publish

    \struct Mandrill_Templates::publish(string $name)

Publish the content for the template. Any new messages sent using this template will start using the content that was previously in draft.


* Visibility: **public**


#### Arguments
* $name **string** - &lt;p&gt;the immutable name of an existing template&lt;/p&gt;


### delete

    \struct Mandrill_Templates::delete(string $name)

Delete a template


* Visibility: **public**


#### Arguments
* $name **string** - &lt;p&gt;the immutable name of an existing template&lt;/p&gt;


### getList

    array Mandrill_Templates::getList(string $label)

Return a list of all the templates available to this user


* Visibility: **public**


#### Arguments
* $label **string** - &lt;p&gt;an optional label to filter the templates&lt;/p&gt;


### timeSeries

    array Mandrill_Templates::timeSeries(string $name)

Return the recent history (hourly stats for the last 30 days) for a template


* Visibility: **public**


#### Arguments
* $name **string** - &lt;p&gt;the name of an existing template&lt;/p&gt;


### render

    \struct Mandrill_Templates::render(string $template_name, array $template_content, array $merge_vars)

Inject content and optionally merge fields into a template, returning the HTML that results


* Visibility: **public**


#### Arguments
* $template_name **string** - &lt;p&gt;the immutable name of a template that exists in the user&#039;s account&lt;/p&gt;
* $template_content **array** - &lt;p&gt;an array of template content to render.  Each item in the array should be a struct with two keys - name: the name of the content block to set the content for, and content: the actual content to put into the block&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;template_content[] struct the injection of a single piece of content into a single editable region
&lt;ul&gt;
&lt;li&gt;name string the name of the mc:edit editable region to inject into&lt;/li&gt;
&lt;li&gt;content string the content to inject&lt;/li&gt;
&lt;/ul&gt;&lt;/li&gt;
&lt;/ul&gt;
* $merge_vars **array** - &lt;p&gt;optional merge variables to use for injecting merge field content.  If this is not provided, no merge fields will be replaced.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;merge_vars[] struct a single merge variable
&lt;ul&gt;
&lt;li&gt;name string the merge variable&#039;s name. Merge variable names are case-insensitive and may not start with _&lt;/li&gt;
&lt;li&gt;content string the merge variable&#039;s content&lt;/li&gt;
&lt;/ul&gt;&lt;/li&gt;
&lt;/ul&gt;