51ff3226 |
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>Docs For Class PHPMailer</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 | <div class="page-body"> |
12 | <h2 class="class-name">Class PHPMailer</h2> |
13 | |
14 | <a name="sec-description"></a> |
15 | <div class="info-box"> |
16 | <div class="info-box-title">Description</div> |
17 | <div class="nav-bar"> |
18 | <span class="disabled">Description</span> | |
19 | <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
20 | | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
21 | |
22 | </div> |
23 | <div class="info-box-body"> |
24 | <!-- ========== Info from phpDoc block ========= --> |
25 | <p class="short-description">PHPMailer - PHP email transport class</p> |
26 | <ul class="tags"> |
27 | <li><span class="field">copyright:</span> <p>2001 - 2003 Brent R. Matzelle</p></li> |
28 | <li><span class="field">author:</span> <p>Brent R. Matzelle</p></li> |
29 | </ul> |
30 | <p class="notes"> |
31 | Located in <a class="field" href="_class_phpmailer_php.html">Program_Root/class.phpmailer.php</a> (line <span class="field">20</span>) |
32 | </p> |
33 | |
34 | |
35 | <pre></pre> |
36 | |
37 | </div> |
38 | </div> |
39 | |
40 | |
41 | <a name="sec-var-summary"></a> |
42 | <div class="info-box"> |
43 | <div class="info-box-title">Variable Summary</span></div> |
44 | <div class="nav-bar"> |
45 | <a href="#sec-description">Description</a> | |
46 | <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>) |
47 | | |
48 | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
49 | |
50 | </div> |
51 | <div class="info-box-body"> |
52 | <div class="var-summary"> |
53 | <div class="var-title"> |
54 | <span class="var-type">string</span> |
55 | <a href="#$AltBody" title="details" class="var-name">$AltBody</a> |
56 | </div> |
57 | <div class="var-title"> |
58 | <span class="var-type">string</span> |
59 | <a href="#$Body" title="details" class="var-name">$Body</a> |
60 | </div> |
61 | <div class="var-title"> |
62 | <span class="var-type">string</span> |
63 | <a href="#$CharSet" title="details" class="var-name">$CharSet</a> |
64 | </div> |
65 | <div class="var-title"> |
66 | <span class="var-type">string</span> |
67 | <a href="#$ConfirmReadingTo" title="details" class="var-name">$ConfirmReadingTo</a> |
68 | </div> |
69 | <div class="var-title"> |
70 | <span class="var-type">string</span> |
71 | <a href="#$ContentType" title="details" class="var-name">$ContentType</a> |
72 | </div> |
73 | <div class="var-title"> |
74 | <span class="var-type">string</span> |
75 | <a href="#$Encoding" title="details" class="var-name">$Encoding</a> |
76 | </div> |
77 | <div class="var-title"> |
78 | <span class="var-type">string</span> |
79 | <a href="#$ErrorInfo" title="details" class="var-name">$ErrorInfo</a> |
80 | </div> |
81 | <div class="var-title"> |
82 | <span class="var-type">string</span> |
83 | <a href="#$From" title="details" class="var-name">$From</a> |
84 | </div> |
85 | <div class="var-title"> |
86 | <span class="var-type">string</span> |
87 | <a href="#$FromName" title="details" class="var-name">$FromName</a> |
88 | </div> |
89 | <div class="var-title"> |
90 | <span class="var-type">string</span> |
91 | <a href="#$Helo" title="details" class="var-name">$Helo</a> |
92 | </div> |
93 | <div class="var-title"> |
94 | <span class="var-type">string</span> |
95 | <a href="#$Host" title="details" class="var-name">$Host</a> |
96 | </div> |
97 | <div class="var-title"> |
98 | <span class="var-type">string</span> |
99 | <a href="#$Hostname" title="details" class="var-name">$Hostname</a> |
100 | </div> |
101 | <div class="var-title"> |
102 | <span class="var-type">string</span> |
103 | <a href="#$Mailer" title="details" class="var-name">$Mailer</a> |
104 | </div> |
105 | <div class="var-title"> |
106 | <span class="var-type">string</span> |
107 | <a href="#$Password" title="details" class="var-name">$Password</a> |
108 | </div> |
109 | <div class="var-title"> |
110 | <span class="var-type">string</span> |
111 | <a href="#$PluginDir" title="details" class="var-name">$PluginDir</a> |
112 | </div> |
113 | <div class="var-title"> |
114 | <span class="var-type">int</span> |
115 | <a href="#$Port" title="details" class="var-name">$Port</a> |
116 | </div> |
117 | <div class="var-title"> |
118 | <span class="var-type">int</span> |
119 | <a href="#$Priority" title="details" class="var-name">$Priority</a> |
120 | </div> |
121 | <div class="var-title"> |
122 | <span class="var-type">string</span> |
123 | <a href="#$Sender" title="details" class="var-name">$Sender</a> |
124 | </div> |
125 | <div class="var-title"> |
126 | <span class="var-type">string</span> |
127 | <a href="#$Sendmail" title="details" class="var-name">$Sendmail</a> |
128 | </div> |
129 | <div class="var-title"> |
130 | <span class="var-type">bool</span> |
131 | <a href="#$SMTPAuth" title="details" class="var-name">$SMTPAuth</a> |
132 | </div> |
133 | <div class="var-title"> |
134 | <span class="var-type">bool</span> |
135 | <a href="#$SMTPDebug" title="details" class="var-name">$SMTPDebug</a> |
136 | </div> |
137 | <div class="var-title"> |
138 | <span class="var-type">bool</span> |
139 | <a href="#$SMTPKeepAlive" title="details" class="var-name">$SMTPKeepAlive</a> |
140 | </div> |
141 | <div class="var-title"> |
142 | <span class="var-type">string</span> |
143 | <a href="#$Subject" title="details" class="var-name">$Subject</a> |
144 | </div> |
145 | <div class="var-title"> |
146 | <span class="var-type">int</span> |
147 | <a href="#$Timeout" title="details" class="var-name">$Timeout</a> |
148 | </div> |
149 | <div class="var-title"> |
150 | <span class="var-type">string</span> |
151 | <a href="#$Username" title="details" class="var-name">$Username</a> |
152 | </div> |
153 | <div class="var-title"> |
154 | <span class="var-type">string</span> |
155 | <a href="#$Version" title="details" class="var-name">$Version</a> |
156 | </div> |
157 | <div class="var-title"> |
158 | <span class="var-type">int</span> |
159 | <a href="#$WordWrap" title="details" class="var-name">$WordWrap</a> |
160 | </div> |
161 | </div> |
162 | </div> |
163 | </div> |
164 | |
165 | <a name="sec-method-summary"></a> |
166 | <div class="info-box"> |
167 | <div class="info-box-title">Method Summary</span></div> |
168 | <div class="nav-bar"> |
169 | <a href="#sec-description">Description</a> | |
170 | <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
171 | |
172 | | |
173 | <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>) |
174 | </div> |
175 | <div class="info-box-body"> |
176 | <div class="method-summary"> |
177 | |
178 | <div class="method-definition"> |
179 | <span class="method-result">void</span> |
180 | <a href="#AddAddress" title="details" class="method-name">AddAddress</a> |
181 | (<span class="var-type">string</span> <span class="var-name">$address</span>, [<span class="var-type">string</span> <span class="var-name">$name</span> = <span class="var-default">""</span>]) |
182 | </div> |
183 | |
184 | <div class="method-definition"> |
185 | <span class="method-result">bool</span> |
186 | <a href="#AddAttachment" title="details" class="method-name">AddAttachment</a> |
187 | (<span class="var-type">string</span> <span class="var-name">$path</span>, [<span class="var-type">string</span> <span class="var-name">$name</span> = <span class="var-default">""</span>], [<span class="var-type">string</span> <span class="var-name">$encoding</span> = <span class="var-default">"base64"</span>], [<span class="var-type">string</span> <span class="var-name">$type</span> = <span class="var-default">"application/octet-stream"</span>]) |
188 | </div> |
189 | |
190 | <div class="method-definition"> |
191 | <span class="method-result">void</span> |
192 | <a href="#AddBCC" title="details" class="method-name">AddBCC</a> |
193 | (<span class="var-type">string</span> <span class="var-name">$address</span>, [<span class="var-type">string</span> <span class="var-name">$name</span> = <span class="var-default">""</span>]) |
194 | </div> |
195 | |
196 | <div class="method-definition"> |
197 | <span class="method-result">void</span> |
198 | <a href="#AddCC" title="details" class="method-name">AddCC</a> |
199 | (<span class="var-type">string</span> <span class="var-name">$address</span>, [<span class="var-type">string</span> <span class="var-name">$name</span> = <span class="var-default">""</span>]) |
200 | </div> |
201 | |
202 | <div class="method-definition"> |
203 | <span class="method-result">void</span> |
204 | <a href="#AddCustomHeader" title="details" class="method-name">AddCustomHeader</a> |
205 | (<span class="var-type">mixed</span> <span class="var-name">$custom_header</span>) |
206 | </div> |
207 | |
208 | <div class="method-definition"> |
209 | <span class="method-result">bool</span> |
210 | <a href="#AddEmbeddedImage" title="details" class="method-name">AddEmbeddedImage</a> |
211 | (<span class="var-type">string</span> <span class="var-name">$path</span>, <span class="var-type">string</span> <span class="var-name">$cid</span>, [<span class="var-type">string</span> <span class="var-name">$name</span> = <span class="var-default">""</span>], [<span class="var-type">string</span> <span class="var-name">$encoding</span> = <span class="var-default">"base64"</span>], [<span class="var-type">string</span> <span class="var-name">$type</span> = <span class="var-default">"application/octet-stream"</span>]) |
212 | </div> |
213 | |
214 | <div class="method-definition"> |
215 | <span class="method-result">void</span> |
216 | <a href="#AddReplyTo" title="details" class="method-name">AddReplyTo</a> |
217 | (<span class="var-type">string</span> <span class="var-name">$address</span>, [<span class="var-type">string</span> <span class="var-name">$name</span> = <span class="var-default">""</span>]) |
218 | </div> |
219 | |
220 | <div class="method-definition"> |
221 | <span class="method-result">void</span> |
222 | <a href="#AddStringAttachment" title="details" class="method-name">AddStringAttachment</a> |
223 | (<span class="var-type">string</span> <span class="var-name">$string</span>, <span class="var-type">string</span> <span class="var-name">$filename</span>, [<span class="var-type">string</span> <span class="var-name">$encoding</span> = <span class="var-default">"base64"</span>], [<span class="var-type">string</span> <span class="var-name">$type</span> = <span class="var-default">"application/octet-stream"</span>]) |
224 | </div> |
225 | |
226 | <div class="method-definition"> |
227 | <span class="method-result">void</span> |
228 | <a href="#ClearAddresses" title="details" class="method-name">ClearAddresses</a> |
229 | () |
230 | </div> |
231 | |
232 | <div class="method-definition"> |
233 | <span class="method-result">void</span> |
234 | <a href="#ClearAllRecipients" title="details" class="method-name">ClearAllRecipients</a> |
235 | () |
236 | </div> |
237 | |
238 | <div class="method-definition"> |
239 | <span class="method-result">void</span> |
240 | <a href="#ClearAttachments" title="details" class="method-name">ClearAttachments</a> |
241 | () |
242 | </div> |
243 | |
244 | <div class="method-definition"> |
245 | <span class="method-result">void</span> |
246 | <a href="#ClearBCCs" title="details" class="method-name">ClearBCCs</a> |
247 | () |
248 | </div> |
249 | |
250 | <div class="method-definition"> |
251 | <span class="method-result">void</span> |
252 | <a href="#ClearCCs" title="details" class="method-name">ClearCCs</a> |
253 | () |
254 | </div> |
255 | |
256 | <div class="method-definition"> |
257 | <span class="method-result">void</span> |
258 | <a href="#ClearCustomHeaders" title="details" class="method-name">ClearCustomHeaders</a> |
259 | () |
260 | </div> |
261 | |
262 | <div class="method-definition"> |
263 | <span class="method-result">void</span> |
264 | <a href="#ClearReplyTos" title="details" class="method-name">ClearReplyTos</a> |
265 | () |
266 | </div> |
267 | |
268 | <div class="method-definition"> |
269 | <span class="method-result">bool</span> |
270 | <a href="#IsError" title="details" class="method-name">IsError</a> |
271 | () |
272 | </div> |
273 | |
274 | <div class="method-definition"> |
275 | <span class="method-result">void</span> |
276 | <a href="#IsHTML" title="details" class="method-name">IsHTML</a> |
277 | (<span class="var-type">bool</span> <span class="var-name">$bool</span>) |
278 | </div> |
279 | |
280 | <div class="method-definition"> |
281 | <span class="method-result">void</span> |
282 | <a href="#IsMail" title="details" class="method-name">IsMail</a> |
283 | () |
284 | </div> |
285 | |
286 | <div class="method-definition"> |
287 | <span class="method-result">void</span> |
288 | <a href="#IsQmail" title="details" class="method-name">IsQmail</a> |
289 | () |
290 | </div> |
291 | |
292 | <div class="method-definition"> |
293 | <span class="method-result">void</span> |
294 | <a href="#IsSendmail" title="details" class="method-name">IsSendmail</a> |
295 | () |
296 | </div> |
297 | |
298 | <div class="method-definition"> |
299 | <span class="method-result">void</span> |
300 | <a href="#IsSMTP" title="details" class="method-name">IsSMTP</a> |
301 | () |
302 | </div> |
303 | |
304 | <div class="method-definition"> |
305 | <span class="method-result">bool</span> |
306 | <a href="#Send" title="details" class="method-name">Send</a> |
307 | () |
308 | </div> |
309 | |
310 | <div class="method-definition"> |
311 | <span class="method-result">bool</span> |
312 | <a href="#SetLanguage" title="details" class="method-name">SetLanguage</a> |
313 | (<span class="var-type">string</span> <span class="var-name">$lang_type</span>, [<span class="var-type">string</span> <span class="var-name">$lang_path</span> = <span class="var-default">""</span>]) |
314 | </div> |
315 | |
316 | <div class="method-definition"> |
317 | <span class="method-result">void</span> |
318 | <a href="#SmtpClose" title="details" class="method-name">SmtpClose</a> |
319 | () |
320 | </div> |
321 | </div> |
322 | </div> |
323 | </div> |
324 | |
325 | <a name="sec-vars"></a> |
326 | <div class="info-box"> |
327 | <div class="info-box-title">Variables</div> |
328 | <div class="nav-bar"> |
329 | <a href="#sec-description">Description</a> | |
330 | <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>) |
331 | |
332 | |
333 | | |
334 | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) |
335 | |
336 | </div> |
337 | <div class="info-box-body"> |
338 | <a name="var$AltBody" id="$AltBody"><!-- --></A> |
339 | <div class="evenrow"> |
340 | |
341 | <div class="var-header"> |
342 | <span class="var-title"> |
343 | <span class="var-type">string</span> |
344 | <span class="var-name">$AltBody</span> |
345 | = <span class="var-default"> ""</span> (line <span class="line-number">96</span>) |
346 | </span> |
347 | </div> |
348 | |
349 | <!-- ========== Info from phpDoc block ========= --> |
350 | <p class="short-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.</p> |
351 | |
352 | |
353 | |
354 | |
355 | |
356 | </div> |
357 | <a name="var$Body" id="$Body"><!-- --></A> |
358 | <div class="oddrow"> |
359 | |
360 | <div class="var-header"> |
361 | <span class="var-title"> |
362 | <span class="var-type">string</span> |
363 | <span class="var-name">$Body</span> |
364 | = <span class="var-default"> ""</span> (line <span class="line-number">87</span>) |
365 | </span> |
366 | </div> |
367 | |
368 | <!-- ========== Info from phpDoc block ========= --> |
369 | <p class="short-description">Sets the Body of the message. This can be either an HTML or text body.</p> |
370 | <p class="description"><p>If HTML then run IsHTML(true).</p></p> |
371 | |
372 | |
373 | |
374 | |
375 | |
376 | </div> |
377 | <a name="var$CharSet" id="$CharSet"><!-- --></A> |
378 | <div class="evenrow"> |
379 | |
380 | <div class="var-header"> |
381 | <span class="var-title"> |
382 | <span class="var-type">string</span> |
383 | <span class="var-name">$CharSet</span> |
384 | = <span class="var-default"> "iso-8859-1"</span> (line <span class="line-number">36</span>) |
385 | </span> |
386 | </div> |
387 | |
388 | <!-- ========== Info from phpDoc block ========= --> |
389 | <p class="short-description">Sets the CharSet of the message.</p> |
390 | |
391 | |
392 | |
393 | |
394 | |
395 | </div> |
396 | <a name="var$ConfirmReadingTo" id="$ConfirmReadingTo"><!-- --></A> |
397 | <div class="oddrow"> |
398 | |
399 | <div class="var-header"> |
400 | <span class="var-title"> |
401 | <span class="var-type">string</span> |
402 | <span class="var-name">$ConfirmReadingTo</span> |
403 | = <span class="var-default"> ""</span> (line <span class="line-number">134</span>) |
404 | </span> |
405 | </div> |
406 | |
407 | <!-- ========== Info from phpDoc block ========= --> |
408 | <p class="short-description">Sets the email address that a reading confirmation will be sent.</p> |
409 | |
410 | |
411 | |
412 | |
413 | |
414 | </div> |
415 | <a name="var$ContentType" id="$ContentType"><!-- --></A> |
416 | <div class="evenrow"> |
417 | |
418 | <div class="var-header"> |
419 | <span class="var-title"> |
420 | <span class="var-type">string</span> |
421 | <span class="var-name">$ContentType</span> |
422 | = <span class="var-default"> "text/plain"</span> (line <span class="line-number">42</span>) |
423 | </span> |
424 | </div> |
425 | |
426 | <!-- ========== Info from phpDoc block ========= --> |
427 | <p class="short-description">Sets the Content-type of the message.</p> |
428 | |
429 | |
430 | |
431 | |
432 | |
433 | </div> |
434 | <a name="var$Encoding" id="$Encoding"><!-- --></A> |
435 | <div class="oddrow"> |
436 | |
437 | <div class="var-header"> |
438 | <span class="var-title"> |
439 | <span class="var-type">string</span> |
440 | <span class="var-name">$Encoding</span> |
441 | = <span class="var-default"> "8bit"</span> (line <span class="line-number">49</span>) |
442 | </span> |
443 | </div> |
444 | |
445 | <!-- ========== Info from phpDoc block ========= --> |
446 | <p class="short-description">Sets the Encoding of the message. Options for this are "8bit", "7bit", "binary", "base64", and "quoted-printable".</p> |
447 | |
448 | |
449 | |
450 | |
451 | |
452 | </div> |
453 | <a name="var$ErrorInfo" id="$ErrorInfo"><!-- --></A> |
454 | <div class="evenrow"> |
455 | |
456 | <div class="var-header"> |
457 | <span class="var-title"> |
458 | <span class="var-type">string</span> |
459 | <span class="var-name">$ErrorInfo</span> |
460 | = <span class="var-default"> ""</span> (line <span class="line-number">55</span>) |
461 | </span> |
462 | </div> |
463 | |
464 | <!-- ========== Info from phpDoc block ========= --> |
465 | <p class="short-description">Holds the most recent mailer error message.</p> |
466 | |
467 | |
468 | |
469 | |
470 | |
471 | </div> |
472 | <a name="var$From" id="$From"><!-- --></A> |
473 | <div class="oddrow"> |
474 | |
475 | <div class="var-header"> |
476 | <span class="var-title"> |
477 | <span class="var-type">string</span> |
478 | <span class="var-name">$From</span> |
479 | = <span class="var-default"> "root@localhost"</span> (line <span class="line-number">61</span>) |
480 | </span> |
481 | </div> |
482 | |
483 | <!-- ========== Info from phpDoc block ========= --> |
484 | <p class="short-description">Sets the From email address for the message.</p> |
485 | |
486 | |
487 | |
488 | |
489 | |
490 | </div> |
491 | <a name="var$FromName" id="$FromName"><!-- --></A> |
492 | <div class="evenrow"> |
493 | |
494 | <div class="var-header"> |
495 | <span class="var-title"> |
496 | <span class="var-type">string</span> |
497 | <span class="var-name">$FromName</span> |
498 | = <span class="var-default"> "Root User"</span> (line <span class="line-number">67</span>) |
499 | </span> |
500 | </div> |
501 | |
502 | <!-- ========== Info from phpDoc block ========= --> |
503 | <p class="short-description">Sets the From name of the message.</p> |
504 | |
505 | |
506 | |
507 | |
508 | |
509 | </div> |
510 | <a name="var$Helo" id="$Helo"><!-- --></A> |
511 | <div class="oddrow"> |
512 | |
513 | <div class="var-header"> |
514 | <span class="var-title"> |
515 | <span class="var-type">string</span> |
516 | <span class="var-name">$Helo</span> |
517 | = <span class="var-default"> ""</span> (line <span class="line-number">169</span>) |
518 | </span> |
519 | </div> |
520 | |
521 | <!-- ========== Info from phpDoc block ========= --> |
522 | <p class="short-description">Sets the SMTP HELO of the message (Default is $Hostname).</p> |
523 | |
524 | |
525 | |
526 | |
527 | |
528 | </div> |
529 | <a name="var$Host" id="$Host"><!-- --></A> |
530 | <div class="evenrow"> |
531 | |
532 | <div class="var-header"> |
533 | <span class="var-title"> |
534 | <span class="var-type">string</span> |
535 | <span class="var-name">$Host</span> |
536 | = <span class="var-default"> "localhost"</span> (line <span class="line-number">157</span>) |
537 | </span> |
538 | </div> |
539 | |
540 | <!-- ========== Info from phpDoc block ========= --> |
541 | <p class="short-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. "smtp1.example.com:25;smtp2.example.com").</p> |
542 | <p class="description"><p>Hosts will be tried in order.</p></p> |
543 | |
544 | |
545 | |
546 | |
547 | |
548 | </div> |
549 | <a name="var$Hostname" id="$Hostname"><!-- --></A> |
550 | <div class="oddrow"> |
551 | |
552 | <div class="var-header"> |
553 | <span class="var-title"> |
554 | <span class="var-type">string</span> |
555 | <span class="var-name">$Hostname</span> |
556 | = <span class="var-default"> ""</span> (line <span class="line-number">142</span>) |
557 | </span> |
558 | </div> |
559 | |
560 | <!-- ========== Info from phpDoc block ========= --> |
561 | <p class="short-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'.</p> |
562 | |
563 | |
564 | |
565 | |
566 | |
567 | </div> |
568 | <a name="var$Mailer" id="$Mailer"><!-- --></A> |
569 | <div class="evenrow"> |
570 | |
571 | <div class="var-header"> |
572 | <span class="var-title"> |
573 | <span class="var-type">string</span> |
574 | <span class="var-name">$Mailer</span> |
575 | = <span class="var-default"> "mail"</span> (line <span class="line-number">109</span>) |
576 | </span> |
577 | </div> |
578 | |
579 | <!-- ========== Info from phpDoc block ========= --> |
580 | <p class="short-description">Method to send mail: ("mail", "sendmail", or "smtp").</p> |
581 | |
582 | |
583 | |
584 | |
585 | |
586 | </div> |
587 | <a name="var$Password" id="$Password"><!-- --></A> |
588 | <div class="oddrow"> |
589 | |
590 | <div class="var-header"> |
591 | <span class="var-title"> |
592 | <span class="var-type">string</span> |
593 | <span class="var-name">$Password</span> |
594 | = <span class="var-default"> ""</span> (line <span class="line-number">187</span>) |
595 | </span> |
596 | </div> |
597 | |
598 | <!-- ========== Info from phpDoc block ========= --> |
599 | <p class="short-description">Sets SMTP password.</p> |
600 | |
601 | |
602 | |
603 | |
604 | |
605 | </div> |
606 | <a name="var$PluginDir" id="$PluginDir"><!-- --></A> |
607 | <div class="evenrow"> |
608 | |
609 | <div class="var-header"> |
610 | <span class="var-title"> |
611 | <span class="var-type">string</span> |
612 | <span class="var-name">$PluginDir</span> |
613 | = <span class="var-default"> ""</span> (line <span class="line-number">122</span>) |
614 | </span> |
615 | </div> |
616 | |
617 | <!-- ========== Info from phpDoc block ========= --> |
618 | <p class="short-description">Path to PHPMailer plugins. This is now only useful if the SMTP class is in a different directory than the PHP include path.</p> |
619 | |
620 | |
621 | |
622 | |
623 | |
624 | </div> |
625 | <a name="var$Port" id="$Port"><!-- --></A> |
626 | <div class="oddrow"> |
627 | |
628 | <div class="var-header"> |
629 | <span class="var-title"> |
630 | <span class="var-type">int</span> |
631 | <span class="var-name">$Port</span> |
632 | = <span class="var-default"> 25</span> (line <span class="line-number">163</span>) |
633 | </span> |
634 | </div> |
635 | |
636 | <!-- ========== Info from phpDoc block ========= --> |
637 | <p class="short-description">Sets the default SMTP server port.</p> |
638 | |
639 | |
640 | |
641 | |
642 | |
643 | </div> |
644 | <a name="var$Priority" id="$Priority"><!-- --></A> |
645 | <div class="evenrow"> |
646 | |
647 | <div class="var-header"> |
648 | <span class="var-title"> |
649 | <span class="var-type">int</span> |
650 | <span class="var-name">$Priority</span> |
651 | = <span class="var-default"> 3</span> (line <span class="line-number">30</span>) |
652 | </span> |
653 | </div> |
654 | |
655 | <!-- ========== Info from phpDoc block ========= --> |
656 | <p class="short-description">Email priority (1 = High, 3 = Normal, 5 = low).</p> |
657 | |
658 | |
659 | |
660 | |
661 | |
662 | </div> |
663 | <a name="var$Sender" id="$Sender"><!-- --></A> |
664 | <div class="oddrow"> |
665 | |
666 | <div class="var-header"> |
667 | <span class="var-title"> |
668 | <span class="var-type">string</span> |
669 | <span class="var-name">$Sender</span> |
670 | = <span class="var-default"> ""</span> (line <span class="line-number">74</span>) |
671 | </span> |
672 | </div> |
673 | |
674 | <!-- ========== Info from phpDoc block ========= --> |
675 | <p class="short-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.</p> |
676 | |
677 | |
678 | |
679 | |
680 | |
681 | </div> |
682 | <a name="var$Sendmail" id="$Sendmail"><!-- --></A> |
683 | <div class="evenrow"> |
684 | |
685 | <div class="var-header"> |
686 | <span class="var-title"> |
687 | <span class="var-type">string</span> |
688 | <span class="var-name">$Sendmail</span> |
689 | = <span class="var-default"> "/usr/sbin/sendmail"</span> (line <span class="line-number">115</span>) |
690 | </span> |
691 | </div> |
692 | |
693 | <!-- ========== Info from phpDoc block ========= --> |
694 | <p class="short-description">Sets the path of the sendmail program.</p> |
695 | |
696 | |
697 | |
698 | |
699 | |
700 | </div> |
701 | <a name="var$SMTPAuth" id="$SMTPAuth"><!-- --></A> |
702 | <div class="oddrow"> |
703 | |
704 | <div class="var-header"> |
705 | <span class="var-title"> |
706 | <span class="var-type">bool</span> |
707 | <span class="var-name">$SMTPAuth</span> |
708 | = <span class="var-default"> false</span> (line <span class="line-number">175</span>) |
709 | </span> |
710 | </div> |
711 | |
712 | <!-- ========== Info from phpDoc block ========= --> |
713 | <p class="short-description">Sets SMTP authentication. Utilizes the Username and Password variables.</p> |
714 | |
715 | |
716 | |
717 | |
718 | |
719 | </div> |
720 | <a name="var$SMTPDebug" id="$SMTPDebug"><!-- --></A> |
721 | <div class="evenrow"> |
722 | |
723 | <div class="var-header"> |
724 | <span class="var-title"> |
725 | <span class="var-type">bool</span> |
726 | <span class="var-name">$SMTPDebug</span> |
727 | = <span class="var-default"> false</span> (line <span class="line-number">200</span>) |
728 | </span> |
729 | </div> |
730 | |
731 | <!-- ========== Info from phpDoc block ========= --> |
732 | <p class="short-description">Sets SMTP class debugging on or off.</p> |
733 | |
734 | |
735 | |
736 | |
737 | |
738 | </div> |
739 | <a name="var$SMTPKeepAlive" id="$SMTPKeepAlive"><!-- --></A> |
740 | <div class="oddrow"> |
741 | |
742 | <div class="var-header"> |
743 | <span class="var-title"> |
744 | <span class="var-type">bool</span> |
745 | <span class="var-name">$SMTPKeepAlive</span> |
746 | = <span class="var-default"> false</span> (line <span class="line-number">208</span>) |
747 | </span> |
748 | </div> |
749 | |
750 | <!-- ========== Info from phpDoc block ========= --> |
751 | <p class="short-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().</p> |
752 | |
753 | |
754 | |
755 | |
756 | |
757 | </div> |
758 | <a name="var$Subject" id="$Subject"><!-- --></A> |
759 | <div class="evenrow"> |
760 | |
761 | <div class="var-header"> |
762 | <span class="var-title"> |
763 | <span class="var-type">string</span> |
764 | <span class="var-name">$Subject</span> |
765 | = <span class="var-default"> ""</span> (line <span class="line-number">80</span>) |
766 | </span> |
767 | </div> |
768 | |
769 | <!-- ========== Info from phpDoc block ========= --> |
770 | <p class="short-description">Sets the Subject of the message.</p> |
771 | |
772 | |
773 | |
774 | |
775 | |
776 | </div> |
777 | <a name="var$Timeout" id="$Timeout"><!-- --></A> |
778 | <div class="oddrow"> |
779 | |
780 | <div class="var-header"> |
781 | <span class="var-title"> |
782 | <span class="var-type">int</span> |
783 | <span class="var-name">$Timeout</span> |
784 | = <span class="var-default"> 10</span> (line <span class="line-number">194</span>) |
785 | </span> |
786 | </div> |
787 | |
788 | <!-- ========== Info from phpDoc block ========= --> |
789 | <p class="short-description">Sets the SMTP server timeout in seconds. This function will not work with the win32 version.</p> |
790 | |
791 | |
792 | |
793 | |
794 | |
795 | </div> |
796 | <a name="var$Username" id="$Username"><!-- --></A> |
797 | <div class="evenrow"> |
798 | |
799 | <div class="var-header"> |
800 | <span class="var-title"> |
801 | <span class="var-type">string</span> |
802 | <span class="var-name">$Username</span> |
803 | = <span class="var-default"> ""</span> (line <span class="line-number">181</span>) |
804 | </span> |
805 | </div> |
806 | |
807 | <!-- ========== Info from phpDoc block ========= --> |
808 | <p class="short-description">Sets SMTP username.</p> |
809 | |
810 | |
811 | |
812 | |
813 | |
814 | </div> |
815 | <a name="var$Version" id="$Version"><!-- --></A> |
816 | <div class="oddrow"> |
817 | |
818 | <div class="var-header"> |
819 | <span class="var-title"> |
820 | <span class="var-type">string</span> |
821 | <span class="var-name">$Version</span> |
822 | = <span class="var-default"> "1.71"</span> (line <span class="line-number">128</span>) |
823 | </span> |
824 | </div> |
825 | |
826 | <!-- ========== Info from phpDoc block ========= --> |
827 | <p class="short-description">Holds PHPMailer version.</p> |
828 | |
829 | |
830 | |
831 | |
832 | |
833 | </div> |
834 | <a name="var$WordWrap" id="$WordWrap"><!-- --></A> |
835 | <div class="evenrow"> |
836 | |
837 | <div class="var-header"> |
838 | <span class="var-title"> |
839 | <span class="var-type">int</span> |
840 | <span class="var-name">$WordWrap</span> |
841 | = <span class="var-default"> 0</span> (line <span class="line-number">103</span>) |
842 | </span> |
843 | </div> |
844 | |
845 | <!-- ========== Info from phpDoc block ========= --> |
846 | <p class="short-description">Sets word wrapping on the body of the message to a given number of characters.</p> |
847 | |
848 | |
849 | |
850 | |
851 | |
852 | </div> |
853 | |
854 | </div> |
855 | </div> |
856 | |
857 | <a name="sec-methods"></a> |
858 | <div class="info-box"> |
859 | <div class="info-box-title">Methods</div> |
860 | <div class="nav-bar"> |
861 | <a href="#sec-description">Description</a> | |
862 | <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) |
863 | <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>) |
864 | |
865 | </div> |
866 | <div class="info-box-body"> |
867 | <A NAME='method_detail'></A> |
868 | <a name="methodAddAddress" id="AddAddress"><!-- --></a> |
869 | <div class="oddrow"> |
870 | |
871 | <div class="method-header"> |
872 | <span class="method-title">AddAddress</span> (line <span class="line-number">287</span>) |
873 | </div> |
874 | |
875 | <!-- ========== Info from phpDoc block ========= --> |
876 | <p class="short-description">Adds a "To" address.</p> |
877 | |
878 | <div class="method-signature"> |
879 | <span class="method-result">void</span> |
880 | <span class="method-name"> |
881 | AddAddress |
882 | </span> |
883 | (<span class="var-type">string</span> <span class="var-name">$address</span>, [<span class="var-type">string</span> <span class="var-name">$name</span> = <span class="var-default">""</span>]) |
884 | </div> |
885 | |
886 | <ul class="parameters"> |
887 | <li> |
888 | <span class="var-type">string</span> |
889 | <span class="var-name">$address</span> </li> |
890 | <li> |
891 | <span class="var-type">string</span> |
892 | <span class="var-name">$name</span> </li> |
893 | </ul> |
894 | |
895 | |
896 | </div> |
897 | <a name="methodAddAttachment" id="AddAttachment"><!-- --></a> |
898 | <div class="evenrow"> |
899 | |
900 | <div class="method-header"> |
901 | <span class="method-title">AddAttachment</span> (line <span class="line-number">1000</span>) |
902 | </div> |
903 | |
904 | <!-- ========== Info from phpDoc block ========= --> |
905 | <p class="short-description">Adds an attachment from a path on the filesystem.</p> |
906 | <p class="description"><p>Returns false if the file could not be found or accessed.</p></p> |
907 | |
908 | <div class="method-signature"> |
909 | <span class="method-result">bool</span> |
910 | <span class="method-name"> |
911 | AddAttachment |
912 | </span> |
913 | (<span class="var-type">string</span> <span class="var-name">$path</span>, [<span class="var-type">string</span> <span class="var-name">$name</span> = <span class="var-default">""</span>], [<span class="var-type">string</span> <span class="var-name">$encoding</span> = <span class="var-default">"base64"</span>], [<span class="var-type">string</span> <span class="var-name">$type</span> = <span class="var-default">"application/octet-stream"</span>]) |
914 | </div> |
915 | |
916 | <ul class="parameters"> |
917 | <li> |
918 | <span class="var-type">string</span> |
919 | <span class="var-name">$path</span><span class="var-description">: <p>Path to the attachment.</p></span> </li> |
920 | <li> |
921 | <span class="var-type">string</span> |
922 | <span class="var-name">$name</span><span class="var-description">: <p>Overrides the attachment name.</p></span> </li> |
923 | <li> |
924 | <span class="var-type">string</span> |
925 | <span class="var-name">$encoding</span><span class="var-description">: <p>File encoding (see $Encoding).</p></span> </li> |
926 | <li> |
927 | <span class="var-type">string</span> |
928 | <span class="var-name">$type</span><span class="var-description">: <p>File extension (MIME) type.</p></span> </li> |
929 | </ul> |
930 | |
931 | |
932 | </div> |
933 | <a name="methodAddBCC" id="AddBCC"><!-- --></a> |
934 | <div class="oddrow"> |
935 | |
936 | <div class="method-header"> |
937 | <span class="method-title">AddBCC</span> (line <span class="line-number">315</span>) |
938 | </div> |
939 | |
940 | <!-- ========== Info from phpDoc block ========= --> |
941 | <p class="short-description">Adds a "Bcc" address. Note: this function works with the SMTP mailer on win32, not with the "mail" mailer.</p> |
942 | |
943 | <div class="method-signature"> |
944 | <span class="method-result">void</span> |
945 | <span class="method-name"> |
946 | AddBCC |
947 | </span> |
948 | (<span class="var-type">string</span> <span class="var-name">$address</span>, [<span class="var-type">string</span> <span class="var-name">$name</span> = <span class="var-default">""</span>]) |
949 | </div> |
950 | |
951 | <ul class="parameters"> |
952 | <li> |
953 | <span class="var-type">string</span> |
954 | <span class="var-name">$address</span> </li> |
955 | <li> |
956 | <span class="var-type">string</span> |
957 | <span class="var-name">$name</span> </li> |
958 | </ul> |
959 | |
960 | |
961 | </div> |
962 | <a name="methodAddCC" id="AddCC"><!-- --></a> |
963 | <div class="evenrow"> |
964 | |
965 | <div class="method-header"> |
966 | <span class="method-title">AddCC</span> (line <span class="line-number">301</span>) |
967 | </div> |
968 | |
969 | <!-- ========== Info from phpDoc block ========= --> |
970 | <p class="short-description">Adds a "Cc" address. Note: this function works with the SMTP mailer on win32, not with the "mail" mailer.</p> |
971 | |
972 | <div class="method-signature"> |
973 | <span class="method-result">void</span> |
974 | <span class="method-name"> |
975 | AddCC |
976 | </span> |
977 | (<span class="var-type">string</span> <span class="var-name">$address</span>, [<span class="var-type">string</span> <span class="var-name">$name</span> = <span class="var-default">""</span>]) |
978 | </div> |
979 | |
980 | <ul class="parameters"> |
981 | <li> |
982 | <span class="var-type">string</span> |
983 | <span class="var-name">$address</span> </li> |
984 | <li> |
985 | <span class="var-type">string</span> |
986 | <span class="var-name">$name</span> </li> |
987 | </ul> |
988 | |
989 | |
990 | </div> |
991 | <a name="methodAddCustomHeader" id="AddCustomHeader"><!-- --></a> |
992 | <div class="oddrow"> |
993 | |
994 | <div class="method-header"> |
995 | <span class="method-title">AddCustomHeader</span> (line <span class="line-number">1525</span>) |
996 | </div> |
997 | |
998 | <!-- ========== Info from phpDoc block ========= --> |
999 | <p class="short-description">Adds a custom header.</p> |
1000 | |
1001 | <div class="method-signature"> |
1002 | <span class="method-result">void</span> |
1003 | <span class="method-name"> |
1004 | AddCustomHeader |
1005 | </span> |
1006 | (<span class="var-type">mixed</span> <span class="var-name">$custom_header</span>) |
1007 | </div> |
1008 | |
1009 | |
1010 | |
1011 | </div> |
1012 | <a name="methodAddEmbeddedImage" id="AddEmbeddedImage"><!-- --></a> |
1013 | <div class="evenrow"> |
1014 | |
1015 | <div class="method-header"> |
1016 | <span class="method-title">AddEmbeddedImage</span> (line <span class="line-number">1275</span>) |
1017 | </div> |
1018 | |
1019 | <!-- ========== Info from phpDoc block ========= --> |
1020 | <p class="short-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 "image/jpeg" and for GIF images use "image/gif".</p> |
1021 | |
1022 | <div class="method-signature"> |
1023 | <span class="method-result">bool</span> |
1024 | <span class="method-name"> |
1025 | AddEmbeddedImage |
1026 | </span> |
1027 | (<span class="var-type">string</span> <span class="var-name">$path</span>, <span class="var-type">string</span> <span class="var-name">$cid</span>, [<span class="var-type">string</span> <span class="var-name">$name</span> = <span class="var-default">""</span>], [<span class="var-type">string</span> <span class="var-name">$encoding</span> = <span class="var-default">"base64"</span>], [<span class="var-type">string</span> <span class="var-name">$type</span> = <span class="var-default">"application/octet-stream"</span>]) |
1028 | </div> |
1029 | |
1030 | <ul class="parameters"> |
1031 | <li> |
1032 | <span class="var-type">string</span> |
1033 | <span class="var-name">$path</span><span class="var-description">: <p>Path to the attachment.</p></span> </li> |
1034 | <li> |
1035 | <span class="var-type">string</span> |
1036 | <span class="var-name">$cid</span><span class="var-description">: <p>Content ID of the attachment. Use this to identify the Id for accessing the image in an HTML form.</p></span> </li> |
1037 | <li> |
1038 | <span class="var-type">string</span> |
1039 | <span class="var-name">$name</span><span class="var-description">: <p>Overrides the attachment name.</p></span> </li> |
1040 | <li> |
1041 | <span class="var-type">string</span> |
1042 | <span class="var-name">$encoding</span><span class="var-description">: <p>File encoding (see $Encoding).</p></span> </li> |
1043 | <li> |
1044 | <span class="var-type">string</span> |
1045 | <span class="var-name">$type</span><span class="var-description">: <p>File extension (MIME) type.</p></span> </li> |
1046 | </ul> |
1047 | |
1048 | |
1049 | </div> |
1050 | <a name="methodAddReplyTo" id="AddReplyTo"><!-- --></a> |
1051 | <div class="oddrow"> |
1052 | |
1053 | <div class="method-header"> |
1054 | <span class="method-title">AddReplyTo</span> (line <span class="line-number">327</span>) |
1055 | </div> |
1056 | |
1057 | <!-- ========== Info from phpDoc block ========= --> |
1058 | <p class="short-description">Adds a "Reply-to" address.</p> |
1059 | |
1060 | <div class="method-signature"> |
1061 | <span class="method-result">void</span> |
1062 | <span class="method-name"> |
1063 | AddReplyTo |
1064 | </span> |
1065 | (<span class="var-type">string</span> <span class="var-name">$address</span>, [<span class="var-type">string</span> <span class="var-name">$name</span> = <span class="var-default">""</span>]) |
1066 | </div> |
1067 | |
1068 | <ul class="parameters"> |
1069 | <li> |
1070 | <span class="var-type">string</span> |
1071 | <span class="var-name">$address</span> </li> |
1072 | <li> |
1073 | <span class="var-type">string</span> |
1074 | <span class="var-name">$name</span> </li> |
1075 | </ul> |
1076 | |
1077 | |
1078 | </div> |
1079 | <a name="methodAddStringAttachment" id="AddStringAttachment"><!-- --></a> |
1080 | <div class="evenrow"> |
1081 | |
1082 | <div class="method-header"> |
1083 | <span class="method-title">AddStringAttachment</span> (line <span class="line-number">1248</span>) |
1084 | </div> |
1085 | |
1086 | <!-- ========== Info from phpDoc block ========= --> |
1087 | <p class="short-description">Adds a string or binary attachment (non-filesystem) to the list.</p> |
1088 | <p class="description"><p>This method can be used to attach ascii or binary data, such as a BLOB record from a database.</p></p> |
1089 | |
1090 | <div class="method-signature"> |
1091 | <span class="method-result">void</span> |
1092 | <span class="method-name"> |
1093 | AddStringAttachment |
1094 | </span> |
1095 | (<span class="var-type">string</span> <span class="var-name">$string</span>, <span class="var-type">string</span> <span class="var-name">$filename</span>, [<span class="var-type">string</span> <span class="var-name">$encoding</span> = <span class="var-default">"base64"</span>], [<span class="var-type">string</span> <span class="var-name">$type</span> = <span class="var-default">"application/octet-stream"</span>]) |
1096 | </div> |
1097 | |
1098 | <ul class="parameters"> |
1099 | <li> |
1100 | <span class="var-type">string</span> |
1101 | <span class="var-name">$string</span><span class="var-description">: <p>String attachment data.</p></span> </li> |
1102 | <li> |
1103 | <span class="var-type">string</span> |
1104 | <span class="var-name">$filename</span><span class="var-description">: <p>Name of the attachment.</p></span> </li> |
1105 | <li> |
1106 | <span class="var-type">string</span> |
1107 | <span class="var-name">$encoding</span><span class="var-description">: <p>File encoding (see $Encoding).</p></span> </li> |
1108 | <li> |
1109 | <span class="var-type">string</span> |
1110 | <span class="var-name">$type</span><span class="var-description">: <p>File extension (MIME) type.</p></span> </li> |
1111 | </ul> |
1112 | |
1113 | |
1114 | </div> |
1115 | <a name="methodClearAddresses" id="ClearAddresses"><!-- --></a> |
1116 | <div class="oddrow"> |
1117 | |
1118 | <div class="method-header"> |
1119 | <span class="method-title">ClearAddresses</span> (line <span class="line-number">1329</span>) |
1120 | </div> |
1121 | |
1122 | <!-- ========== Info from phpDoc block ========= --> |
1123 | <p class="short-description">Clears all recipients assigned in the TO array. Returns void.</p> |
1124 | |
1125 | <div class="method-signature"> |
1126 | <span class="method-result">void</span> |
1127 | <span class="method-name"> |
1128 | ClearAddresses |
1129 | </span> |
1130 | () |
1131 | </div> |
1132 | |
1133 | |
1134 | |
1135 | </div> |
1136 | <a name="methodClearAllRecipients" id="ClearAllRecipients"><!-- --></a> |
1137 | <div class="evenrow"> |
1138 | |
1139 | <div class="method-header"> |
1140 | <span class="method-title">ClearAllRecipients</span> (line <span class="line-number">1362</span>) |
1141 | </div> |
1142 | |
1143 | <!-- ========== Info from phpDoc block ========= --> |
1144 | <p class="short-description">Clears all recipients assigned in the TO, CC and BCC array. Returns void.</p> |
1145 | |
1146 | <div class="method-signature"> |
1147 | <span class="method-result">void</span> |
1148 | <span class="method-name"> |
1149 | ClearAllRecipients |
1150 | </span> |
1151 | () |
1152 | </div> |
1153 | |
1154 | |
1155 | |
1156 | </div> |
1157 | <a name="methodClearAttachments" id="ClearAttachments"><!-- --></a> |
1158 | <div class="oddrow"> |
1159 | |
1160 | <div class="method-header"> |
1161 | <span class="method-title">ClearAttachments</span> (line <span class="line-number">1373</span>) |
1162 | </div> |
1163 | |
1164 | <!-- ========== Info from phpDoc block ========= --> |
1165 | <p class="short-description">Clears all previously set filesystem, string, and binary attachments. Returns void.</p> |
1166 | |
1167 | <div class="method-signature"> |
1168 | <span class="method-result">void</span> |
1169 | <span class="method-name"> |
1170 | ClearAttachments |
1171 | </span> |
1172 | () |
1173 | </div> |
1174 | |
1175 | |
1176 | |
1177 | </div> |
1178 | <a name="methodClearBCCs" id="ClearBCCs"><!-- --></a> |
1179 | <div class="evenrow"> |
1180 | |
1181 | <div class="method-header"> |
1182 | <span class="method-title">ClearBCCs</span> (line <span class="line-number">1345</span>) |
1183 | </div> |
1184 | |
1185 | <!-- ========== Info from phpDoc block ========= --> |
1186 | <p class="short-description">Clears all recipients assigned in the BCC array. Returns void.</p> |
1187 | |
1188 | <div class="method-signature"> |
1189 | <span class="method-result">void</span> |
1190 | <span class="method-name"> |
1191 | ClearBCCs |
1192 | </span> |
1193 | () |
1194 | </div> |
1195 | |
1196 | |
1197 | |
1198 | </div> |
1199 | <a name="methodClearCCs" id="ClearCCs"><!-- --></a> |
1200 | <div class="oddrow"> |
1201 | |
1202 | <div class="method-header"> |
1203 | <span class="method-title">ClearCCs</span> (line <span class="line-number">1337</span>) |
1204 | </div> |
1205 | |
1206 | <!-- ========== Info from phpDoc block ========= --> |
1207 | <p class="short-description">Clears all recipients assigned in the CC array. Returns void.</p> |
1208 | |
1209 | <div class="method-signature"> |
1210 | <span class="method-result">void</span> |
1211 | <span class="method-name"> |
1212 | ClearCCs |
1213 | </span> |
1214 | () |
1215 | </div> |
1216 | |
1217 | |
1218 | |
1219 | </div> |
1220 | <a name="methodClearCustomHeaders" id="ClearCustomHeaders"><!-- --></a> |
1221 | <div class="evenrow"> |
1222 | |
1223 | <div class="method-header"> |
1224 | <span class="method-title">ClearCustomHeaders</span> (line <span class="line-number">1381</span>) |
1225 | </div> |
1226 | |
1227 | <!-- ========== Info from phpDoc block ========= --> |
1228 | <p class="short-description">Clears all custom headers. Returns void.</p> |
1229 | |
1230 | <div class="method-signature"> |
1231 | <span class="method-result">void</span> |
1232 | <span class="method-name"> |
1233 | ClearCustomHeaders |
1234 | </span> |
1235 | () |
1236 | </div> |
1237 | |
1238 | |
1239 | |
1240 | </div> |
1241 | <a name="methodClearReplyTos" id="ClearReplyTos"><!-- --></a> |
1242 | <div class="oddrow"> |
1243 | |
1244 | <div class="method-header"> |
1245 | <span class="method-title">ClearReplyTos</span> (line <span class="line-number">1353</span>) |
1246 | </div> |
1247 | |
1248 | <!-- ========== Info from phpDoc block ========= --> |
1249 | <p class="short-description">Clears all recipients assigned in the ReplyTo array. Returns void.</p> |
1250 | |
1251 | <div class="method-signature"> |
1252 | <span class="method-result">void</span> |
1253 | <span class="method-name"> |
1254 | ClearReplyTos |
1255 | </span> |
1256 | () |
1257 | </div> |
1258 | |
1259 | |
1260 | |
1261 | </div> |
1262 | <a name="methodIsError" id="IsError"><!-- --></a> |
1263 | <div class="evenrow"> |
1264 | |
1265 | <div class="method-header"> |
1266 | <span class="method-title">IsError</span> (line <span class="line-number">1505</span>) |
1267 | </div> |
1268 | |
1269 | <!-- ========== Info from phpDoc block ========= --> |
1270 | <p class="short-description">Returns true if an error occurred.</p> |
1271 | |
1272 | <div class="method-signature"> |
1273 | <span class="method-result">bool</span> |
1274 | <span class="method-name"> |
1275 | IsError |
1276 | </span> |
1277 | () |
1278 | </div> |
1279 | |
1280 | |
1281 | |
1282 | </div> |
1283 | <a name="methodIsHTML" id="IsHTML"><!-- --></a> |
1284 | <div class="oddrow"> |
1285 | |
1286 | <div class="method-header"> |
1287 | <span class="method-title">IsHTML</span> (line <span class="line-number">236</span>) |
1288 | </div> |
1289 | |
1290 | <!-- ========== Info from phpDoc block ========= --> |
1291 | <p class="short-description">Sets message type to HTML.</p> |
1292 | |
1293 | <div class="method-signature"> |
1294 | <span class="method-result">void</span> |
1295 | <span class="method-name"> |
1296 | IsHTML |
1297 | </span> |
1298 | (<span class="var-type">bool</span> <span class="var-name">$bool</span>) |
1299 | </div> |
1300 | |
1301 | <ul class="parameters"> |
1302 | <li> |
1303 | <span class="var-type">bool</span> |
1304 | <span class="var-name">$bool</span> </li> |
1305 | </ul> |
1306 | |
1307 | |
1308 | </div> |
1309 | <a name="methodIsMail" id="IsMail"><!-- --></a> |
1310 | <div class="evenrow"> |
1311 | |
1312 | <div class="method-header"> |
1313 | <span class="method-title">IsMail</span> (line <span class="line-number">255</span>) |
1314 | </div> |
1315 | |
1316 | <!-- ========== Info from phpDoc block ========= --> |
1317 | <p class="short-description">Sets Mailer to send message using PHP mail() function.</p> |
1318 | |
1319 | <div class="method-signature"> |
1320 | <span class="method-result">void</span> |
1321 | <span class="method-name"> |
1322 | IsMail |
1323 | </span> |
1324 | () |
1325 | </div> |
1326 | |
1327 | |
1328 | |
1329 | </div> |
1330 | <a name="methodIsQmail" id="IsQmail"><!-- --></a> |
1331 | <div class="oddrow"> |
1332 | |
1333 | <div class="method-header"> |
1334 | <span class="method-title">IsQmail</span> (line <span class="line-number">271</span>) |
1335 | </div> |
1336 | |
1337 | <!-- ========== Info from phpDoc block ========= --> |
1338 | <p class="short-description">Sets Mailer to send message using the qmail MTA.</p> |
1339 | |
1340 | <div class="method-signature"> |
1341 | <span class="method-result">void</span> |
1342 | <span class="method-name"> |
1343 | IsQmail |
1344 | </span> |
1345 | () |
1346 | </div> |
1347 | |
1348 | |
1349 | |
1350 | </div> |
1351 | <a name="methodIsSendmail" id="IsSendmail"><!-- --></a> |
1352 | <div class="evenrow"> |
1353 | |
1354 | <div class="method-header"> |
1355 | <span class="method-title">IsSendmail</span> (line <span class="line-number">263</span>) |
1356 | </div> |
1357 | |
1358 | <!-- ========== Info from phpDoc block ========= --> |
1359 | <p class="short-description">Sets Mailer to send message using the $Sendmail program.</p> |
1360 | |
1361 | <div class="method-signature"> |
1362 | <span class="method-result">void</span> |
1363 | <span class="method-name"> |
1364 | IsSendmail |
1365 | </span> |
1366 | () |
1367 | </div> |
1368 | |
1369 | |
1370 | |
1371 | </div> |
1372 | <a name="methodIsSMTP" id="IsSMTP"><!-- --></a> |
1373 | <div class="oddrow"> |
1374 | |
1375 | <div class="method-header"> |
1376 | <span class="method-title">IsSMTP</span> (line <span class="line-number">247</span>) |
1377 | </div> |
1378 | |
1379 | <!-- ========== Info from phpDoc block ========= --> |
1380 | <p class="short-description">Sets Mailer to send message using SMTP.</p> |
1381 | |
1382 | <div class="method-signature"> |
1383 | <span class="method-result">void</span> |
1384 | <span class="method-name"> |
1385 | IsSMTP |
1386 | </span> |
1387 | () |
1388 | </div> |
1389 | |
1390 | |
1391 | |
1392 | </div> |
1393 | <a name="methodSend" id="Send"><!-- --></a> |
1394 | <div class="evenrow"> |
1395 | |
1396 | <div class="method-header"> |
1397 | <span class="method-title">Send</span> (line <span class="line-number">344</span>) |
1398 | </div> |
1399 | |
1400 | <!-- ========== Info from phpDoc block ========= --> |
1401 | <p class="short-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.</p> |
1402 | |
1403 | <div class="method-signature"> |
1404 | <span class="method-result">bool</span> |
1405 | <span class="method-name"> |
1406 | Send |
1407 | </span> |
1408 | () |
1409 | </div> |
1410 | |
1411 | |
1412 | |
1413 | </div> |
1414 | <a name="methodSetLanguage" id="SetLanguage"><!-- --></a> |
1415 | <div class="oddrow"> |
1416 | |
1417 | <div class="method-header"> |
1418 | <span class="method-title">SetLanguage</span> (line <span class="line-number">599</span>) |
1419 | </div> |
1420 | |
1421 | <!-- ========== Info from phpDoc block ========= --> |
1422 | <p class="short-description">Sets the language for all class error messages. Returns false if it cannot load the language file. The default language type is English.</p> |
1423 | <ul class="tags"> |
1424 | <li><span class="field">access:</span> public</li> |
1425 | </ul> |
1426 | |
1427 | <div class="method-signature"> |
1428 | <span class="method-result">bool</span> |
1429 | <span class="method-name"> |
1430 | SetLanguage |
1431 | </span> |
1432 | (<span class="var-type">string</span> <span class="var-name">$lang_type</span>, [<span class="var-type">string</span> <span class="var-name">$lang_path</span> = <span class="var-default">""</span>]) |
1433 | </div> |
1434 | |
1435 | <ul class="parameters"> |
1436 | <li> |
1437 | <span class="var-type">string</span> |
1438 | <span class="var-name">$lang_type</span><span class="var-description">: <p>Type of language (e.g. Portuguese: "br")</p></span> </li> |
1439 | <li> |
1440 | <span class="var-type">string</span> |
1441 | <span class="var-name">$lang_path</span><span class="var-description">: <p>Path to the language file directory</p></span> </li> |
1442 | </ul> |
1443 | |
1444 | |
1445 | </div> |
1446 | <a name="methodSmtpClose" id="SmtpClose"><!-- --></a> |
1447 | <div class="evenrow"> |
1448 | |
1449 | <div class="method-header"> |
1450 | <span class="method-title">SmtpClose</span> (line <span class="line-number">579</span>) |
1451 | </div> |
1452 | |
1453 | <!-- ========== Info from phpDoc block ========= --> |
1454 | <p class="short-description">Closes the active SMTP session if one exists.</p> |
1455 | |
1456 | <div class="method-signature"> |
1457 | <span class="method-result">void</span> |
1458 | <span class="method-name"> |
1459 | SmtpClose |
1460 | </span> |
1461 | () |
1462 | </div> |
1463 | |
1464 | |
1465 | |
1466 | </div> |
1467 | |
1468 | </div> |
1469 | </div> |
1470 | |
1471 | <p class="notes" id="credit"> |
1472 | Documention generated on Mon, 28 Jul 2003 23:25:49 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.2.0</a> |
1473 | </p> |
1474 | </div></body> |
1475 | </html> |