PageRenderTime 54ms CodeModel.GetById 27ms RepoModel.GetById 1ms app.codeStats 0ms

/docs/class-Mandrill_Users.html

https://bitbucket.org/davisshaver/mandrill-api-php
HTML | 433 lines | 298 code | 135 blank | 0 comment | 0 complexity | 421441c41a2eb0fd699f2efda310e244 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_Users</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 class="active"><a href="class-Mandrill_Users.html">Mandrill_Users</a></li>
    47. 

  47. 				<li><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_Users</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_Users.html#3-128" title="Go to source code">Mandrill/Users.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_Users.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="info" id="_info">
    161. 

  161. 

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

  163. 			 public 
    164. 

  164. 			struct
    165. 

  165. 			
    166. 

  166. 			</code>
    167. 

  167. 		</td>
    168. 

  168. 

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

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

  171. 		<code><a href="source-class-Mandrill_Users.html#8-88" title="Go to source code">info</a>( )</code>
    172. 

  172. 

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

  174. 			
    175. 

  175. <p>Return the information about the API-connected user</p>
    176. 

  176. 

  177. 		</div>
    178. 

  178. 

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

  180. 			
    181. 

  181. <p>Return the information about the API-connected user</p>
    182. 

  182. 

  183. 

  184. 

  185. 

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

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

  188. 					<code>struct</code><br>the user information including username, key, reputation, quota, and historical
    189. 

  189. sending stats - username string the username of the user (used for SMTP
    190. 

  190. authentication) - created_at string the date and time that the user's Mandrill
    191. 

  191. account was created as a UTC string in YYYY-MM-DD HH:MM:SS format - public_id
    192. 

  192. string a unique, permanent identifier for this user - reputation integer the
    193. 

  193. reputation of the user on a scale from 0 to 100, with 75 generally being a
    194. 

  194. "good" reputation - hourly_quota integer the maximum number of emails Mandrill
    195. 

  195. will deliver for this user each hour. Any emails beyond that will be accepted
    196. 

  196. and queued for later delivery. Users with higher reputations will have higher
    197. 

  197. hourly quotas - backlog integer the number of emails that are queued for
    198. 

  198. delivery due to exceeding your monthly or hourly quotas - stats struct an
    199. 

  199. aggregate summary of the account's sending stats - today struct stats for this
    200. 

  200. user so far today - sent integer the number of emails sent for this user so far
    201. 

  201. today - hard_bounces integer the number of emails hard bounced for this user so
    202. 

  202. far today - soft_bounces integer the number of emails soft bounced for this user
    203. 

  203. so far today - rejects integer the number of emails rejected for sending this
    204. 

  204. user so far today - complaints integer the number of spam complaints for this
    205. 

  205. user so far today - unsubs integer the number of unsubscribes for this user so
    206. 

  206. far today - opens integer the number of times emails have been opened for this
    207. 

  207. user so far today - unique_opens integer the number of unique opens for emails
    208. 

  208. sent for this user so far today - clicks integer the number of URLs that have
    209. 

  209. been clicked for this user so far today - unique_clicks integer the number of
    210. 

  210. unique clicks for emails sent for this user so far today - last<sub>7</sub>_days
    211. 

  211. struct stats for this user in the last 7 days - sent integer the number of
    212. 

  212. emails sent for this user in the last 7 days - hard_bounces integer the number
    213. 

  213. of emails hard bounced for this user in the last 7 days - soft_bounces integer
    214. 

  214. the number of emails soft bounced for this user in the last 7 days - rejects
    215. 

  215. integer the number of emails rejected for sending this user in the last 7 days -
    216. 

  216. complaints integer the number of spam complaints for this user in the last 7
    217. 

  217. days - unsubs integer the number of unsubscribes for this user in the last 7
    218. 

  218. days - opens integer the number of times emails have been opened for this user
    219. 

  219. in the last 7 days - unique_opens integer the number of unique opens for emails
    220. 

  220. sent for this user in the last 7 days - clicks integer the number of URLs that
    221. 

  221. have been clicked for this user in the last 7 days - unique_clicks integer the
    222. 

  222. number of unique clicks for emails sent for this user in the last 7 days -
    223. 

  223. last<sub>30</sub>_days struct stats for this user in the last 30 days - sent
    224. 

  224. integer the number of emails sent for this user in the last 30 days -
    225. 

  225. hard_bounces integer the number of emails hard bounced for this user in the last
    226. 

  226. 30 days - soft_bounces integer the number of emails soft bounced for this user
    227. 

  227. in the last 30 days - rejects integer the number of emails rejected for sending
    228. 

  228. this user in the last 30 days - complaints integer the number of spam complaints
    229. 

  229. for this user in the last 30 days - unsubs integer the number of unsubscribes
    230. 

  230. for this user in the last 30 days - opens integer the number of times emails
    231. 

  231. have been opened for this user in the last 30 days - unique_opens integer the
    232. 

  232. number of unique opens for emails sent for this user in the last 30 days -
    233. 

  233. clicks integer the number of URLs that have been clicked for this user in the
    234. 

  234. last 30 days - unique_clicks integer the number of unique clicks for emails sent
    235. 

  235. for this user in the last 30 days - last<sub>60</sub>_days struct stats for this
    236. 

  236. user in the last 60 days - sent integer the number of emails sent for this user
    237. 

  237. in the last 60 days - hard_bounces integer the number of emails hard bounced for
    238. 

  238. this user in the last 60 days - soft_bounces integer the number of emails soft
    239. 

  239. bounced for this user in the last 60 days - rejects integer the number of emails
    240. 

  240. rejected for sending this user in the last 60 days - complaints integer the
    241. 

  241. number of spam complaints for this user in the last 60 days - unsubs integer the
    242. 

  242. number of unsubscribes for this user in the last 60 days - opens integer the
    243. 

  243. number of times emails have been opened for this user in the last 60 days -
    244. 

  244. unique_opens integer the number of unique opens for emails sent for this user in
    245. 

  245. the last 60 days - clicks integer the number of URLs that have been clicked for
    246. 

  246. this user in the last 60 days - unique_clicks integer the number of unique
    247. 

  247. clicks for emails sent for this user in the last 60 days -
    248. 

  248. last<sub>90</sub>_days struct stats for this user in the last 90 days - sent
    249. 

  249. integer the number of emails sent for this user in the last 90 days -
    250. 

  250. hard_bounces integer the number of emails hard bounced for this user in the last
    251. 

  251. 90 days - soft_bounces integer the number of emails soft bounced for this user
    252. 

  252. in the last 90 days - rejects integer the number of emails rejected for sending
    253. 

  253. this user in the last 90 days - complaints integer the number of spam complaints
    254. 

  254. for this user in the last 90 days - unsubs integer the number of unsubscribes
    255. 

  255. for this user in the last 90 days - opens integer the number of times emails
    256. 

  256. have been opened for this user in the last 90 days - unique_opens integer the
    257. 

  257. number of unique opens for emails sent for this user in the last 90 days -
    258. 

  258. clicks integer the number of URLs that have been clicked for this user in the
    259. 

  259. last 90 days - unique_clicks integer the number of unique clicks for emails sent
    260. 

  260. for this user in the last 90 days - all_time struct stats for the lifetime of
    261. 

  261. the user's account - sent integer the number of emails sent in the lifetime of
    262. 

  262. the user's account - hard_bounces integer the number of emails hard bounced in
    263. 

  263. the lifetime of the user's account - soft_bounces integer the number of emails
    264. 

  264. soft bounced in the lifetime of the user's account - rejects integer the number
    265. 

  265. of emails rejected for sending this user so far today - complaints integer the
    266. 

  266. number of spam complaints in the lifetime of the user's account - unsubs integer
    267. 

  267. the number of unsubscribes in the lifetime of the user's account - opens integer
    268. 

  268. the number of times emails have been opened in the lifetime of the user's
    269. 

  269. account - unique_opens integer the number of unique opens for emails sent in the
    270. 

  270. lifetime of the user's account - clicks integer the number of URLs that have
    271. 

  271. been clicked in the lifetime of the user's account - unique_clicks integer the
    272. 

  272. number of unique clicks for emails sent in the lifetime of the user's account<br />
    273. 

  273. 				</div>
    274. 

  274. 

  275. 

  276. 

  277. 

  278. 		</div>
    279. 

  279. 		</div></td>
    280. 

  280. 	</tr>
    281. 

  281. 	<tr data-order="ping" id="_ping">
    282. 

  282. 

  283. 		<td class="attributes"><code>
    284. 

  284. 			 public 
    285. 

  285. 			string
    286. 

  286. 			
    287. 

  287. 			</code>
    288. 

  288. 		</td>
    289. 

  289. 

  290. 		<td class="name"><div>
    291. 

  291. 		<a class="anchor" href="#_ping">#</a>
    292. 

  292. 		<code><a href="source-class-Mandrill_Users.html#90-97" title="Go to source code">ping</a>( )</code>
    293. 

  293. 

  294. 		<div class="description short">
    295. 

  295. 			
    296. 

  296. <p>Validate an API key and respond to a ping</p>
    297. 

  297. 

  298. 		</div>
    299. 

  299. 

  300. 		<div class="description detailed hidden">
    301. 

  301. 			
    302. 

  302. <p>Validate an API key and respond to a ping</p>
    303. 

  303. 

  304. 

  305. 

  306. 

  307. 				<h4>Returns</h4>
    308. 

  308. 				<div class="list">
    309. 

  309. 					<code>string</code><br>the string "PONG!"<br />
    310. 

  310. 				</div>
    311. 

  311. 

  312. 

  313. 

  314. 

  315. 		</div>
    316. 

  316. 		</div></td>
    317. 

  317. 	</tr>
    318. 

  318. 	<tr data-order="ping2" id="_ping2">
    319. 

  319. 

  320. 		<td class="attributes"><code>
    321. 

  321. 			 public 
    322. 

  322. 			struct
    323. 

  323. 			
    324. 

  324. 			</code>
    325. 

  325. 		</td>
    326. 

  326. 

  327. 		<td class="name"><div>
    328. 

  328. 		<a class="anchor" href="#_ping2">#</a>
    329. 

  329. 		<code><a href="source-class-Mandrill_Users.html#99-106" title="Go to source code">ping2</a>( )</code>
    330. 

  330. 

  331. 		<div class="description short">
    332. 

  332. 			
    333. 

  333. <p>Validate an API key and respond to a ping (anal JSON parser version)</p>
    334. 

  334. 

  335. 		</div>
    336. 

  336. 

  337. 		<div class="description detailed hidden">
    338. 

  338. 			
    339. 

  339. <p>Validate an API key and respond to a ping (anal JSON parser version)</p>
    340. 

  340. 

  341. 

  342. 

  343. 

  344. 				<h4>Returns</h4>
    345. 

  345. 				<div class="list">
    346. 

  346. 					<code>struct</code><br>a struct with one key "PING" with a static value "PONG!"<br />
    347. 

  347. 				</div>
    348. 

  348. 

  349. 

  350. 

  351. 

  352. 		</div>
    353. 

  353. 		</div></td>
    354. 

  354. 	</tr>
    355. 

  355. 	<tr data-order="senders" id="_senders">
    356. 

  356. 

  357. 		<td class="attributes"><code>
    358. 

  358. 			 public 
    359. 

  359. 			array
    360. 

  360. 			
    361. 

  361. 			</code>
    362. 

  362. 		</td>
    363. 

  363. 

  364. 		<td class="name"><div>
    365. 

  365. 		<a class="anchor" href="#_senders">#</a>
    366. 

  366. 		<code><a href="source-class-Mandrill_Users.html#108-126" title="Go to source code">senders</a>( )</code>
    367. 

  367. 

  368. 		<div class="description short">
    369. 

  369. 			
    370. 

  370. <p>Return the senders that have tried to use this account, both verified and
    371. 

  371. unverified</p>
    372. 

  372. 

  373. 		</div>
    374. 

  374. 

  375. 		<div class="description detailed hidden">
    376. 

  376. 			
    377. 

  377. <p>Return the senders that have tried to use this account, both verified and
    378. 

  378. unverified</p>
    379. 

  379. 

  380. 

  381. 

  382. 

  383. 				<h4>Returns</h4>
    384. 

  384. 				<div class="list">
    385. 

  385. 					<code>array</code><br>an array of sender data, one for each sending addresses used by the account -
    386. 

  386. return[] struct the information on each sending address in the account - address
    387. 

  387. string the sender's email address - created_at string the date and time that the
    388. 

  388. sender was first seen by Mandrill as a UTC date string in YYYY-MM-DD HH:MM:SS
    389. 

  389. format - sent integer the total number of messages sent by this sender -
    390. 

  390. hard_bounces integer the total number of hard bounces by messages by this sender
    391. 

  391. - soft_bounces integer the total number of soft bounces by messages by this
    392. 

  392. sender - rejects integer the total number of rejected messages by this sender -
    393. 

  393. complaints integer the total number of spam complaints received for messages by
    394. 

  394. this sender - unsubs integer the total number of unsubscribe requests received
    395. 

  395. for messages by this sender - opens integer the total number of times messages
    396. 

  396. by this sender have been opened - clicks integer the total number of times
    397. 

  397. tracked URLs in messages by this sender have been clicked<br />
    398. 

  398. 				</div>
    399. 

  399. 

  400. 

  401. 

  402. 

  403. 		</div>
    404. 

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

  405. 	</tr>
    406. 

  406. 	</table>
    407. 

  407. 

  408. 

  409. 

  410. 

  411. 

  412. 

  413. 

  414. 

  415. 

  416. 

  417. 

  418. 

  419. 

  420. 

  421. 

  422. 

  423. 

  424. 

  425. </div>
    426. 

  426. 

  427. 	<div id="footer">
    428. 

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

  429. 	</div>
    430. 

  430. </div>
    431. 

  431. </div>
    432. 

  432. </body>
    433. 

  433. </html>
    434. 

  434.