elementindex.html 35 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734
  1. <?xml version="1.0" encoding="iso-8859-1"?>
  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml">
  4. <head>
  5. <!-- template designed by Marco Von Ballmoos -->
  6. <title></title>
  7. <link rel="stylesheet" href="media/stylesheet.css" />
  8. <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
  9. </head>
  10. <body>
  11. <a name="top"></a>
  12. <h2>Full index</h2>
  13. <h3>Package indexes</h3>
  14. <ul>
  15. <li><a href="elementindex_PHPMailer.html">PHPMailer</a></li>
  16. </ul>
  17. <br />
  18. <div class="index-letter-menu">
  19. <a class="index-letter" href="elementindex.html#a">a</a>
  20. <a class="index-letter" href="elementindex.html#b">b</a>
  21. <a class="index-letter" href="elementindex.html#c">c</a>
  22. <a class="index-letter" href="elementindex.html#d">d</a>
  23. <a class="index-letter" href="elementindex.html#e">e</a>
  24. <a class="index-letter" href="elementindex.html#f">f</a>
  25. <a class="index-letter" href="elementindex.html#h">h</a>
  26. <a class="index-letter" href="elementindex.html#i">i</a>
  27. <a class="index-letter" href="elementindex.html#m">m</a>
  28. <a class="index-letter" href="elementindex.html#n">n</a>
  29. <a class="index-letter" href="elementindex.html#p">p</a>
  30. <a class="index-letter" href="elementindex.html#q">q</a>
  31. <a class="index-letter" href="elementindex.html#r">r</a>
  32. <a class="index-letter" href="elementindex.html#s">s</a>
  33. <a class="index-letter" href="elementindex.html#t">t</a>
  34. <a class="index-letter" href="elementindex.html#u">u</a>
  35. <a class="index-letter" href="elementindex.html#v">v</a>
  36. <a class="index-letter" href="elementindex.html#w">w</a>
  37. </div>
  38. <a name="a"></a>
  39. <div class="index-letter-section">
  40. <div style="float: left" class="index-letter-title">a</div>
  41. <div style="float: right"><a href="#top">top</a></div>
  42. <div style="clear: both"></div>
  43. </div>
  44. <dl>
  45. <dt class="field">
  46. <span class="var-title">$AltBody</span>
  47. </dt>
  48. <dd class="index-item-body">
  49. <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$AltBody">PHPMailer::$AltBody</a> in class.phpmailer.php</div>
  50. <div class="index-item-description">Sets the text-only body of the message. This automatically sets the email to multipart/alternative. This body can be read by mail clients that do not have HTML email capability such as mutt. Clients that can read HTML will view the normal Body.</div>
  51. </dd>
  52. <dt class="field">
  53. <span class="method-title">AddAddress</span>
  54. </dt>
  55. <dd class="index-item-body">
  56. <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodAddAddress">PHPMailer::AddAddress()</a> in class.phpmailer.php</div>
  57. <div class="index-item-description">Adds a &quot;To&quot; address.</div>
  58. </dd>
  59. <dt class="field">
  60. <span class="method-title">AddAttachment</span>
  61. </dt>
  62. <dd class="index-item-body">
  63. <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodAddAttachment">PHPMailer::AddAttachment()</a> in class.phpmailer.php</div>
  64. <div class="index-item-description">Adds an attachment from a path on the filesystem.</div>
  65. </dd>
  66. <dt class="field">
  67. <span class="method-title">AddBCC</span>
  68. </dt>
  69. <dd class="index-item-body">
  70. <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodAddBCC">PHPMailer::AddBCC()</a> in class.phpmailer.php</div>
  71. <div class="index-item-description">Adds a &quot;Bcc&quot; address. Note: this function works with the SMTP mailer on win32, not with the &quot;mail&quot; mailer.</div>
  72. </dd>
  73. <dt class="field">
  74. <span class="method-title">AddCC</span>
  75. </dt>
  76. <dd class="index-item-body">
  77. <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodAddCC">PHPMailer::AddCC()</a> in class.phpmailer.php</div>
  78. <div class="index-item-description">Adds a &quot;Cc&quot; address. Note: this function works with the SMTP mailer on win32, not with the &quot;mail&quot; mailer.</div>
  79. </dd>
  80. <dt class="field">
  81. <span class="method-title">AddCustomHeader</span>
  82. </dt>
  83. <dd class="index-item-body">
  84. <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodAddCustomHeader">PHPMailer::AddCustomHeader()</a> in class.phpmailer.php</div>
  85. <div class="index-item-description">Adds a custom header.</div>
  86. </dd>
  87. <dt class="field">
  88. <span class="method-title">AddEmbeddedImage</span>
  89. </dt>
  90. <dd class="index-item-body">
  91. <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodAddEmbeddedImage">PHPMailer::AddEmbeddedImage()</a> in class.phpmailer.php</div>
  92. <div class="index-item-description">Adds an embedded attachment. This can include images, sounds, and just about any other document. Make sure to set the $type to an image type. For JPEG images use &quot;image/jpeg&quot; and for GIF images use &quot;image/gif&quot;.</div>
  93. </dd>
  94. <dt class="field">
  95. <span class="method-title">AddReplyTo</span>
  96. </dt>
  97. <dd class="index-item-body">
  98. <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodAddReplyTo">PHPMailer::AddReplyTo()</a> in class.phpmailer.php</div>
  99. <div class="index-item-description">Adds a &quot;Reply-to&quot; address.</div>
  100. </dd>
  101. <dt class="field">
  102. <span class="method-title">AddStringAttachment</span>
  103. </dt>
  104. <dd class="index-item-body">
  105. <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodAddStringAttachment">PHPMailer::AddStringAttachment()</a> in class.phpmailer.php</div>
  106. <div class="index-item-description">Adds a string or binary attachment (non-filesystem) to the list.</div>
  107. </dd>
  108. <dt class="field">
  109. <span class="method-title">Authenticate</span>
  110. </dt>
  111. <dd class="index-item-body">
  112. <div class="index-item-details"><a href="PHPMailer/SMTP.html#methodAuthenticate">SMTP::Authenticate()</a> in class.smtp.php</div>
  113. <div class="index-item-description">Performs SMTP authentication. Must be run after running the Hello() method. Returns true if successfully authenticated.</div>
  114. </dd>
  115. </dl>
  116. <a name="b"></a>
  117. <div class="index-letter-section">
  118. <div style="float: left" class="index-letter-title">b</div>
  119. <div style="float: right"><a href="#top">top</a></div>
  120. <div style="clear: both"></div>
  121. </div>
  122. <dl>
  123. <dt class="field">
  124. <span class="var-title">$Body</span>
  125. </dt>
  126. <dd class="index-item-body">
  127. <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$Body">PHPMailer::$Body</a> in class.phpmailer.php</div>
  128. <div class="index-item-description">Sets the Body of the message. This can be either an HTML or text body.</div>
  129. </dd>
  130. </dl>
  131. <a name="c"></a>
  132. <div class="index-letter-section">
  133. <div style="float: left" class="index-letter-title">c</div>
  134. <div style="float: right"><a href="#top">top</a></div>
  135. <div style="clear: both"></div>
  136. </div>
  137. <dl>
  138. <dt class="field">
  139. <span class="var-title">$CharSet</span>
  140. </dt>
  141. <dd class="index-item-body">
  142. <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$CharSet">PHPMailer::$CharSet</a> in class.phpmailer.php</div>
  143. <div class="index-item-description">Sets the CharSet of the message.</div>
  144. </dd>
  145. <dt class="field">
  146. <span class="var-title">$ConfirmReadingTo</span>
  147. </dt>
  148. <dd class="index-item-body">
  149. <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$ConfirmReadingTo">PHPMailer::$ConfirmReadingTo</a> in class.phpmailer.php</div>
  150. <div class="index-item-description">Sets the email address that a reading confirmation will be sent.</div>
  151. </dd>
  152. <dt class="field">
  153. <span class="var-title">$ContentType</span>
  154. </dt>
  155. <dd class="index-item-body">
  156. <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$ContentType">PHPMailer::$ContentType</a> in class.phpmailer.php</div>
  157. <div class="index-item-description">Sets the Content-type of the message.</div>
  158. </dd>
  159. <dt class="field">
  160. <span class="var-title">$CRLF</span>
  161. </dt>
  162. <dd class="index-item-body">
  163. <div class="index-item-details"><a href="PHPMailer/SMTP.html#var$CRLF">SMTP::$CRLF</a> in class.smtp.php</div>
  164. <div class="index-item-description">SMTP reply line ending</div>
  165. </dd>
  166. <dt class="field">
  167. <span class="include-title">class.phpmailer.php</span>
  168. </dt>
  169. <dd class="index-item-body">
  170. <div class="index-item-details"><a href="PHPMailer/_class_phpmailer_php.html">class.phpmailer.php</a> in class.phpmailer.php</div>
  171. </dd>
  172. <dt class="field">
  173. <span class="include-title">class.smtp.php</span>
  174. </dt>
  175. <dd class="index-item-body">
  176. <div class="index-item-details"><a href="PHPMailer/_class_smtp_php.html">class.smtp.php</a> in class.smtp.php</div>
  177. </dd>
  178. <dt class="field">
  179. <span class="method-title">ClearAddresses</span>
  180. </dt>
  181. <dd class="index-item-body">
  182. <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodClearAddresses">PHPMailer::ClearAddresses()</a> in class.phpmailer.php</div>
  183. <div class="index-item-description">Clears all recipients assigned in the TO array. Returns void.</div>
  184. </dd>
  185. <dt class="field">
  186. <span class="method-title">ClearAllRecipients</span>
  187. </dt>
  188. <dd class="index-item-body">
  189. <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodClearAllRecipients">PHPMailer::ClearAllRecipients()</a> in class.phpmailer.php</div>
  190. <div class="index-item-description">Clears all recipients assigned in the TO, CC and BCC array. Returns void.</div>
  191. </dd>
  192. <dt class="field">
  193. <span class="method-title">ClearAttachments</span>
  194. </dt>
  195. <dd class="index-item-body">
  196. <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodClearAttachments">PHPMailer::ClearAttachments()</a> in class.phpmailer.php</div>
  197. <div class="index-item-description">Clears all previously set filesystem, string, and binary attachments. Returns void.</div>
  198. </dd>
  199. <dt class="field">
  200. <span class="method-title">ClearBCCs</span>
  201. </dt>
  202. <dd class="index-item-body">
  203. <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodClearBCCs">PHPMailer::ClearBCCs()</a> in class.phpmailer.php</div>
  204. <div class="index-item-description">Clears all recipients assigned in the BCC array. Returns void.</div>
  205. </dd>
  206. <dt class="field">
  207. <span class="method-title">ClearCCs</span>
  208. </dt>
  209. <dd class="index-item-body">
  210. <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodClearCCs">PHPMailer::ClearCCs()</a> in class.phpmailer.php</div>
  211. <div class="index-item-description">Clears all recipients assigned in the CC array. Returns void.</div>
  212. </dd>
  213. <dt class="field">
  214. <span class="method-title">ClearCustomHeaders</span>
  215. </dt>
  216. <dd class="index-item-body">
  217. <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodClearCustomHeaders">PHPMailer::ClearCustomHeaders()</a> in class.phpmailer.php</div>
  218. <div class="index-item-description">Clears all custom headers. Returns void.</div>
  219. </dd>
  220. <dt class="field">
  221. <span class="method-title">ClearReplyTos</span>
  222. </dt>
  223. <dd class="index-item-body">
  224. <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodClearReplyTos">PHPMailer::ClearReplyTos()</a> in class.phpmailer.php</div>
  225. <div class="index-item-description">Clears all recipients assigned in the ReplyTo array. Returns void.</div>
  226. </dd>
  227. <dt class="field">
  228. <span class="method-title">Close</span>
  229. </dt>
  230. <dd class="index-item-body">
  231. <div class="index-item-details"><a href="PHPMailer/SMTP.html#methodClose">SMTP::Close()</a> in class.smtp.php</div>
  232. <div class="index-item-description">Closes the socket and cleans up the state of the class.</div>
  233. </dd>
  234. <dt class="field">
  235. <span class="method-title">Connect</span>
  236. </dt>
  237. <dd class="index-item-body">
  238. <div class="index-item-details"><a href="PHPMailer/SMTP.html#methodConnect">SMTP::Connect()</a> in class.smtp.php</div>
  239. <div class="index-item-description">Connect to the server specified on the port specified.</div>
  240. </dd>
  241. </dl>
  242. <a name="d"></a>
  243. <div class="index-letter-section">
  244. <div style="float: left" class="index-letter-title">d</div>
  245. <div style="float: right"><a href="#top">top</a></div>
  246. <div style="clear: both"></div>
  247. </div>
  248. <dl>
  249. <dt class="field">
  250. <span class="var-title">$do_debug</span>
  251. </dt>
  252. <dd class="index-item-body">
  253. <div class="index-item-details"><a href="PHPMailer/SMTP.html#var$do_debug">SMTP::$do_debug</a> in class.smtp.php</div>
  254. <div class="index-item-description">Sets whether debugging is turned on</div>
  255. </dd>
  256. <dt class="field">
  257. <span class="method-title">Data</span>
  258. </dt>
  259. <dd class="index-item-body">
  260. <div class="index-item-details"><a href="PHPMailer/SMTP.html#methodData">SMTP::Data()</a> in class.smtp.php</div>
  261. <div class="index-item-description">Issues a data command and sends the msg_data to the server</div>
  262. </dd>
  263. </dl>
  264. <a name="e"></a>
  265. <div class="index-letter-section">
  266. <div style="float: left" class="index-letter-title">e</div>
  267. <div style="float: right"><a href="#top">top</a></div>
  268. <div style="clear: both"></div>
  269. </div>
  270. <dl>
  271. <dt class="field">
  272. <span class="var-title">$Encoding</span>
  273. </dt>
  274. <dd class="index-item-body">
  275. <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$Encoding">PHPMailer::$Encoding</a> in class.phpmailer.php</div>
  276. <div class="index-item-description">Sets the Encoding of the message. Options for this are &quot;8bit&quot;, &quot;7bit&quot;, &quot;binary&quot;, &quot;base64&quot;, and &quot;quoted-printable&quot;.</div>
  277. </dd>
  278. <dt class="field">
  279. <span class="var-title">$ErrorInfo</span>
  280. </dt>
  281. <dd class="index-item-body">
  282. <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$ErrorInfo">PHPMailer::$ErrorInfo</a> in class.phpmailer.php</div>
  283. <div class="index-item-description">Holds the most recent mailer error message.</div>
  284. </dd>
  285. <dt class="field">
  286. <span class="method-title">Expand</span>
  287. </dt>
  288. <dd class="index-item-body">
  289. <div class="index-item-details"><a href="PHPMailer/SMTP.html#methodExpand">SMTP::Expand()</a> in class.smtp.php</div>
  290. <div class="index-item-description">Expand takes the name and asks the server to list all the people who are members of the _list_. Expand will return back and array of the result or false if an error occurs.</div>
  291. </dd>
  292. </dl>
  293. <a name="f"></a>
  294. <div class="index-letter-section">
  295. <div style="float: left" class="index-letter-title">f</div>
  296. <div style="float: right"><a href="#top">top</a></div>
  297. <div style="clear: both"></div>
  298. </div>
  299. <dl>
  300. <dt class="field">
  301. <span class="var-title">$From</span>
  302. </dt>
  303. <dd class="index-item-body">
  304. <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$From">PHPMailer::$From</a> in class.phpmailer.php</div>
  305. <div class="index-item-description">Sets the From email address for the message.</div>
  306. </dd>
  307. <dt class="field">
  308. <span class="var-title">$FromName</span>
  309. </dt>
  310. <dd class="index-item-body">
  311. <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$FromName">PHPMailer::$FromName</a> in class.phpmailer.php</div>
  312. <div class="index-item-description">Sets the From name of the message.</div>
  313. </dd>
  314. </dl>
  315. <a name="h"></a>
  316. <div class="index-letter-section">
  317. <div style="float: left" class="index-letter-title">h</div>
  318. <div style="float: right"><a href="#top">top</a></div>
  319. <div style="clear: both"></div>
  320. </div>
  321. <dl>
  322. <dt class="field">
  323. <span class="var-title">$Helo</span>
  324. </dt>
  325. <dd class="index-item-body">
  326. <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$Helo">PHPMailer::$Helo</a> in class.phpmailer.php</div>
  327. <div class="index-item-description">Sets the SMTP HELO of the message (Default is $Hostname).</div>
  328. </dd>
  329. <dt class="field">
  330. <span class="var-title">$Host</span>
  331. </dt>
  332. <dd class="index-item-body">
  333. <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$Host">PHPMailer::$Host</a> in class.phpmailer.php</div>
  334. <div class="index-item-description">Sets the SMTP hosts. All hosts must be separated by a semicolon. You can also specify a different port for each host by using this format: [hostname:port] (e.g. &quot;smtp1.example.com:25;smtp2.example.com&quot;).</div>
  335. </dd>
  336. <dt class="field">
  337. <span class="var-title">$Hostname</span>
  338. </dt>
  339. <dd class="index-item-body">
  340. <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$Hostname">PHPMailer::$Hostname</a> in class.phpmailer.php</div>
  341. <div class="index-item-description">Sets the hostname to use in Message-Id and Received headers and as default HELO string. If empty, the value returned by SERVER_NAME is used or 'localhost.localdomain'.</div>
  342. </dd>
  343. <dt class="field">
  344. <span class="method-title">Hello</span>
  345. </dt>
  346. <dd class="index-item-body">
  347. <div class="index-item-details"><a href="PHPMailer/SMTP.html#methodHello">SMTP::Hello()</a> in class.smtp.php</div>
  348. <div class="index-item-description">Sends the HELO command to the smtp server.</div>
  349. </dd>
  350. <dt class="field">
  351. <span class="method-title">Help</span>
  352. </dt>
  353. <dd class="index-item-body">
  354. <div class="index-item-details"><a href="PHPMailer/SMTP.html#methodHelp">SMTP::Help()</a> in class.smtp.php</div>
  355. <div class="index-item-description">Gets help information on the keyword specified. If the keyword</div>
  356. </dd>
  357. </dl>
  358. <a name="i"></a>
  359. <div class="index-letter-section">
  360. <div style="float: left" class="index-letter-title">i</div>
  361. <div style="float: right"><a href="#top">top</a></div>
  362. <div style="clear: both"></div>
  363. </div>
  364. <dl>
  365. <dt class="field">
  366. <span class="method-title">IsError</span>
  367. </dt>
  368. <dd class="index-item-body">
  369. <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodIsError">PHPMailer::IsError()</a> in class.phpmailer.php</div>
  370. <div class="index-item-description">Returns true if an error occurred.</div>
  371. </dd>
  372. <dt class="field">
  373. <span class="method-title">IsHTML</span>
  374. </dt>
  375. <dd class="index-item-body">
  376. <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodIsHTML">PHPMailer::IsHTML()</a> in class.phpmailer.php</div>
  377. <div class="index-item-description">Sets message type to HTML.</div>
  378. </dd>
  379. <dt class="field">
  380. <span class="method-title">IsMail</span>
  381. </dt>
  382. <dd class="index-item-body">
  383. <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodIsMail">PHPMailer::IsMail()</a> in class.phpmailer.php</div>
  384. <div class="index-item-description">Sets Mailer to send message using PHP mail() function.</div>
  385. </dd>
  386. <dt class="field">
  387. <span class="method-title">IsQmail</span>
  388. </dt>
  389. <dd class="index-item-body">
  390. <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodIsQmail">PHPMailer::IsQmail()</a> in class.phpmailer.php</div>
  391. <div class="index-item-description">Sets Mailer to send message using the qmail MTA.</div>
  392. </dd>
  393. <dt class="field">
  394. <span class="method-title">IsSendmail</span>
  395. </dt>
  396. <dd class="index-item-body">
  397. <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodIsSendmail">PHPMailer::IsSendmail()</a> in class.phpmailer.php</div>
  398. <div class="index-item-description">Sets Mailer to send message using the $Sendmail program.</div>
  399. </dd>
  400. <dt class="field">
  401. <span class="method-title">IsSMTP</span>
  402. </dt>
  403. <dd class="index-item-body">
  404. <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodIsSMTP">PHPMailer::IsSMTP()</a> in class.phpmailer.php</div>
  405. <div class="index-item-description">Sets Mailer to send message using SMTP.</div>
  406. </dd>
  407. </dl>
  408. <a name="m"></a>
  409. <div class="index-letter-section">
  410. <div style="float: left" class="index-letter-title">m</div>
  411. <div style="float: right"><a href="#top">top</a></div>
  412. <div style="clear: both"></div>
  413. </div>
  414. <dl>
  415. <dt class="field">
  416. <span class="var-title">$Mailer</span>
  417. </dt>
  418. <dd class="index-item-body">
  419. <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$Mailer">PHPMailer::$Mailer</a> in class.phpmailer.php</div>
  420. <div class="index-item-description">Method to send mail: (&quot;mail&quot;, &quot;sendmail&quot;, or &quot;smtp&quot;).</div>
  421. </dd>
  422. <dt class="field">
  423. <span class="method-title">Mail</span>
  424. </dt>
  425. <dd class="index-item-body">
  426. <div class="index-item-details"><a href="PHPMailer/SMTP.html#methodMail">SMTP::Mail()</a> in class.smtp.php</div>
  427. <div class="index-item-description">Starts a mail transaction from the email address specified in $from. Returns true if successful or false otherwise. If True the mail transaction is started and then one or more Recipient commands may be called followed by a Data command.</div>
  428. </dd>
  429. </dl>
  430. <a name="n"></a>
  431. <div class="index-letter-section">
  432. <div style="float: left" class="index-letter-title">n</div>
  433. <div style="float: right"><a href="#top">top</a></div>
  434. <div style="clear: both"></div>
  435. </div>
  436. <dl>
  437. <dt class="field">
  438. <span class="method-title">Noop</span>
  439. </dt>
  440. <dd class="index-item-body">
  441. <div class="index-item-details"><a href="PHPMailer/SMTP.html#methodNoop">SMTP::Noop()</a> in class.smtp.php</div>
  442. <div class="index-item-description">Sends the command NOOP to the SMTP server.</div>
  443. </dd>
  444. </dl>
  445. <a name="p"></a>
  446. <div class="index-letter-section">
  447. <div style="float: left" class="index-letter-title">p</div>
  448. <div style="float: right"><a href="#top">top</a></div>
  449. <div style="clear: both"></div>
  450. </div>
  451. <dl>
  452. <dt class="field">
  453. <span class="var-title">$Password</span>
  454. </dt>
  455. <dd class="index-item-body">
  456. <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$Password">PHPMailer::$Password</a> in class.phpmailer.php</div>
  457. <div class="index-item-description">Sets SMTP password.</div>
  458. </dd>
  459. <dt class="field">
  460. <span class="var-title">$PluginDir</span>
  461. </dt>
  462. <dd class="index-item-body">
  463. <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$PluginDir">PHPMailer::$PluginDir</a> in class.phpmailer.php</div>
  464. <div class="index-item-description">Path to PHPMailer plugins. This is now only useful if the SMTP class is in a different directory than the PHP include path.</div>
  465. </dd>
  466. <dt class="field">
  467. <span class="var-title">$Port</span>
  468. </dt>
  469. <dd class="index-item-body">
  470. <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$Port">PHPMailer::$Port</a> in class.phpmailer.php</div>
  471. <div class="index-item-description">Sets the default SMTP server port.</div>
  472. </dd>
  473. <dt class="field">
  474. <span class="var-title">$Priority</span>
  475. </dt>
  476. <dd class="index-item-body">
  477. <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$Priority">PHPMailer::$Priority</a> in class.phpmailer.php</div>
  478. <div class="index-item-description">Email priority (1 = High, 3 = Normal, 5 = low).</div>
  479. </dd>
  480. <dt class="field">
  481. PHPMailer
  482. </dt>
  483. <dd class="index-item-body">
  484. <div class="index-item-details"><a href="PHPMailer/PHPMailer.html">PHPMailer</a> in class.phpmailer.php</div>
  485. <div class="index-item-description">PHPMailer - PHP email transport class</div>
  486. </dd>
  487. </dl>
  488. <a name="q"></a>
  489. <div class="index-letter-section">
  490. <div style="float: left" class="index-letter-title">q</div>
  491. <div style="float: right"><a href="#top">top</a></div>
  492. <div style="clear: both"></div>
  493. </div>
  494. <dl>
  495. <dt class="field">
  496. <span class="method-title">Quit</span>
  497. </dt>
  498. <dd class="index-item-body">
  499. <div class="index-item-details"><a href="PHPMailer/SMTP.html#methodQuit">SMTP::Quit()</a> in class.smtp.php</div>
  500. <div class="index-item-description">Sends the quit command to the server and then closes the socket if there is no error or the $close_on_error argument is true.</div>
  501. </dd>
  502. </dl>
  503. <a name="r"></a>
  504. <div class="index-letter-section">
  505. <div style="float: left" class="index-letter-title">r</div>
  506. <div style="float: right"><a href="#top">top</a></div>
  507. <div style="clear: both"></div>
  508. </div>
  509. <dl>
  510. <dt class="field">
  511. <span class="method-title">Recipient</span>
  512. </dt>
  513. <dd class="index-item-body">
  514. <div class="index-item-details"><a href="PHPMailer/SMTP.html#methodRecipient">SMTP::Recipient()</a> in class.smtp.php</div>
  515. <div class="index-item-description">Sends the command RCPT to the SMTP server with the TO: argument of $to.</div>
  516. </dd>
  517. <dt class="field">
  518. <span class="method-title">Reset</span>
  519. </dt>
  520. <dd class="index-item-body">
  521. <div class="index-item-details"><a href="PHPMailer/SMTP.html#methodReset">SMTP::Reset()</a> in class.smtp.php</div>
  522. <div class="index-item-description">Sends the RSET command to abort and transaction that is currently in progress. Returns true if successful false otherwise.</div>
  523. </dd>
  524. </dl>
  525. <a name="s"></a>
  526. <div class="index-letter-section">
  527. <div style="float: left" class="index-letter-title">s</div>
  528. <div style="float: right"><a href="#top">top</a></div>
  529. <div style="clear: both"></div>
  530. </div>
  531. <dl>
  532. <dt class="field">
  533. <span class="var-title">$Sender</span>
  534. </dt>
  535. <dd class="index-item-body">
  536. <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$Sender">PHPMailer::$Sender</a> in class.phpmailer.php</div>
  537. <div class="index-item-description">Sets the Sender email (Return-Path) of the message. If not empty, will be sent via -f to sendmail or as 'MAIL FROM' in smtp mode.</div>
  538. </dd>
  539. <dt class="field">
  540. <span class="var-title">$Sendmail</span>
  541. </dt>
  542. <dd class="index-item-body">
  543. <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$Sendmail">PHPMailer::$Sendmail</a> in class.phpmailer.php</div>
  544. <div class="index-item-description">Sets the path of the sendmail program.</div>
  545. </dd>
  546. <dt class="field">
  547. <span class="var-title">$SMTPAuth</span>
  548. </dt>
  549. <dd class="index-item-body">
  550. <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$SMTPAuth">PHPMailer::$SMTPAuth</a> in class.phpmailer.php</div>
  551. <div class="index-item-description">Sets SMTP authentication. Utilizes the Username and Password variables.</div>
  552. </dd>
  553. <dt class="field">
  554. <span class="var-title">$SMTPDebug</span>
  555. </dt>
  556. <dd class="index-item-body">
  557. <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$SMTPDebug">PHPMailer::$SMTPDebug</a> in class.phpmailer.php</div>
  558. <div class="index-item-description">Sets SMTP class debugging on or off.</div>
  559. </dd>
  560. <dt class="field">
  561. <span class="var-title">$SMTPKeepAlive</span>
  562. </dt>
  563. <dd class="index-item-body">
  564. <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$SMTPKeepAlive">PHPMailer::$SMTPKeepAlive</a> in class.phpmailer.php</div>
  565. <div class="index-item-description">Prevents the SMTP connection from being closed after each mail sending. If this is set to true then to close the connection requires an explicit call to SmtpClose().</div>
  566. </dd>
  567. <dt class="field">
  568. <span class="var-title">$SMTP_PORT</span>
  569. </dt>
  570. <dd class="index-item-body">
  571. <div class="index-item-details"><a href="PHPMailer/SMTP.html#var$SMTP_PORT">SMTP::$SMTP_PORT</a> in class.smtp.php</div>
  572. <div class="index-item-description">SMTP server port</div>
  573. </dd>
  574. <dt class="field">
  575. <span class="var-title">$Subject</span>
  576. </dt>
  577. <dd class="index-item-body">
  578. <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$Subject">PHPMailer::$Subject</a> in class.phpmailer.php</div>
  579. <div class="index-item-description">Sets the Subject of the message.</div>
  580. </dd>
  581. <dt class="field">
  582. <span class="method-title">Send</span>
  583. </dt>
  584. <dd class="index-item-body">
  585. <div class="index-item-details"><a href="PHPMailer/SMTP.html#methodSend">SMTP::Send()</a> in class.smtp.php</div>
  586. <div class="index-item-description">Starts a mail transaction from the email address specified in</div>
  587. </dd>
  588. <dt class="field">
  589. <span class="method-title">Send</span>
  590. </dt>
  591. <dd class="index-item-body">
  592. <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodSend">PHPMailer::Send()</a> in class.phpmailer.php</div>
  593. <div class="index-item-description">Creates message and assigns Mailer. If the message is not sent successfully then it returns false. Use the ErrorInfo variable to view description of the error.</div>
  594. </dd>
  595. <dt class="field">
  596. <span class="method-title">SendAndMail</span>
  597. </dt>
  598. <dd class="index-item-body">
  599. <div class="index-item-details"><a href="PHPMailer/SMTP.html#methodSendAndMail">SMTP::SendAndMail()</a> in class.smtp.php</div>
  600. <div class="index-item-description">Starts a mail transaction from the email address specified in</div>
  601. </dd>
  602. <dt class="field">
  603. <span class="method-title">SendOrMail</span>
  604. </dt>
  605. <dd class="index-item-body">
  606. <div class="index-item-details"><a href="PHPMailer/SMTP.html#methodSendOrMail">SMTP::SendOrMail()</a> in class.smtp.php</div>
  607. <div class="index-item-description">Starts a mail transaction from the email address specified in</div>
  608. </dd>
  609. <dt class="field">
  610. <span class="method-title">SetLanguage</span>
  611. </dt>
  612. <dd class="index-item-body">
  613. <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodSetLanguage">PHPMailer::SetLanguage()</a> in class.phpmailer.php</div>
  614. <div class="index-item-description">Sets the language for all class error messages. Returns false if it cannot load the language file. The default language type is English.</div>
  615. </dd>
  616. <dt class="field">
  617. <span class="method-title">SMTP</span>
  618. </dt>
  619. <dd class="index-item-body">
  620. <div class="index-item-details"><a href="PHPMailer/SMTP.html#methodSMTP">SMTP::SMTP()</a> in class.smtp.php</div>
  621. <div class="index-item-description">Initialize the class so that the data is in a known state.</div>
  622. </dd>
  623. <dt class="field">
  624. SMTP
  625. </dt>
  626. <dd class="index-item-body">
  627. <div class="index-item-details"><a href="PHPMailer/SMTP.html">SMTP</a> in class.smtp.php</div>
  628. <div class="index-item-description">SMTP is rfc 821 compliant and implements all the rfc 821 SMTP commands except TURN which will always return a not implemented error. SMTP also provides some utility methods for sending mail to an SMTP server.</div>
  629. </dd>
  630. <dt class="field">
  631. <span class="method-title">SmtpClose</span>
  632. </dt>
  633. <dd class="index-item-body">
  634. <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#methodSmtpClose">PHPMailer::SmtpClose()</a> in class.phpmailer.php</div>
  635. <div class="index-item-description">Closes the active SMTP session if one exists.</div>
  636. </dd>
  637. </dl>
  638. <a name="t"></a>
  639. <div class="index-letter-section">
  640. <div style="float: left" class="index-letter-title">t</div>
  641. <div style="float: right"><a href="#top">top</a></div>
  642. <div style="clear: both"></div>
  643. </div>
  644. <dl>
  645. <dt class="field">
  646. <span class="var-title">$Timeout</span>
  647. </dt>
  648. <dd class="index-item-body">
  649. <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$Timeout">PHPMailer::$Timeout</a> in class.phpmailer.php</div>
  650. <div class="index-item-description">Sets the SMTP server timeout in seconds. This function will not work with the win32 version.</div>
  651. </dd>
  652. <dt class="field">
  653. <span class="method-title">Turn</span>
  654. </dt>
  655. <dd class="index-item-body">
  656. <div class="index-item-details"><a href="PHPMailer/SMTP.html#methodTurn">SMTP::Turn()</a> in class.smtp.php</div>
  657. <div class="index-item-description">This is an optional command for SMTP that this class does not support. This method is here to make the RFC821 Definition complete for this class and __may__ be implimented in the future</div>
  658. </dd>
  659. </dl>
  660. <a name="u"></a>
  661. <div class="index-letter-section">
  662. <div style="float: left" class="index-letter-title">u</div>
  663. <div style="float: right"><a href="#top">top</a></div>
  664. <div style="clear: both"></div>
  665. </div>
  666. <dl>
  667. <dt class="field">
  668. <span class="var-title">$Username</span>
  669. </dt>
  670. <dd class="index-item-body">
  671. <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$Username">PHPMailer::$Username</a> in class.phpmailer.php</div>
  672. <div class="index-item-description">Sets SMTP username.</div>
  673. </dd>
  674. </dl>
  675. <a name="v"></a>
  676. <div class="index-letter-section">
  677. <div style="float: left" class="index-letter-title">v</div>
  678. <div style="float: right"><a href="#top">top</a></div>
  679. <div style="clear: both"></div>
  680. </div>
  681. <dl>
  682. <dt class="field">
  683. <span class="var-title">$Version</span>
  684. </dt>
  685. <dd class="index-item-body">
  686. <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$Version">PHPMailer::$Version</a> in class.phpmailer.php</div>
  687. <div class="index-item-description">Holds PHPMailer version.</div>
  688. </dd>
  689. <dt class="field">
  690. <span class="method-title">Verify</span>
  691. </dt>
  692. <dd class="index-item-body">
  693. <div class="index-item-details"><a href="PHPMailer/SMTP.html#methodVerify">SMTP::Verify()</a> in class.smtp.php</div>
  694. <div class="index-item-description">Verifies that the name is recognized by the server.</div>
  695. </dd>
  696. </dl>
  697. <a name="w"></a>
  698. <div class="index-letter-section">
  699. <div style="float: left" class="index-letter-title">w</div>
  700. <div style="float: right"><a href="#top">top</a></div>
  701. <div style="clear: both"></div>
  702. </div>
  703. <dl>
  704. <dt class="field">
  705. <span class="var-title">$WordWrap</span>
  706. </dt>
  707. <dd class="index-item-body">
  708. <div class="index-item-details"><a href="PHPMailer/PHPMailer.html#var$WordWrap">PHPMailer::$WordWrap</a> in class.phpmailer.php</div>
  709. <div class="index-item-description">Sets word wrapping on the body of the message to a given number of characters.</div>
  710. </dd>
  711. </dl>
  712. <div class="index-letter-menu">
  713. <a class="index-letter" href="elementindex.html#a">a</a>
  714. <a class="index-letter" href="elementindex.html#b">b</a>
  715. <a class="index-letter" href="elementindex.html#c">c</a>
  716. <a class="index-letter" href="elementindex.html#d">d</a>
  717. <a class="index-letter" href="elementindex.html#e">e</a>
  718. <a class="index-letter" href="elementindex.html#f">f</a>
  719. <a class="index-letter" href="elementindex.html#h">h</a>
  720. <a class="index-letter" href="elementindex.html#i">i</a>
  721. <a class="index-letter" href="elementindex.html#m">m</a>
  722. <a class="index-letter" href="elementindex.html#n">n</a>
  723. <a class="index-letter" href="elementindex.html#p">p</a>
  724. <a class="index-letter" href="elementindex.html#q">q</a>
  725. <a class="index-letter" href="elementindex.html#r">r</a>
  726. <a class="index-letter" href="elementindex.html#s">s</a>
  727. <a class="index-letter" href="elementindex.html#t">t</a>
  728. <a class="index-letter" href="elementindex.html#u">u</a>
  729. <a class="index-letter" href="elementindex.html#v">v</a>
  730. <a class="index-letter" href="elementindex.html#w">w</a>
  731. </div> </body>
  732. </html>