PageRenderTime 27ms CodeModel.GetById 26ms RepoModel.GetById 0ms app.codeStats 0ms

/docs/class-Mandrill_Webhooks.html

https://bitbucket.org/davisshaver/mandrill-api-php
HTML | 460 lines | 309 code | 151 blank | 0 comment | 0 complexity | 431d4711e5bfddbfd791b62071e178e9 MD5 | raw file
    

  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_Webhooks</title>
    8. 

  8. 

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

  10. 	<script type="text/javascript" src="elementlist.js?2926172792"></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_Inbound.html">Mandrill_Inbound</a></li>
    39. 

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

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

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

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

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

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

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

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

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

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

  49. 			</ul>
    50. 

  50. 

  51. 

  52. 

  53. 			<h3>Exceptions</h3>
    54. 

  54. 			<ul>
    55. 

  55. 				<li><a href="class-Mandrill_Error.html">Mandrill_Error</a></li>
    56. 

  56. 				<li><a href="class-Mandrill_HttpError.html">Mandrill_HttpError</a></li>
    57. 

  57. 				<li><a href="class-Mandrill_Invalid_Key.html">Mandrill_Invalid_Key</a></li>
    58. 

  58. 				<li><a href="class-Mandrill_Invalid_Reject.html">Mandrill_Invalid_Reject</a></li>
    59. 

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

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

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

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

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

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

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

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

  67. 			</ul>
    68. 

  68. 

  69. 

  70. 		</div>
    71. 

  71. 	</div>
    72. 

  72. </div>
    73. 

  73. 

  74. <div id="splitter"></div>
    75. 

  75. 

  76. <div id="right">
    77. 

  77. <div id="rightInner">
    78. 

  78. 	<form id="search">
    79. 

  79. 		<input type="hidden" name="cx" value="" />
    80. 

  80. 		<input type="hidden" name="ie" value="UTF-8" />
    81. 

  81. 		<input type="text" name="q" class="text" />
    82. 

  82. 		<input type="submit" value="Search" />
    83. 

  83. 	</form>
    84. 

  84. 

  85. 	<div id="navigation">
    86. 

  86. 		<ul>
    87. 

  87. 			<li>
    88. 

  88. 				<a href="index.html" title="Overview"><span>Overview</span></a>
    89. 

  89. 			</li>
    90. 

  90. 			<li>
    91. 

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

  92. 			</li>
    93. 

  93. 			<li class="active">
    94. 

  94. <span>Class</span>			</li>
    95. 

  95. 		</ul>
    96. 

  96. 		<ul>
    97. 

  97. 			<li>
    98. 

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

  99. 			</li>
    100. 

  100. 		</ul>
    101. 

  101. 		<ul>
    102. 

  102. 		</ul>
    103. 

  103. 	</div>
    104. 

  104. 

  105. <div id="content" class="class">
    106. 

  106. 	<h1>Class Mandrill_Webhooks</h1>
    107. 

  107. 

  108. 

  109. 

  110. 

  111. 

  112. 

  113. 

  114. 

  115. 

  116. 

  117. 

  118. 	<div class="info">
    119. 

  119. 		
    120. 

  120. 		
    121. 

  121. 		
    122. 

  122. 		
    123. 

  123. 

  124. 		<b>Located at</b> <a href="source-class-Mandrill_Webhooks.html#3-115" title="Go to source code">Mandrill/Webhooks.php</a><br />
    125. 

  125. 	</div>
    126. 

  126. 

  127. 

  128. 

  129. 	<table class="summary" id="methods">
    130. 

  130. 	<caption>Methods summary</caption>
    131. 

  131. 	<tr data-order="__construct" id="___construct">
    132. 

  132. 

  133. 		<td class="attributes"><code>
    134. 

  134. 			 public 
    135. 

  135. 			
    136. 

  136. 			
    137. 

  137. 			</code>
    138. 

  138. 		</td>
    139. 

  139. 

  140. 		<td class="name"><div>
    141. 

  141. 		<a class="anchor" href="#___construct">#</a>
    142. 

  142. 		<code><a href="source-class-Mandrill_Webhooks.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>
    143. 

  143. 

  144. 		<div class="description short">
    145. 

  145. 			
    146. 

  146. 		</div>
    147. 

  147. 

  148. 		<div class="description detailed hidden">
    149. 

  149. 			
    150. 

  150. 

  151. 

  152. 

  153. 

  154. 

  155. 

  156. 

  157. 		</div>
    158. 

  158. 		</div></td>
    159. 

  159. 	</tr>
    160. 

  160. 	<tr data-order="getList" id="_getList">
    161. 

  161. 

  162. 		<td class="attributes"><code>
    163. 

  163. 			 public 
    164. 

  164. 			array
    165. 

  165. 			
    166. 

  166. 			</code>
    167. 

  167. 		</td>
    168. 

  168. 

  169. 		<td class="name"><div>
    170. 

  170. 		<a class="anchor" href="#_getList">#</a>
    171. 

  171. 		<code><a href="source-class-Mandrill_Webhooks.html#8-26" title="Go to source code">getList</a>( )</code>
    172. 

  172. 

  173. 		<div class="description short">
    174. 

  174. 			
    175. 

  175. <p>Get the list of all webhooks defined on the account</p>
    176. 

  176. 

  177. 		</div>
    178. 

  178. 

  179. 		<div class="description detailed hidden">
    180. 

  180. 			
    181. 

  181. <p>Get the list of all webhooks defined on the account</p>
    182. 

  182. 

  183. 

  184. 

  185. 

  186. 				<h4>Returns</h4>
    187. 

  187. 				<div class="list">
    188. 

  188. 					<code>array</code><br>the webhooks associated with the account - return[] struct the inidividual
    189. 

  189. webhook info - id integer a unique integer indentifier for the webhook - url
    190. 

  190. string The URL that the event data will be posted to - description string a
    191. 

  191. description of the webhook - events array The message events that will be posted
    192. 

  192. to the hook - events[] string the individual message event (send, hard_bounce,
    193. 

  193. soft_bounce, open, click, spam, unsub, or reject) - created_at string the date
    194. 

  194. and time that the webhook was created as a UTC string in YYYY-MM-DD HH:MM:SS
    195. 

  195. format - last_sent_at string the date and time that the webhook last
    196. 

  196. successfully received events as a UTC string in YYYY-MM-DD HH:MM:SS format -
    197. 

  197. batches_sent integer the number of event batches that have ever been sent to
    198. 

  198. this webhook - events_sent integer the total number of events that have ever
    199. 

  199. been sent to this webhook - last_error string if we've ever gotten an error
    200. 

  200. trying to post to this webhook, the last error that we've seen<br />
    201. 

  201. 				</div>
    202. 

  202. 

  203. 

  204. 

  205. 

  206. 		</div>
    207. 

  207. 		</div></td>
    208. 

  208. 	</tr>
    209. 

  209. 	<tr data-order="add" id="_add">
    210. 

  210. 

  211. 		<td class="attributes"><code>
    212. 

  212. 			 public 
    213. 

  213. 			struct
    214. 

  214. 			
    215. 

  215. 			</code>
    216. 

  216. 		</td>
    217. 

  217. 

  218. 		<td class="name"><div>
    219. 

  219. 		<a class="anchor" href="#_add">#</a>
    220. 

  220. 		<code><a href="source-class-Mandrill_Webhooks.html#28-49" title="Go to source code">add</a>( <span>string <var>$url</var></span>, <span>string <var>$description</var> = <span class="php-keyword1">null</span></span>, <span>array <var>$events</var> = <span class="php-keyword1">array</span>()</span> )</code>
    221. 

  221. 

  222. 		<div class="description short">
    223. 

  223. 			
    224. 

  224. <p>Add a new webhook</p>
    225. 

  225. 

  226. 		</div>
    227. 

  227. 

  228. 		<div class="description detailed hidden">
    229. 

  229. 			
    230. 

  230. <p>Add a new webhook</p>
    231. 

  231. 

  232. 

  233. 

  234. 				<h4>Parameters</h4>
    235. 

  235. 				<div class="list"><dl>
    236. 

  236. 					<dt><var>$url</var></dt>
    237. 

  237. 					<dd><code>string</code><br>$url the URL to POST batches of events</dd>
    238. 

  238. 					<dt><var>$description</var></dt>
    239. 

  239. 					<dd><code>string</code><br>$description an optional description of the webhook</dd>
    240. 

  240. 					<dt><var>$events</var></dt>
    241. 

  241. 					<dd><code>array</code><br>$events an optional list of events that will be posted to the webhook - events[]
    242. 

  242. string the individual event to listen for</dd>
    243. 

  243. 				</dl></div>
    244. 

  244. 

  245. 				<h4>Returns</h4>
    246. 

  246. 				<div class="list">
    247. 

  247. 					<code>struct</code><br>the information saved about the new webhook - id integer a unique integer
    248. 

  248. indentifier for the webhook - url string The URL that the event data will be
    249. 

  249. posted to - description string a description of the webhook - events array The
    250. 

  250. message events that will be posted to the hook - events[] string the individual
    251. 

  251. message event (send, hard_bounce, soft_bounce, open, click, spam, unsub, or
    252. 

  252. reject) - created_at string the date and time that the webhook was created as a
    253. 

  253. UTC string in YYYY-MM-DD HH:MM:SS format - last_sent_at string the date and time
    254. 

  254. that the webhook last successfully received events as a UTC string in YYYY-MM-DD
    255. 

  255. HH:MM:SS format - batches_sent integer the number of event batches that have
    256. 

  256. ever been sent to this webhook - events_sent integer the total number of events
    257. 

  257. that have ever been sent to this webhook - last_error string if we've ever
    258. 

  258. gotten an error trying to post to this webhook, the last error that we've seen<br />
    259. 

  259. 				</div>
    260. 

  260. 

  261. 

  262. 

  263. 

  264. 		</div>
    265. 

  265. 		</div></td>
    266. 

  266. 	</tr>
    267. 

  267. 	<tr data-order="info" id="_info">
    268. 

  268. 

  269. 		<td class="attributes"><code>
    270. 

  270. 			 public 
    271. 

  271. 			struct
    272. 

  272. 			
    273. 

  273. 			</code>
    274. 

  274. 		</td>
    275. 

  275. 

  276. 		<td class="name"><div>
    277. 

  277. 		<a class="anchor" href="#_info">#</a>
    278. 

  278. 		<code><a href="source-class-Mandrill_Webhooks.html#51-69" title="Go to source code">info</a>( <span>integer <var>$id</var></span> )</code>
    279. 

  279. 

  280. 		<div class="description short">
    281. 

  281. 			
    282. 

  282. <p>Given the ID of an existing webhook, return the data about it</p>
    283. 

  283. 

  284. 		</div>
    285. 

  285. 

  286. 		<div class="description detailed hidden">
    287. 

  287. 			
    288. 

  288. <p>Given the ID of an existing webhook, return the data about it</p>
    289. 

  289. 

  290. 

  291. 

  292. 				<h4>Parameters</h4>
    293. 

  293. 				<div class="list"><dl>
    294. 

  294. 					<dt><var>$id</var></dt>
    295. 

  295. 					<dd><code>integer</code><br>$id the unique identifier of a webhook belonging to this account</dd>
    296. 

  296. 				</dl></div>
    297. 

  297. 

  298. 				<h4>Returns</h4>
    299. 

  299. 				<div class="list">
    300. 

  300. 					<code>struct</code><br>the information about the webhook - id integer a unique integer indentifier for
    301. 

  301. the webhook - url string The URL that the event data will be posted to -
    302. 

  302. description string a description of the webhook - events array The message
    303. 

  303. events that will be posted to the hook - events[] string the individual message
    304. 

  304. event (send, hard_bounce, soft_bounce, open, click, spam, unsub, or reject) -
    305. 

  305. created_at string the date and time that the webhook was created as a UTC string
    306. 

  306. in YYYY-MM-DD HH:MM:SS format - last_sent_at string the date and time that the
    307. 

  307. webhook last successfully received events as a UTC string in YYYY-MM-DD HH:MM:SS
    308. 

  308. format - batches_sent integer the number of event batches that have ever been
    309. 

  309. sent to this webhook - events_sent integer the total number of events that have
    310. 

  310. ever been sent to this webhook - last_error string if we've ever gotten an error
    311. 

  311. trying to post to this webhook, the last error that we've seen<br />
    312. 

  312. 				</div>
    313. 

  313. 

  314. 

  315. 

  316. 

  317. 		</div>
    318. 

  318. 		</div></td>
    319. 

  319. 	</tr>
    320. 

  320. 	<tr data-order="update" id="_update">
    321. 

  321. 

  322. 		<td class="attributes"><code>
    323. 

  323. 			 public 
    324. 

  324. 			struct
    325. 

  325. 			
    326. 

  326. 			</code>
    327. 

  327. 		</td>
    328. 

  328. 

  329. 		<td class="name"><div>
    330. 

  330. 		<a class="anchor" href="#_update">#</a>
    331. 

  331. 		<code><a href="source-class-Mandrill_Webhooks.html#71-93" title="Go to source code">update</a>( <span>integer <var>$id</var></span>, <span>string <var>$url</var></span>, <span>string <var>$description</var> = <span class="php-keyword1">null</span></span>, <span>array <var>$events</var> = <span class="php-keyword1">array</span>()</span> )</code>
    332. 

  332. 

  333. 		<div class="description short">
    334. 

  334. 			
    335. 

  335. <p>Update an existing webhook</p>
    336. 

  336. 

  337. 		</div>
    338. 

  338. 

  339. 		<div class="description detailed hidden">
    340. 

  340. 			
    341. 

  341. <p>Update an existing webhook</p>
    342. 

  342. 

  343. 

  344. 

  345. 				<h4>Parameters</h4>
    346. 

  346. 				<div class="list"><dl>
    347. 

  347. 					<dt><var>$id</var></dt>
    348. 

  348. 					<dd><code>integer</code><br>$id the unique identifier of a webhook belonging to this account</dd>
    349. 

  349. 					<dt><var>$url</var></dt>
    350. 

  350. 					<dd><code>string</code><br>$url the URL to POST batches of events</dd>
    351. 

  351. 					<dt><var>$description</var></dt>
    352. 

  352. 					<dd><code>string</code><br>$description an optional description of the webhook</dd>
    353. 

  353. 					<dt><var>$events</var></dt>
    354. 

  354. 					<dd><code>array</code><br>$events an optional list of events that will be posted to the webhook - events[]
    355. 

  355. string the individual event to listen for</dd>
    356. 

  356. 				</dl></div>
    357. 

  357. 

  358. 				<h4>Returns</h4>
    359. 

  359. 				<div class="list">
    360. 

  360. 					<code>struct</code><br>the information for the updated webhook - id integer a unique integer
    361. 

  361. indentifier for the webhook - url string The URL that the event data will be
    362. 

  362. posted to - description string a description of the webhook - events array The
    363. 

  363. message events that will be posted to the hook - events[] string the individual
    364. 

  364. message event (send, hard_bounce, soft_bounce, open, click, spam, unsub, or
    365. 

  365. reject) - created_at string the date and time that the webhook was created as a
    366. 

  366. UTC string in YYYY-MM-DD HH:MM:SS format - last_sent_at string the date and time
    367. 

  367. that the webhook last successfully received events as a UTC string in YYYY-MM-DD
    368. 

  368. HH:MM:SS format - batches_sent integer the number of event batches that have
    369. 

  369. ever been sent to this webhook - events_sent integer the total number of events
    370. 

  370. that have ever been sent to this webhook - last_error string if we've ever
    371. 

  371. gotten an error trying to post to this webhook, the last error that we've seen<br />
    372. 

  372. 				</div>
    373. 

  373. 

  374. 

  375. 

  376. 

  377. 		</div>
    378. 

  378. 		</div></td>
    379. 

  379. 	</tr>
    380. 

  380. 	<tr data-order="delete" id="_delete">
    381. 

  381. 

  382. 		<td class="attributes"><code>
    383. 

  383. 			 public 
    384. 

  384. 			struct
    385. 

  385. 			
    386. 

  386. 			</code>
    387. 

  387. 		</td>
    388. 

  388. 

  389. 		<td class="name"><div>
    390. 

  390. 		<a class="anchor" href="#_delete">#</a>
    391. 

  391. 		<code><a href="source-class-Mandrill_Webhooks.html#95-113" title="Go to source code">delete</a>( <span>integer <var>$id</var></span> )</code>
    392. 

  392. 

  393. 		<div class="description short">
    394. 

  394. 			
    395. 

  395. <p>Delete an existing webhook</p>
    396. 

  396. 

  397. 		</div>
    398. 

  398. 

  399. 		<div class="description detailed hidden">
    400. 

  400. 			
    401. 

  401. <p>Delete an existing webhook</p>
    402. 

  402. 

  403. 

  404. 

  405. 				<h4>Parameters</h4>
    406. 

  406. 				<div class="list"><dl>
    407. 

  407. 					<dt><var>$id</var></dt>
    408. 

  408. 					<dd><code>integer</code><br>$id the unique identifier of a webhook belonging to this account</dd>
    409. 

  409. 				</dl></div>
    410. 

  410. 

  411. 				<h4>Returns</h4>
    412. 

  412. 				<div class="list">
    413. 

  413. 					<code>struct</code><br>the information for the deleted webhook - id integer a unique integer
    414. 

  414. indentifier for the webhook - url string The URL that the event data will be
    415. 

  415. posted to - description string a description of the webhook - events array The
    416. 

  416. message events that will be posted to the hook - events[] string the individual
    417. 

  417. message event (send, hard_bounce, soft_bounce, open, click, spam, unsub, or
    418. 

  418. reject) - created_at string the date and time that the webhook was created as a
    419. 

  419. UTC string in YYYY-MM-DD HH:MM:SS format - last_sent_at string the date and time
    420. 

  420. that the webhook last successfully received events as a UTC string in YYYY-MM-DD
    421. 

  421. HH:MM:SS format - batches_sent integer the number of event batches that have
    422. 

  422. ever been sent to this webhook - events_sent integer the total number of events
    423. 

  423. that have ever been sent to this webhook - last_error string if we've ever
    424. 

  424. gotten an error trying to post to this webhook, the last error that we've seen<br />
    425. 

  425. 				</div>
    426. 

  426. 

  427. 

  428. 

  429. 

  430. 		</div>
    431. 

  431. 		</div></td>
    432. 

  432. 	</tr>
    433. 

  433. 	</table>
    434. 

  434. 

  435. 

  436. 

  437. 

  438. 

  439. 

  440. 

  441. 

  442. 

  443. 

  444. 

  445. 

  446. 

  447. 

  448. 

  449. 

  450. 

  451. 

  452. </div>
    453. 

  453. 

  454. 	<div id="footer">
    455. 

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

  456. 	</div>
    457. 

  457. </div>
    458. 

  458. </div>
    459. 

  459. </body>
    460. 

  460. </html>
    461. 

  461.