صفحهٔ اصلی گشت‌و‌گذار راهنما
ورود
bachir
/
materio-base-d7
1
0
انشعاب 0
پرونده‌ها مشکلات 0 درخواست واکشی 0 ویکی
درخت: 54f496acad
شاخه‌ها تگ‌ها
materio-base-d7
/
sites
/
all
/
libraries
/
mandrill
/
mailchimp-mandrill-api-php-e1eda7352f24
/
docs
/
class-Mandrill_Templates.html

class-Mandrill_Templates.html 29 KB
تاريخچه خام

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738 
  1. <!DOCTYPE html>
    2. 

  2. <html>
    3. 

  3. <head>
    4. 

  4. 	<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    5. 

  5. 	<meta name="generator" content="ApiGen 2.8.0" />
    6. 

  6. 

  7. 	<title>Class Mandrill_Templates</title>
    8. 

  8. 

  9. 	<script type="text/javascript" src="resources/combined.js?394153670"></script>
    10. 

  10. 	<script type="text/javascript" src="elementlist.js?882160656"></script>
    11. 

  11. 	<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
    12. 

  12. 

  13. </head>
    14. 

  14. 

  15. <body>
    16. 

  16. <div id="left">
    17. 

  17. 	<div id="menu">
    18. 

  18. 		<a href="index.html" title="Overview"><span>Overview</span></a>
    19. 

  19. 

  20. 

  21. 		<div id="groups">
    22. 

  22. 			<h3>Namespaces</h3>
    23. 

  23. 			<ul>
    24. 

  24. 				<li class="active"><a href="namespace-None.html">None</a>
    25. 

  25. 						</li>
    26. 

  26. 				<li><a href="namespace-PHP.html">PHP</a>
    27. 

  27. 						</li>
    28. 

  28. 			</ul>
    29. 

  29. 		</div>
    30. 

  30. 

  31. 		<hr />
    32. 

  32. 

  33. 

  34. 		<div id="elements">
    35. 

  35. 			<h3>Classes</h3>
    36. 

  36. 			<ul>
    37. 

  37. 				<li><a href="class-Mandrill.html">Mandrill</a></li>
    38. 

  38. 				<li><a href="class-Mandrill_Exports.html">Mandrill_Exports</a></li>
    39. 

  39. 				<li><a href="class-Mandrill_Inbound.html">Mandrill_Inbound</a></li>
    40. 

  40. 				<li><a href="class-Mandrill_Internal.html">Mandrill_Internal</a></li>
    41. 

  41. 				<li><a href="class-Mandrill_Ips.html">Mandrill_Ips</a></li>
    42. 

  42. 				<li><a href="class-Mandrill_Messages.html">Mandrill_Messages</a></li>
    43. 

  43. 				<li><a href="class-Mandrill_Metadata.html">Mandrill_Metadata</a></li>
    44. 

  44. 				<li><a href="class-Mandrill_Rejects.html">Mandrill_Rejects</a></li>
    45. 

  45. 				<li><a href="class-Mandrill_Senders.html">Mandrill_Senders</a></li>
    46. 

  46. 				<li><a href="class-Mandrill_Subaccounts.html">Mandrill_Subaccounts</a></li>
    47. 

  47. 				<li><a href="class-Mandrill_Tags.html">Mandrill_Tags</a></li>
    48. 

  48. 				<li class="active"><a href="class-Mandrill_Templates.html">Mandrill_Templates</a></li>
    49. 

  49. 				<li><a href="class-Mandrill_Urls.html">Mandrill_Urls</a></li>
    50. 

  50. 				<li><a href="class-Mandrill_Users.html">Mandrill_Users</a></li>
    51. 

  51. 				<li><a href="class-Mandrill_Webhooks.html">Mandrill_Webhooks</a></li>
    52. 

  52. 				<li><a href="class-Mandrill_Whitelists.html">Mandrill_Whitelists</a></li>
    53. 

  53. 			</ul>
    54. 

  54. 

  55. 

  56. 

  57. 			<h3>Exceptions</h3>
    58. 

  58. 			<ul>
    59. 

  59. 				<li><a href="class-Mandrill_Error.html">Mandrill_Error</a></li>
    60. 

  60. 				<li><a href="class-Mandrill_HttpError.html">Mandrill_HttpError</a></li>
    61. 

  61. 				<li><a href="class-Mandrill_Invalid_CustomDNS.html">Mandrill_Invalid_CustomDNS</a></li>
    62. 

  62. 				<li><a href="class-Mandrill_Invalid_CustomDNSPending.html">Mandrill_Invalid_CustomDNSPending</a></li>
    63. 

  63. 				<li><a href="class-Mandrill_Invalid_DeleteDefaultPool.html">Mandrill_Invalid_DeleteDefaultPool</a></li>
    64. 

  64. 				<li><a href="class-Mandrill_Invalid_DeleteNonEmptyPool.html">Mandrill_Invalid_DeleteNonEmptyPool</a></li>
    65. 

  65. 				<li><a href="class-Mandrill_Invalid_EmptyDefaultPool.html">Mandrill_Invalid_EmptyDefaultPool</a></li>
    66. 

  66. 				<li><a href="class-Mandrill_Invalid_Key.html">Mandrill_Invalid_Key</a></li>
    67. 

  67. 				<li><a href="class-Mandrill_Invalid_Reject.html">Mandrill_Invalid_Reject</a></li>
    68. 

  68. 				<li><a href="class-Mandrill_Invalid_Tag_Name.html">Mandrill_Invalid_Tag_Name</a></li>
    69. 

  69. 				<li><a href="class-Mandrill_Invalid_Template.html">Mandrill_Invalid_Template</a></li>
    70. 

  70. 				<li><a href="class-Mandrill_IP_ProvisionLimit.html">Mandrill_IP_ProvisionLimit</a></li>
    71. 

  71. 				<li><a href="class-Mandrill_Metadata_FieldLimit.html">Mandrill_Metadata_FieldLimit</a></li>
    72. 

  72. 				<li><a href="class-Mandrill_NoSendingHistory.html">Mandrill_NoSendingHistory</a></li>
    73. 

  73. 				<li><a href="class-Mandrill_PaymentRequired.html">Mandrill_PaymentRequired</a></li>
    74. 

  74. 				<li><a href="class-Mandrill_PoorReputation.html">Mandrill_PoorReputation</a></li>
    75. 

  75. 				<li><a href="class-Mandrill_ServiceUnavailable.html">Mandrill_ServiceUnavailable</a></li>
    76. 

  76. 				<li><a href="class-Mandrill_Unknown_Export.html">Mandrill_Unknown_Export</a></li>
    77. 

  77. 				<li><a href="class-Mandrill_Unknown_InboundDomain.html">Mandrill_Unknown_InboundDomain</a></li>
    78. 

  78. 				<li><a href="class-Mandrill_Unknown_InboundRoute.html">Mandrill_Unknown_InboundRoute</a></li>
    79. 

  79. 				<li><a href="class-Mandrill_Unknown_IP.html">Mandrill_Unknown_IP</a></li>
    80. 

  80. 				<li><a href="class-Mandrill_Unknown_Message.html">Mandrill_Unknown_Message</a></li>
    81. 

  81. 				<li><a href="class-Mandrill_Unknown_MetadataField.html">Mandrill_Unknown_MetadataField</a></li>
    82. 

  82. 				<li><a href="class-Mandrill_Unknown_Pool.html">Mandrill_Unknown_Pool</a></li>
    83. 

  83. 				<li><a href="class-Mandrill_Unknown_Sender.html">Mandrill_Unknown_Sender</a></li>
    84. 

  84. 				<li><a href="class-Mandrill_Unknown_Subaccount.html">Mandrill_Unknown_Subaccount</a></li>
    85. 

  85. 				<li><a href="class-Mandrill_Unknown_Template.html">Mandrill_Unknown_Template</a></li>
    86. 

  86. 				<li><a href="class-Mandrill_Unknown_TrackingDomain.html">Mandrill_Unknown_TrackingDomain</a></li>
    87. 

  87. 				<li><a href="class-Mandrill_Unknown_Url.html">Mandrill_Unknown_Url</a></li>
    88. 

  88. 				<li><a href="class-Mandrill_Unknown_Webhook.html">Mandrill_Unknown_Webhook</a></li>
    89. 

  89. 				<li><a href="class-Mandrill_ValidationError.html">Mandrill_ValidationError</a></li>
    90. 

  90. 			</ul>
    91. 

  91. 

  92. 

  93. 		</div>
    94. 

  94. 	</div>
    95. 

  95. </div>
    96. 

  96. 

  97. <div id="splitter"></div>
    98. 

  98. 

  99. <div id="right">
    100. 

  100. <div id="rightInner">
    101. 

  101. 	<form id="search">
    102. 

  102. 		<input type="hidden" name="cx" value="" />
    103. 

  103. 		<input type="hidden" name="ie" value="UTF-8" />
    104. 

  104. 		<input type="text" name="q" class="text" />
    105. 

  105. 		<input type="submit" value="Search" />
    106. 

  106. 	</form>
    107. 

  107. 

  108. 	<div id="navigation">
    109. 

  109. 		<ul>
    110. 

  110. 			<li>
    111. 

  111. 				<a href="index.html" title="Overview"><span>Overview</span></a>
    112. 

  112. 			</li>
    113. 

  113. 			<li>
    114. 

  114. 				<a href="namespace-None.html" title="Summary of None"><span>Namespace</span></a>
    115. 

  115. 			</li>
    116. 

  116. 			<li class="active">
    117. 

  117. <span>Class</span>			</li>
    118. 

  118. 		</ul>
    119. 

  119. 		<ul>
    120. 

  120. 			<li>
    121. 

  121. 				<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
    122. 

  122. 			</li>
    123. 

  123. 		</ul>
    124. 

  124. 		<ul>
    125. 

  125. 		</ul>
    126. 

  126. 	</div>
    127. 

  127. 

  128. <div id="content" class="class">
    129. 

  129. 	<h1>Class Mandrill_Templates</h1>
    130. 

  130. 

  131. 

  132. 

  133. 

  134. 

  135. 

  136. 

  137. 

  138. 

  139. 

  140. 

  141. 	<div class="info">
    142. 

  142. 		
    143. 

  143. 		
    144. 

  144. 		
    145. 

  145. 		
    146. 

  146. 

  147. 		<b>Located at</b> <a href="source-class-Mandrill_Templates.html#3-233" title="Go to source code">Mandrill/Templates.php</a><br />
    148. 

  148. 	</div>
    149. 

  149. 

  150. 

  151. 

  152. 	<table class="summary" id="methods">
    153. 

  153. 	<caption>Methods summary</caption>
    154. 

  154. 	<tr data-order="__construct" id="___construct">
    155. 

  155. 

  156. 		<td class="attributes"><code>
    157. 

  157. 			 public 
    158. 

  158. 			
    159. 

  159. 			
    160. 

  160. 			</code>
    161. 

  161. 		</td>
    162. 

  162. 

  163. 		<td class="name"><div>
    164. 

  164. 		<a class="anchor" href="#___construct">#</a>
    165. 

  165. 		<code><a href="source-class-Mandrill_Templates.html#4-6" title="Go to source code">__construct</a>( <span><code><a href="class-Mandrill.html">Mandrill</a></code> <var>$master</var></span> )</code>
    166. 

  166. 

  167. 		<div class="description short">
    168. 

  168. 			
    169. 

  169. 		</div>
    170. 

  170. 

  171. 		<div class="description detailed hidden">
    172. 

  172. 			
    173. 

  173. 

  174. 

  175. 

  176. 

  177. 

  178. 

  179. 

  180. 		</div>
    181. 

  181. 		</div></td>
    182. 

  182. 	</tr>
    183. 

  183. 	<tr data-order="add" id="_add">
    184. 

  184. 

  185. 		<td class="attributes"><code>
    186. 

  186. 			 public 
    187. 

  187. 			struct
    188. 

  188. 			
    189. 

  189. 			</code>
    190. 

  190. 		</td>
    191. 

  191. 

  192. 		<td class="name"><div>
    193. 

  193. 		<a class="anchor" href="#_add">#</a>
    194. 

  194. 		<code><a href="source-class-Mandrill_Templates.html#8-42" title="Go to source code">add</a>( <span>string <var>$name</var></span>, <span>string <var>$from_email</var> = <span class="php-keyword1">null</span></span>, <span>string <var>$from_name</var> = <span class="php-keyword1">null</span></span>, <span>string <var>$subject</var> = <span class="php-keyword1">null</span></span>, <span>string <var>$code</var> = <span class="php-keyword1">null</span></span>, <span>string <var>$text</var> = <span class="php-keyword1">null</span></span>, <span>boolean <var>$publish</var> = <span class="php-keyword1">true</span></span>, <span>array <var>$labels</var> = <span class="php-keyword1">array</span>()</span> )</code>
    195. 

  195. 

  196. 		<div class="description short">
    197. 

  197. 			
    198. 

  198. <p>Add a new template</p>
    199. 

  199. 

  200. 		</div>
    201. 

  201. 

  202. 		<div class="description detailed hidden">
    203. 

  203. 			
    204. 

  204. <p>Add a new template</p>
    205. 

  205. 

  206. 

  207. 

  208. 				<h4>Parameters</h4>
    209. 

  209. 				<div class="list"><dl>
    210. 

  210. 					<dt><var>$name</var></dt>
    211. 

  211. 					<dd><code>string</code><br>$name the name for the new template - must be unique</dd>
    212. 

  212. 					<dt><var>$from_email</var></dt>
    213. 

  213. 					<dd><code>string</code><br>$from_email a default sending address for emails sent using this template</dd>
    214. 

  214. 					<dt><var>$from_name</var></dt>
    215. 

  215. 					<dd><code>string</code><br>$from_name a default from name to be used</dd>
    216. 

  216. 					<dt><var>$subject</var></dt>
    217. 

  217. 					<dd><code>string</code><br>$subject a default subject line to be used</dd>
    218. 

  218. 					<dt><var>$code</var></dt>
    219. 

  219. 					<dd><code>string</code><br>$code the HTML code for the template with mc:edit attributes for the editable
    220. 

  220. elements</dd>
    221. 

  221. 					<dt><var>$text</var></dt>
    222. 

  222. 					<dd><code>string</code><br>$text a default text part to be used when sending with this template</dd>
    223. 

  223. 					<dt><var>$publish</var></dt>
    224. 

  224. 					<dd><code>boolean</code><br>$publish set to false to add a draft template without publishing</dd>
    225. 

  225. 					<dt><var>$labels</var></dt>
    226. 

  226. 					<dd><code>array</code><br>$labels an optional array of up to 10 labels to use for filtering templates -
    227. 

  227. labels[] string a single label</dd>
    228. 

  228. 				</dl></div>
    229. 

  229. 

  230. 				<h4>Returns</h4>
    231. 

  231. 				<div class="list">
    232. 

  232. 					<code>struct</code><br>the information saved about the new template - slug string the immutable unique
    233. 

  233. code name of the template - name string the name of the template - labels array
    234. 

  234. the list of labels applied to the template - labels[] string a single label -
    235. 

  235. code string the full HTML code of the template, with mc:edit attributes marking
    236. 

  236. the editable elements - draft version - subject string the subject line of the
    237. 

  237. template, if provided - draft version - from_email string the default sender
    238. 

  238. address for the template, if provided - draft version - from_name string the
    239. 

  239. default sender from name for the template, if provided - draft version - text
    240. 

  240. string the default text part of messages sent with the template, if provided -
    241. 

  241. draft version - publish_name string the same as the template name - kept as a
    242. 

  242. separate field for backwards compatibility - publish_code string the full HTML
    243. 

  243. code of the template, with mc:edit attributes marking the editable elements that
    244. 

  244. are available as published, if it has been published - publish_subject string
    245. 

  245. the subject line of the template, if provided - publish_from_email string the
    246. 

  246. default sender address for the template, if provided - publish_from_name string
    247. 

  247. the default sender from name for the template, if provided - publish_text string
    248. 

  248. the default text part of messages sent with the template, if provided -
    249. 

  249. published_at string the date and time the template was last published as a UTC
    250. 

  250. string in YYYY-MM-DD HH:MM:SS format, or null if it has not been published -
    251. 

  251. created_at string the date and time the template was first created as a UTC
    252. 

  252. string in YYYY-MM-DD HH:MM:SS format - updated_at string the date and time the
    253. 

  253. template was last modified as a UTC string in YYYY-MM-DD HH:MM:SS format<br />
    254. 

  254. 				</div>
    255. 

  255. 

  256. 

  257. 

  258. 

  259. 		</div>
    260. 

  260. 		</div></td>
    261. 

  261. 	</tr>
    262. 

  262. 	<tr data-order="info" id="_info">
    263. 

  263. 

  264. 		<td class="attributes"><code>
    265. 

  265. 			 public 
    266. 

  266. 			struct
    267. 

  267. 			
    268. 

  268. 			</code>
    269. 

  269. 		</td>
    270. 

  270. 

  271. 		<td class="name"><div>
    272. 

  272. 		<a class="anchor" href="#_info">#</a>
    273. 

  273. 		<code><a href="source-class-Mandrill_Templates.html#44-70" title="Go to source code">info</a>( <span>string <var>$name</var></span> )</code>
    274. 

  274. 

  275. 		<div class="description short">
    276. 

  276. 			
    277. 

  277. <p>Get the information for an existing template</p>
    278. 

  278. 

  279. 		</div>
    280. 

  280. 

  281. 		<div class="description detailed hidden">
    282. 

  282. 			
    283. 

  283. <p>Get the information for an existing template</p>
    284. 

  284. 

  285. 

  286. 

  287. 				<h4>Parameters</h4>
    288. 

  288. 				<div class="list"><dl>
    289. 

  289. 					<dt><var>$name</var></dt>
    290. 

  290. 					<dd><code>string</code><br>$name the immutable name of an existing template</dd>
    291. 

  291. 				</dl></div>
    292. 

  292. 

  293. 				<h4>Returns</h4>
    294. 

  294. 				<div class="list">
    295. 

  295. 					<code>struct</code><br>the requested template information - slug string the immutable unique code name
    296. 

  296. of the template - name string the name of the template - labels array the list
    297. 

  297. of labels applied to the template - labels[] string a single label - code string
    298. 

  298. the full HTML code of the template, with mc:edit attributes marking the editable
    299. 

  299. elements - draft version - subject string the subject line of the template, if
    300. 

  300. provided - draft version - from_email string the default sender address for the
    301. 

  301. template, if provided - draft version - from_name string the default sender from
    302. 

  302. name for the template, if provided - draft version - text string the default
    303. 

  303. text part of messages sent with the template, if provided - draft version -
    304. 

  304. publish_name string the same as the template name - kept as a separate field for
    305. 

  305. backwards compatibility - publish_code string the full HTML code of the
    306. 

  306. template, with mc:edit attributes marking the editable elements that are
    307. 

  307. available as published, if it has been published - publish_subject string the
    308. 

  308. subject line of the template, if provided - publish_from_email string the
    309. 

  309. default sender address for the template, if provided - publish_from_name string
    310. 

  310. the default sender from name for the template, if provided - publish_text string
    311. 

  311. the default text part of messages sent with the template, if provided -
    312. 

  312. published_at string the date and time the template was last published as a UTC
    313. 

  313. string in YYYY-MM-DD HH:MM:SS format, or null if it has not been published -
    314. 

  314. created_at string the date and time the template was first created as a UTC
    315. 

  315. string in YYYY-MM-DD HH:MM:SS format - updated_at string the date and time the
    316. 

  316. template was last modified as a UTC string in YYYY-MM-DD HH:MM:SS format<br />
    317. 

  317. 				</div>
    318. 

  318. 

  319. 

  320. 

  321. 

  322. 		</div>
    323. 

  323. 		</div></td>
    324. 

  324. 	</tr>
    325. 

  325. 	<tr data-order="update" id="_update">
    326. 

  326. 

  327. 		<td class="attributes"><code>
    328. 

  328. 			 public 
    329. 

  329. 			struct
    330. 

  330. 			
    331. 

  331. 			</code>
    332. 

  332. 		</td>
    333. 

  333. 

  334. 		<td class="name"><div>
    335. 

  335. 		<a class="anchor" href="#_update">#</a>
    336. 

  336. 		<code><a href="source-class-Mandrill_Templates.html#72-106" title="Go to source code">update</a>( <span>string <var>$name</var></span>, <span>string <var>$from_email</var> = <span class="php-keyword1">null</span></span>, <span>string <var>$from_name</var> = <span class="php-keyword1">null</span></span>, <span>string <var>$subject</var> = <span class="php-keyword1">null</span></span>, <span>string <var>$code</var> = <span class="php-keyword1">null</span></span>, <span>string <var>$text</var> = <span class="php-keyword1">null</span></span>, <span>boolean <var>$publish</var> = <span class="php-keyword1">true</span></span>, <span>array <var>$labels</var> = <span class="php-keyword1">null</span></span> )</code>
    337. 

  337. 

  338. 		<div class="description short">
    339. 

  339. 			
    340. 

  340. <p>Update the code for an existing template. If null is provided for any fields,
    341. 

  341. the values will remain unchanged.</p>
    342. 

  342. 

  343. 		</div>
    344. 

  344. 

  345. 		<div class="description detailed hidden">
    346. 

  346. 			
    347. 

  347. <p>Update the code for an existing template. If null is provided for any fields,
    348. 

  348. the values will remain unchanged.</p>
    349. 

  349. 

  350. 

  351. 

  352. 				<h4>Parameters</h4>
    353. 

  353. 				<div class="list"><dl>
    354. 

  354. 					<dt><var>$name</var></dt>
    355. 

  355. 					<dd><code>string</code><br>$name the immutable name of an existing template</dd>
    356. 

  356. 					<dt><var>$from_email</var></dt>
    357. 

  357. 					<dd><code>string</code><br>$from_email the new default sending address</dd>
    358. 

  358. 					<dt><var>$from_name</var></dt>
    359. 

  359. 					<dd><code>string</code><br>$from_name the new default from name</dd>
    360. 

  360. 					<dt><var>$subject</var></dt>
    361. 

  361. 					<dd><code>string</code><br>$subject the new default subject line</dd>
    362. 

  362. 					<dt><var>$code</var></dt>
    363. 

  363. 					<dd><code>string</code><br>$code the new code for the template</dd>
    364. 

  364. 					<dt><var>$text</var></dt>
    365. 

  365. 					<dd><code>string</code><br>$text the new default text part to be used</dd>
    366. 

  366. 					<dt><var>$publish</var></dt>
    367. 

  367. 					<dd><code>boolean</code><br>$publish set to false to update the draft version of the template without
    368. 

  368. publishing</dd>
    369. 

  369. 					<dt><var>$labels</var></dt>
    370. 

  370. 					<dd><code>array</code><br>$labels an optional array of up to 10 labels to use for filtering templates -
    371. 

  371. labels[] string a single label</dd>
    372. 

  372. 				</dl></div>
    373. 

  373. 

  374. 				<h4>Returns</h4>
    375. 

  375. 				<div class="list">
    376. 

  376. 					<code>struct</code><br>the template that was updated - slug string the immutable unique code name of
    377. 

  377. the template - name string the name of the template - labels array the list of
    378. 

  378. labels applied to the template - labels[] string a single label - code string
    379. 

  379. the full HTML code of the template, with mc:edit attributes marking the editable
    380. 

  380. elements - draft version - subject string the subject line of the template, if
    381. 

  381. provided - draft version - from_email string the default sender address for the
    382. 

  382. template, if provided - draft version - from_name string the default sender from
    383. 

  383. name for the template, if provided - draft version - text string the default
    384. 

  384. text part of messages sent with the template, if provided - draft version -
    385. 

  385. publish_name string the same as the template name - kept as a separate field for
    386. 

  386. backwards compatibility - publish_code string the full HTML code of the
    387. 

  387. template, with mc:edit attributes marking the editable elements that are
    388. 

  388. available as published, if it has been published - publish_subject string the
    389. 

  389. subject line of the template, if provided - publish_from_email string the
    390. 

  390. default sender address for the template, if provided - publish_from_name string
    391. 

  391. the default sender from name for the template, if provided - publish_text string
    392. 

  392. the default text part of messages sent with the template, if provided -
    393. 

  393. published_at string the date and time the template was last published as a UTC
    394. 

  394. string in YYYY-MM-DD HH:MM:SS format, or null if it has not been published -
    395. 

  395. created_at string the date and time the template was first created as a UTC
    396. 

  396. string in YYYY-MM-DD HH:MM:SS format - updated_at string the date and time the
    397. 

  397. template was last modified as a UTC string in YYYY-MM-DD HH:MM:SS format<br />
    398. 

  398. 				</div>
    399. 

  399. 

  400. 

  401. 

  402. 

  403. 		</div>
    404. 

  404. 		</div></td>
    405. 

  405. 	</tr>
    406. 

  406. 	<tr data-order="publish" id="_publish">
    407. 

  407. 

  408. 		<td class="attributes"><code>
    409. 

  409. 			 public 
    410. 

  410. 			struct
    411. 

  411. 			
    412. 

  412. 			</code>
    413. 

  413. 		</td>
    414. 

  414. 

  415. 		<td class="name"><div>
    416. 

  416. 		<a class="anchor" href="#_publish">#</a>
    417. 

  417. 		<code><a href="source-class-Mandrill_Templates.html#108-134" title="Go to source code">publish</a>( <span>string <var>$name</var></span> )</code>
    418. 

  418. 

  419. 		<div class="description short">
    420. 

  420. 			
    421. 

  421. <p>Publish the content for the template. Any new messages sent using this
    422. 

  422. template will start using the content that was previously in draft.</p>
    423. 

  423. 

  424. 		</div>
    425. 

  425. 

  426. 		<div class="description detailed hidden">
    427. 

  427. 			
    428. 

  428. <p>Publish the content for the template. Any new messages sent using this
    429. 

  429. template will start using the content that was previously in draft.</p>
    430. 

  430. 

  431. 

  432. 

  433. 				<h4>Parameters</h4>
    434. 

  434. 				<div class="list"><dl>
    435. 

  435. 					<dt><var>$name</var></dt>
    436. 

  436. 					<dd><code>string</code><br>$name the immutable name of an existing template</dd>
    437. 

  437. 				</dl></div>
    438. 

  438. 

  439. 				<h4>Returns</h4>
    440. 

  440. 				<div class="list">
    441. 

  441. 					<code>struct</code><br>the template that was published - slug string the immutable unique code name of
    442. 

  442. the template - name string the name of the template - labels array the list of
    443. 

  443. labels applied to the template - labels[] string a single label - code string
    444. 

  444. the full HTML code of the template, with mc:edit attributes marking the editable
    445. 

  445. elements - draft version - subject string the subject line of the template, if
    446. 

  446. provided - draft version - from_email string the default sender address for the
    447. 

  447. template, if provided - draft version - from_name string the default sender from
    448. 

  448. name for the template, if provided - draft version - text string the default
    449. 

  449. text part of messages sent with the template, if provided - draft version -
    450. 

  450. publish_name string the same as the template name - kept as a separate field for
    451. 

  451. backwards compatibility - publish_code string the full HTML code of the
    452. 

  452. template, with mc:edit attributes marking the editable elements that are
    453. 

  453. available as published, if it has been published - publish_subject string the
    454. 

  454. subject line of the template, if provided - publish_from_email string the
    455. 

  455. default sender address for the template, if provided - publish_from_name string
    456. 

  456. the default sender from name for the template, if provided - publish_text string
    457. 

  457. the default text part of messages sent with the template, if provided -
    458. 

  458. published_at string the date and time the template was last published as a UTC
    459. 

  459. string in YYYY-MM-DD HH:MM:SS format, or null if it has not been published -
    460. 

  460. created_at string the date and time the template was first created as a UTC
    461. 

  461. string in YYYY-MM-DD HH:MM:SS format - updated_at string the date and time the
    462. 

  462. template was last modified as a UTC string in YYYY-MM-DD HH:MM:SS format<br />
    463. 

  463. 				</div>
    464. 

  464. 

  465. 

  466. 

  467. 

  468. 		</div>
    469. 

  469. 		</div></td>
    470. 

  470. 	</tr>
    471. 

  471. 	<tr data-order="delete" id="_delete">
    472. 

  472. 

  473. 		<td class="attributes"><code>
    474. 

  474. 			 public 
    475. 

  475. 			struct
    476. 

  476. 			
    477. 

  477. 			</code>
    478. 

  478. 		</td>
    479. 

  479. 

  480. 		<td class="name"><div>
    481. 

  481. 		<a class="anchor" href="#_delete">#</a>
    482. 

  482. 		<code><a href="source-class-Mandrill_Templates.html#136-162" title="Go to source code">delete</a>( <span>string <var>$name</var></span> )</code>
    483. 

  483. 

  484. 		<div class="description short">
    485. 

  485. 			
    486. 

  486. <p>Delete a template</p>
    487. 

  487. 

  488. 		</div>
    489. 

  489. 

  490. 		<div class="description detailed hidden">
    491. 

  491. 			
    492. 

  492. <p>Delete a template</p>
    493. 

  493. 

  494. 

  495. 

  496. 				<h4>Parameters</h4>
    497. 

  497. 				<div class="list"><dl>
    498. 

  498. 					<dt><var>$name</var></dt>
    499. 

  499. 					<dd><code>string</code><br>$name the immutable name of an existing template</dd>
    500. 

  500. 				</dl></div>
    501. 

  501. 

  502. 				<h4>Returns</h4>
    503. 

  503. 				<div class="list">
    504. 

  504. 					<code>struct</code><br>the template that was deleted - slug string the immutable unique code name of
    505. 

  505. the template - name string the name of the template - labels array the list of
    506. 

  506. labels applied to the template - labels[] string a single label - code string
    507. 

  507. the full HTML code of the template, with mc:edit attributes marking the editable
    508. 

  508. elements - draft version - subject string the subject line of the template, if
    509. 

  509. provided - draft version - from_email string the default sender address for the
    510. 

  510. template, if provided - draft version - from_name string the default sender from
    511. 

  511. name for the template, if provided - draft version - text string the default
    512. 

  512. text part of messages sent with the template, if provided - draft version -
    513. 

  513. publish_name string the same as the template name - kept as a separate field for
    514. 

  514. backwards compatibility - publish_code string the full HTML code of the
    515. 

  515. template, with mc:edit attributes marking the editable elements that are
    516. 

  516. available as published, if it has been published - publish_subject string the
    517. 

  517. subject line of the template, if provided - publish_from_email string the
    518. 

  518. default sender address for the template, if provided - publish_from_name string
    519. 

  519. the default sender from name for the template, if provided - publish_text string
    520. 

  520. the default text part of messages sent with the template, if provided -
    521. 

  521. published_at string the date and time the template was last published as a UTC
    522. 

  522. string in YYYY-MM-DD HH:MM:SS format, or null if it has not been published -
    523. 

  523. created_at string the date and time the template was first created as a UTC
    524. 

  524. string in YYYY-MM-DD HH:MM:SS format - updated_at string the date and time the
    525. 

  525. template was last modified as a UTC string in YYYY-MM-DD HH:MM:SS format<br />
    526. 

  526. 				</div>
    527. 

  527. 

  528. 

  529. 

  530. 

  531. 		</div>
    532. 

  532. 		</div></td>
    533. 

  533. 	</tr>
    534. 

  534. 	<tr data-order="getList" id="_getList">
    535. 

  535. 

  536. 		<td class="attributes"><code>
    537. 

  537. 			 public 
    538. 

  538. 			array
    539. 

  539. 			
    540. 

  540. 			</code>
    541. 

  541. 		</td>
    542. 

  542. 

  543. 		<td class="name"><div>
    544. 

  544. 		<a class="anchor" href="#_getList">#</a>
    545. 

  545. 		<code><a href="source-class-Mandrill_Templates.html#164-191" title="Go to source code">getList</a>( <span>string <var>$label</var> = <span class="php-keyword1">null</span></span> )</code>
    546. 

  546. 

  547. 		<div class="description short">
    548. 

  548. 			
    549. 

  549. <p>Return a list of all the templates available to this user</p>
    550. 

  550. 

  551. 		</div>
    552. 

  552. 

  553. 		<div class="description detailed hidden">
    554. 

  554. 			
    555. 

  555. <p>Return a list of all the templates available to this user</p>
    556. 

  556. 

  557. 

  558. 

  559. 				<h4>Parameters</h4>
    560. 

  560. 				<div class="list"><dl>
    561. 

  561. 					<dt><var>$label</var></dt>
    562. 

  562. 					<dd><code>string</code><br>$label an optional label to filter the templates</dd>
    563. 

  563. 				</dl></div>
    564. 

  564. 

  565. 				<h4>Returns</h4>
    566. 

  566. 				<div class="list">
    567. 

  567. 					<code>array</code><br>an array of structs with information about each template - return[] struct the
    568. 

  568. information on each template in the account - slug string the immutable unique
    569. 

  569. code name of the template - name string the name of the template - labels array
    570. 

  570. the list of labels applied to the template - labels[] string a single label -
    571. 

  571. code string the full HTML code of the template, with mc:edit attributes marking
    572. 

  572. the editable elements - draft version - subject string the subject line of the
    573. 

  573. template, if provided - draft version - from_email string the default sender
    574. 

  574. address for the template, if provided - draft version - from_name string the
    575. 

  575. default sender from name for the template, if provided - draft version - text
    576. 

  576. string the default text part of messages sent with the template, if provided -
    577. 

  577. draft version - publish_name string the same as the template name - kept as a
    578. 

  578. separate field for backwards compatibility - publish_code string the full HTML
    579. 

  579. code of the template, with mc:edit attributes marking the editable elements that
    580. 

  580. are available as published, if it has been published - publish_subject string
    581. 

  581. the subject line of the template, if provided - publish_from_email string the
    582. 

  582. default sender address for the template, if provided - publish_from_name string
    583. 

  583. the default sender from name for the template, if provided - publish_text string
    584. 

  584. the default text part of messages sent with the template, if provided -
    585. 

  585. published_at string the date and time the template was last published as a UTC
    586. 

  586. string in YYYY-MM-DD HH:MM:SS format, or null if it has not been published -
    587. 

  587. created_at string the date and time the template was first created as a UTC
    588. 

  588. string in YYYY-MM-DD HH:MM:SS format - updated_at string the date and time the
    589. 

  589. template was last modified as a UTC string in YYYY-MM-DD HH:MM:SS format<br />
    590. 

  590. 				</div>
    591. 

  591. 

  592. 

  593. 

  594. 

  595. 		</div>
    596. 

  596. 		</div></td>
    597. 

  597. 	</tr>
    598. 

  598. 	<tr data-order="timeSeries" id="_timeSeries">
    599. 

  599. 

  600. 		<td class="attributes"><code>
    601. 

  601. 			 public 
    602. 

  602. 			array
    603. 

  603. 			
    604. 

  604. 			</code>
    605. 

  605. 		</td>
    606. 

  606. 

  607. 		<td class="name"><div>
    608. 

  608. 		<a class="anchor" href="#_timeSeries">#</a>
    609. 

  609. 		<code><a href="source-class-Mandrill_Templates.html#193-212" title="Go to source code">timeSeries</a>( <span>string <var>$name</var></span> )</code>
    610. 

  610. 

  611. 		<div class="description short">
    612. 

  612. 			
    613. 

  613. <p>Return the recent history (hourly stats for the last 30 days) for a
    614. 

  614. template</p>
    615. 

  615. 

  616. 		</div>
    617. 

  617. 

  618. 		<div class="description detailed hidden">
    619. 

  619. 			
    620. 

  620. <p>Return the recent history (hourly stats for the last 30 days) for a
    621. 

  621. template</p>
    622. 

  622. 

  623. 

  624. 

  625. 				<h4>Parameters</h4>
    626. 

  626. 				<div class="list"><dl>
    627. 

  627. 					<dt><var>$name</var></dt>
    628. 

  628. 					<dd><code>string</code><br>$name the name of an existing template</dd>
    629. 

  629. 				</dl></div>
    630. 

  630. 

  631. 				<h4>Returns</h4>
    632. 

  632. 				<div class="list">
    633. 

  633. 					<code>array</code><br>the array of history information - return[] struct the stats for a single hour -
    634. 

  634. time string the hour as a UTC date string in YYYY-MM-DD HH:MM:SS format - sent
    635. 

  635. integer the number of emails that were sent during the hour - hard_bounces
    636. 

  636. integer the number of emails that hard bounced during the hour - soft_bounces
    637. 

  637. integer the number of emails that soft bounced during the hour - rejects integer
    638. 

  638. the number of emails that were rejected during the hour - complaints integer the
    639. 

  639. number of spam complaints received during the hour - opens integer the number of
    640. 

  640. emails opened during the hour - unique_opens integer the number of unique opens
    641. 

  641. generated by messages sent during the hour - clicks integer the number of
    642. 

  642. tracked URLs clicked during the hour - unique_clicks integer the number of
    643. 

  643. unique clicks generated by messages sent during the hour<br />
    644. 

  644. 				</div>
    645. 

  645. 

  646. 

  647. 

  648. 

  649. 		</div>
    650. 

  650. 		</div></td>
    651. 

  651. 	</tr>
    652. 

  652. 	<tr data-order="render" id="_render">
    653. 

  653. 

  654. 		<td class="attributes"><code>
    655. 

  655. 			 public 
    656. 

  656. 			struct
    657. 

  657. 			
    658. 

  658. 			</code>
    659. 

  659. 		</td>
    660. 

  660. 

  661. 		<td class="name"><div>
    662. 

  662. 		<a class="anchor" href="#_render">#</a>
    663. 

  663. 		<code><a href="source-class-Mandrill_Templates.html#214-231" title="Go to source code">render</a>( <span>string <var>$template_name</var></span>, <span>array <var>$template_content</var></span>, <span>array <var>$merge_vars</var> = <span class="php-keyword1">null</span></span> )</code>
    664. 

  664. 

  665. 		<div class="description short">
    666. 

  666. 			
    667. 

  667. <p>Inject content and optionally merge fields into a template, returning the
    668. 

  668. HTML that results</p>
    669. 

  669. 

  670. 		</div>
    671. 

  671. 

  672. 		<div class="description detailed hidden">
    673. 

  673. 			
    674. 

  674. <p>Inject content and optionally merge fields into a template, returning the
    675. 

  675. HTML that results</p>
    676. 

  676. 

  677. 

  678. 

  679. 				<h4>Parameters</h4>
    680. 

  680. 				<div class="list"><dl>
    681. 

  681. 					<dt><var>$template_name</var></dt>
    682. 

  682. 					<dd><code>string</code><br>$template_name the immutable name of a template that exists in the user's
    683. 

  683. account</dd>
    684. 

  684. 					<dt><var>$template_content</var></dt>
    685. 

  685. 					<dd><code>array</code><br>$template_content an array of template content to render. Each item in the array
    686. 

  686. should be a struct with two keys - name: the name of the content block to set
    687. 

  687. the content for, and content: the actual content to put into the block -
    688. 

  688. template_content[] struct the injection of a single piece of content into a
    689. 

  689. single editable region - name string the name of the mc:edit editable region to
    690. 

  690. inject into - content string the content to inject</dd>
    691. 

  691. 					<dt><var>$merge_vars</var></dt>
    692. 

  692. 					<dd><code>array</code><br>$merge_vars optional merge variables to use for injecting merge field content.
    693. 

  693. If this is not provided, no merge fields will be replaced. - merge_vars[] struct
    694. 

  694. a single merge variable - name string the merge variable's name. Merge variable
    695. 

  695. names are case-insensitive and may not start with _ - content string the merge
    696. 

  696. variable's content</dd>
    697. 

  697. 				</dl></div>
    698. 

  698. 

  699. 				<h4>Returns</h4>
    700. 

  700. 				<div class="list">
    701. 

  701. 					<code>struct</code><br>the result of rendering the given template with the content and merge field
    702. 

  702. values injected - html string the rendered HTML as a string<br />
    703. 

  703. 				</div>
    704. 

  704. 

  705. 

  706. 

  707. 

  708. 		</div>
    709. 

  709. 		</div></td>
    710. 

  710. 	</tr>
    711. 

  711. 	</table>
    712. 

  712. 

  713. 

  714. 

  715. 

  716. 

  717. 

  718. 

  719. 

  720. 

  721. 

  722. 

  723. 

  724. 

  725. 

  726. 

  727. 

  728. 

  729. 

  730. </div>
    731. 

  731. 

  732. 	<div id="footer">
    733. 

  733. 		 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
    734. 

  734. 	</div>
    735. 

  735. </div>
    736. 

  736. </div>
    737. 

  737. </body>
    738. 

  738. </html>
    739.