elementindex_PHPMailer.html 35 KB

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