cleanup text-match
[awl.git] / docs / api / awl / EMail / EMail.html
blob4d78c00d1eb0fa316d601fd32b38f5279d62e646
2 Warning: strftime(): It is not safe to rely on the system's timezone settings. You are *required* to use the date.timezone setting or the date_default_timezone_set() function. In case you used any of those methods and you are still getting this warning, you most likely misspelled the timezone identifier. We selected the timezone 'UTC' for now, but please set date.timezone to select your timezone. in /usr/share/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 370
3 <?xml version="1.0" encoding="iso-8859-1"?>
4 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5 <html xmlns="http://www.w3.org/1999/xhtml">
6 <head>
7 <!-- template designed by Marco Von Ballmoos -->
8 <title>Docs For Class EMail</title>
9 <link rel="stylesheet" href="../../media/stylesheet.css" />
10 <script src="../../media/lib/classTree.js"></script>
11 <script language="javascript" type="text/javascript">
12 var imgPlus = new Image();
13 var imgMinus = new Image();
14 imgPlus.src = "../../media/images/plus.png";
15 imgMinus.src = "../../media/images/minus.png";
17 function showNode(Node){
18 switch(navigator.family){
19 case 'nn4':
20 // Nav 4.x code fork...
21 var oTable = document.layers["span" + Node];
22 var oImg = document.layers["img" + Node];
23 break;
24 case 'ie4':
25 // IE 4/5 code fork...
26 var oTable = document.all["span" + Node];
27 var oImg = document.all["img" + Node];
28 break;
29 case 'gecko':
30 // Standards Compliant code fork...
31 var oTable = document.getElementById("span" + Node);
32 var oImg = document.getElementById("img" + Node);
33 break;
35 oImg.src = imgMinus.src;
36 oTable.style.display = "block";
39 function hideNode(Node){
40 switch(navigator.family){
41 case 'nn4':
42 // Nav 4.x code fork...
43 var oTable = document.layers["span" + Node];
44 var oImg = document.layers["img" + Node];
45 break;
46 case 'ie4':
47 // IE 4/5 code fork...
48 var oTable = document.all["span" + Node];
49 var oImg = document.all["img" + Node];
50 break;
51 case 'gecko':
52 // Standards Compliant code fork...
53 var oTable = document.getElementById("span" + Node);
54 var oImg = document.getElementById("img" + Node);
55 break;
57 oImg.src = imgPlus.src;
58 oTable.style.display = "none";
61 function nodeIsVisible(Node){
62 switch(navigator.family){
63 case 'nn4':
64 // Nav 4.x code fork...
65 var oTable = document.layers["span" + Node];
66 break;
67 case 'ie4':
68 // IE 4/5 code fork...
69 var oTable = document.all["span" + Node];
70 break;
71 case 'gecko':
72 // Standards Compliant code fork...
73 var oTable = document.getElementById("span" + Node);
74 break;
76 return (oTable && oTable.style.display == "block");
79 function toggleNodeVisibility(Node){
80 if (nodeIsVisible(Node)){
81 hideNode(Node);
82 }else{
83 showNode(Node);
86 </script>
87 </head>
88 <body>
89 <div class="page-body">
90 <h2 class="class-name"><img src="../../media/images/Class_logo.png"
91 alt=" Class"
92 title=" Class"
93 style="vertical-align: middle"> EMail</h2>
95 <a name="sec-description"></a>
96 <div class="info-box">
97 <div class="info-box-title">Description</div>
98 <div class="nav-bar">
99 <span class="disabled">Description</span> |
100 <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
102 </div>
103 <div class="info-box-body">
105 Warning: strftime(): It is not safe to rely on the system's timezone settings. You are *required* to use the date.timezone setting or the date_default_timezone_set() function. In case you used any of those methods and you are still getting this warning, you most likely misspelled the timezone identifier. We selected the timezone 'UTC' for now, but please set date.timezone to select your timezone. in /usr/share/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 370
106 <!-- ========== Info from phpDoc block ========= -->
107 <p class="short-description">Lightweight class for sending an e-mail.</p>
108 <p class="notes">
109 Located in <a class="field" href="_EMail.php.html">/EMail.php</a> (line <span class="field">16</span>)
110 </p>
113 <pre></pre>
115 </div>
116 </div>
121 <a name="sec-method-summary"></a>
122 <div class="info-box">
123 <div class="info-box-title">Method Summary</span></div>
124 <div class="nav-bar">
125 <a href="#sec-description">Description</a> |
126 <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
127 </div>
128 <div class="info-box-body">
129 <div class="method-summary">
131 <div class="method-definition">
132 <img src="../../media/images/Constructor.png" alt=" "/>
133 <span class="method-result">EMail</span>
134 <a href="#__construct" title="details" class="method-name">__construct</a>
135 ([<span class="var-type">string</span>&nbsp;<span class="var-name">$subject</span> = <span class="var-default">&quot;&quot;</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$to</span> = <span class="var-default">&quot;&quot;</span>])
136 </div>
138 <div class="method-definition">
139 <img src="../../media/images/Method.png" alt=" "/>
140 <span class="method-result">string</span>
141 <a href="#AddBcc" title="details" class="method-name">AddBcc</a>
142 (<span class="var-type">string</span>&nbsp;<span class="var-name">$recipient</span>)
143 </div>
145 <div class="method-definition">
146 <img src="../../media/images/Method.png" alt=" "/>
147 <span class="method-result">string</span>
148 <a href="#AddCc" title="details" class="method-name">AddCc</a>
149 (<span class="var-type">string</span>&nbsp;<span class="var-name">$recipient</span>)
150 </div>
152 <div class="method-definition">
153 <img src="../../media/images/Method.png" alt=" "/>
154 <span class="method-result">string</span>
155 <a href="#AddErrorsTo" title="details" class="method-name">AddErrorsTo</a>
156 (<span class="var-type">string</span>&nbsp;<span class="var-name">$recipient</span>)
157 </div>
159 <div class="method-definition">
160 <img src="../../media/images/Method.png" alt=" "/>
161 <span class="method-result">string</span>
162 <a href="#AddReplyTo" title="details" class="method-name">AddReplyTo</a>
163 (<span class="var-type">string</span>&nbsp;<span class="var-name">$recipient</span>)
164 </div>
166 <div class="method-definition">
167 <img src="../../media/images/Method.png" alt=" "/>
168 <span class="method-result">string</span>
169 <a href="#AddTo" title="details" class="method-name">AddTo</a>
170 (<span class="var-type">string</span>&nbsp;<span class="var-name">$recipient</span>)
171 </div>
173 <div class="method-definition">
174 <img src="../../media/images/Method.png" alt=" "/>
175 <span class="method-result">void</span>
176 <a href="#Pretend" title="details" class="method-name">Pretend</a>
177 ([<span class="var-type">string</span>&nbsp;<span class="var-name">$additional_headers</span> = <span class="var-default">&quot;&quot;</span>])
178 </div>
180 <div class="method-definition">
181 <img src="../../media/images/Method.png" alt=" "/>
182 <span class="method-result">void</span>
183 <a href="#PretendLog" title="details" class="method-name">PretendLog</a>
184 ([<span class="var-type">string</span>&nbsp;<span class="var-name">$additional_headers</span> = <span class="var-default">&quot;&quot;</span>])
185 </div>
187 <div class="method-definition">
188 <img src="../../media/images/Method.png" alt=" "/>
189 <span class="method-result">void</span>
190 <a href="#Send" title="details" class="method-name">Send</a>
191 ([<span class="var-type">string</span>&nbsp;<span class="var-name">$additional_headers</span> = <span class="var-default">&quot;&quot;</span>])
192 </div>
194 <div class="method-definition">
195 <img src="../../media/images/Method.png" alt=" "/>
196 <span class="method-result">string</span>
197 <a href="#SetBody" title="details" class="method-name">SetBody</a>
198 (<span class="var-type"></span>&nbsp;<span class="var-name">$body</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$recipient</span>)
199 </div>
201 <div class="method-definition">
202 <img src="../../media/images/Method.png" alt=" "/>
203 <span class="method-result">string</span>
204 <a href="#SetFrom" title="details" class="method-name">SetFrom</a>
205 (<span class="var-type"></span>&nbsp;<span class="var-name">$sender</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$recipient</span>)
206 </div>
208 <div class="method-definition">
209 <img src="../../media/images/Method.png" alt=" "/>
210 <span class="method-result">string</span>
211 <a href="#SetSender" title="details" class="method-name">SetSender</a>
212 (<span class="var-type"></span>&nbsp;<span class="var-name">$sender</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$recipient</span>)
213 </div>
215 <div class="method-definition">
216 <img src="../../media/images/Method.png" alt=" "/>
217 <span class="method-result">string</span>
218 <a href="#SetSubject" title="details" class="method-name">SetSubject</a>
219 (<span class="var-type"></span>&nbsp;<span class="var-name">$subject</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$recipient</span>)
220 </div>
221 </div>
222 </div>
223 </div>
226 <a name="sec-methods"></a>
227 <div class="info-box">
228 <div class="info-box-title">Methods</div>
229 <div class="nav-bar">
230 <a href="#sec-description">Description</a> |
231 <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
233 </div>
234 <div class="info-box-body">
236 Strict Standards: Only variables should be passed by reference in /usr/share/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 712
238 Warning: strftime(): It is not safe to rely on the system's timezone settings. You are *required* to use the date.timezone setting or the date_default_timezone_set() function. In case you used any of those methods and you are still getting this warning, you most likely misspelled the timezone identifier. We selected the timezone 'UTC' for now, but please set date.timezone to select your timezone. in /usr/share/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 370
239 <A NAME='method_detail'></A>
240 <a name="method__construct" id="__construct"><!-- --></a>
241 <div class="oddrow">
243 <div class="method-header">
244 <img src="../../media/images/Constructor.png" />
245 <span class="method-title">Constructor __construct</span> (line <span class="line-number">82</span>)
246 </div>
248 <!-- ========== Info from phpDoc block ========= -->
249 <p class="short-description">Create the e-mail, optionally assigning the subject and primary recipient.</p>
251 <div class="method-signature">
252 <span class="method-result">EMail</span>
253 <span class="method-name">
254 __construct
255 </span>
256 ([<span class="var-type">string</span>&nbsp;<span class="var-name">$subject</span> = <span class="var-default">&quot;&quot;</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$to</span> = <span class="var-default">&quot;&quot;</span>])
257 </div>
259 <ul class="parameters">
260 <li>
261 <span class="var-type">string</span>
262 <span class="var-name">$subject</span><span class="var-description">: The subject line of the email.</span> </li>
263 <li>
264 <span class="var-type">string</span>
265 <span class="var-name">$to</span><span class="var-description">: A comma-separated list of addresses for the primary recipient(s).</span> </li>
266 </ul>
269 </div>
270 <a name="methodAddBcc" id="AddBcc"><!-- --></a>
271 <div class="evenrow">
273 <div class="method-header">
274 <img src="../../media/images/Method.png" />
275 <span class="method-title">AddBcc</span> (line <span class="line-number">131</span>)
276 </div>
278 <!-- ========== Info from phpDoc block ========= -->
279 <p class="short-description">Add another Bcc recipient to the email</p>
280 <ul class="tags">
281 <li><span class="field">return:</span> The new Bcc recipient list.</li>
282 </ul>
284 <div class="method-signature">
285 <span class="method-result">string</span>
286 <span class="method-name">
287 AddBcc
288 </span>
289 (<span class="var-type">string</span>&nbsp;<span class="var-name">$recipient</span>)
290 </div>
292 <ul class="parameters">
293 <li>
294 <span class="var-type">string</span>
295 <span class="var-name">$recipient</span><span class="var-description">: The email address to append.</span> </li>
296 </ul>
299 </div>
300 <a name="methodAddCc" id="AddCc"><!-- --></a>
301 <div class="oddrow">
303 <div class="method-header">
304 <img src="../../media/images/Method.png" />
305 <span class="method-title">AddCc</span> (line <span class="line-number">122</span>)
306 </div>
308 <!-- ========== Info from phpDoc block ========= -->
309 <p class="short-description">Add another Cc recipient to the email</p>
310 <ul class="tags">
311 <li><span class="field">return:</span> The new Cc recipient list.</li>
312 </ul>
314 <div class="method-signature">
315 <span class="method-result">string</span>
316 <span class="method-name">
317 AddCc
318 </span>
319 (<span class="var-type">string</span>&nbsp;<span class="var-name">$recipient</span>)
320 </div>
322 <ul class="parameters">
323 <li>
324 <span class="var-type">string</span>
325 <span class="var-name">$recipient</span><span class="var-description">: The email address to append.</span> </li>
326 </ul>
329 </div>
330 <a name="methodAddErrorsTo" id="AddErrorsTo"><!-- --></a>
331 <div class="evenrow">
333 <div class="method-header">
334 <img src="../../media/images/Method.png" />
335 <span class="method-title">AddErrorsTo</span> (line <span class="line-number">149</span>)
336 </div>
338 <!-- ========== Info from phpDoc block ========= -->
339 <p class="short-description">Add another Error recipient to the email</p>
340 <ul class="tags">
341 <li><span class="field">return:</span> The new Error recipient list.</li>
342 </ul>
344 <div class="method-signature">
345 <span class="method-result">string</span>
346 <span class="method-name">
347 AddErrorsTo
348 </span>
349 (<span class="var-type">string</span>&nbsp;<span class="var-name">$recipient</span>)
350 </div>
352 <ul class="parameters">
353 <li>
354 <span class="var-type">string</span>
355 <span class="var-name">$recipient</span><span class="var-description">: The email address to append.</span> </li>
356 </ul>
359 </div>
360 <a name="methodAddReplyTo" id="AddReplyTo"><!-- --></a>
361 <div class="oddrow">
363 <div class="method-header">
364 <img src="../../media/images/Method.png" />
365 <span class="method-title">AddReplyTo</span> (line <span class="line-number">140</span>)
366 </div>
368 <!-- ========== Info from phpDoc block ========= -->
369 <p class="short-description">Add another Reply-to address to the email</p>
370 <ul class="tags">
371 <li><span class="field">return:</span> The new Reply-to list.</li>
372 </ul>
374 <div class="method-signature">
375 <span class="method-result">string</span>
376 <span class="method-name">
377 AddReplyTo
378 </span>
379 (<span class="var-type">string</span>&nbsp;<span class="var-name">$recipient</span>)
380 </div>
382 <ul class="parameters">
383 <li>
384 <span class="var-type">string</span>
385 <span class="var-name">$recipient</span><span class="var-description">: The email address to append.</span> </li>
386 </ul>
389 </div>
390 <a name="methodAddTo" id="AddTo"><!-- --></a>
391 <div class="evenrow">
393 <div class="method-header">
394 <img src="../../media/images/Method.png" />
395 <span class="method-title">AddTo</span> (line <span class="line-number">113</span>)
396 </div>
398 <!-- ========== Info from phpDoc block ========= -->
399 <p class="short-description">Add another recipient to the email</p>
400 <ul class="tags">
401 <li><span class="field">return:</span> The new recipient list.</li>
402 </ul>
404 <div class="method-signature">
405 <span class="method-result">string</span>
406 <span class="method-name">
407 AddTo
408 </span>
409 (<span class="var-type">string</span>&nbsp;<span class="var-name">$recipient</span>)
410 </div>
412 <ul class="parameters">
413 <li>
414 <span class="var-type">string</span>
415 <span class="var-name">$recipient</span><span class="var-description">: The email address to append.</span> </li>
416 </ul>
419 </div>
420 <a name="methodPretend" id="Pretend"><!-- --></a>
421 <div class="oddrow">
423 <div class="method-header">
424 <img src="../../media/images/Method.png" />
425 <span class="method-title">Pretend</span> (line <span class="line-number">238</span>)
426 </div>
428 <!-- ========== Info from phpDoc block ========= -->
429 <p class="short-description">Don't actually send the email, just output it directly in the stream(!). We use this method when we're doing regression testing.</p>
431 <div class="method-signature">
432 <span class="method-result">void</span>
433 <span class="method-name">
434 Pretend
435 </span>
436 ([<span class="var-type">string</span>&nbsp;<span class="var-name">$additional_headers</span> = <span class="var-default">&quot;&quot;</span>])
437 </div>
439 <ul class="parameters">
440 <li>
441 <span class="var-type">string</span>
442 <span class="var-name">$additional_headers</span><span class="var-description">: Any additional headers that are needed.</span> </li>
443 </ul>
446 </div>
447 <a name="methodPretendLog" id="PretendLog"><!-- --></a>
448 <div class="evenrow">
450 <div class="method-header">
451 <img src="../../media/images/Method.png" />
452 <span class="method-title">PretendLog</span> (line <span class="line-number">219</span>)
453 </div>
455 <!-- ========== Info from phpDoc block ========= -->
456 <p class="short-description">Don't actually send the email, just log it.</p>
458 <div class="method-signature">
459 <span class="method-result">void</span>
460 <span class="method-name">
461 PretendLog
462 </span>
463 ([<span class="var-type">string</span>&nbsp;<span class="var-name">$additional_headers</span> = <span class="var-default">&quot;&quot;</span>])
464 </div>
466 <ul class="parameters">
467 <li>
468 <span class="var-type">string</span>
469 <span class="var-name">$additional_headers</span><span class="var-description">: Any additional headers that are needed.</span> </li>
470 </ul>
473 </div>
474 <a name="methodSend" id="Send"><!-- --></a>
475 <div class="oddrow">
477 <div class="method-header">
478 <img src="../../media/images/Method.png" />
479 <span class="method-title">Send</span> (line <span class="line-number">202</span>)
480 </div>
482 <!-- ========== Info from phpDoc block ========= -->
483 <p class="short-description">Actually send the email</p>
485 <div class="method-signature">
486 <span class="method-result">void</span>
487 <span class="method-name">
488 Send
489 </span>
490 ([<span class="var-type">string</span>&nbsp;<span class="var-name">$additional_headers</span> = <span class="var-default">&quot;&quot;</span>])
491 </div>
493 <ul class="parameters">
494 <li>
495 <span class="var-type">string</span>
496 <span class="var-name">$additional_headers</span><span class="var-description">: Any additional headers that are needed.</span> </li>
497 </ul>
500 </div>
501 <a name="methodSetBody" id="SetBody"><!-- --></a>
502 <div class="evenrow">
504 <div class="method-header">
505 <img src="../../media/images/Method.png" />
506 <span class="method-title">SetBody</span> (line <span class="line-number">192</span>)
507 </div>
509 <!-- ========== Info from phpDoc block ========= -->
510 <p class="short-description">Set the body of the e-mail.</p>
511 <ul class="tags">
512 <li><span class="field">return:</span> The new body of the e-mail.</li>
513 </ul>
515 <div class="method-signature">
516 <span class="method-result">string</span>
517 <span class="method-name">
518 SetBody
519 </span>
520 (<span class="var-type"></span>&nbsp;<span class="var-name">$body</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$recipient</span>)
521 </div>
523 <ul class="parameters">
524 <li>
525 <span class="var-type">string</span>
526 <span class="var-name">$recipient</span><span class="var-description">: The email address to append.</span> </li>
527 <li>
528 <span class="var-type"></span>
529 <span class="var-name">$body</span> </li>
530 </ul>
533 </div>
534 <a name="methodSetFrom" id="SetFrom"><!-- --></a>
535 <div class="oddrow">
537 <div class="method-header">
538 <img src="../../media/images/Method.png" />
539 <span class="method-title">SetFrom</span> (line <span class="line-number">159</span>)
540 </div>
542 <!-- ========== Info from phpDoc block ========= -->
543 <p class="short-description">Set the visible From address for the e-mail.</p>
544 <ul class="tags">
545 <li><span class="field">return:</span> The new From address</li>
546 </ul>
548 <div class="method-signature">
549 <span class="method-result">string</span>
550 <span class="method-name">
551 SetFrom
552 </span>
553 (<span class="var-type"></span>&nbsp;<span class="var-name">$sender</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$recipient</span>)
554 </div>
556 <ul class="parameters">
557 <li>
558 <span class="var-type">string</span>
559 <span class="var-name">$recipient</span><span class="var-description">: The visible From address</span> </li>
560 <li>
561 <span class="var-type"></span>
562 <span class="var-name">$sender</span> </li>
563 </ul>
566 </div>
567 <a name="methodSetSender" id="SetSender"><!-- --></a>
568 <div class="evenrow">
570 <div class="method-header">
571 <img src="../../media/images/Method.png" />
572 <span class="method-title">SetSender</span> (line <span class="line-number">170</span>)
573 </div>
575 <!-- ========== Info from phpDoc block ========= -->
576 <p class="short-description">Set the envelope sender address for the e-mail.</p>
577 <ul class="tags">
578 <li><span class="field">return:</span> The new envelope sender address.</li>
579 </ul>
581 <div class="method-signature">
582 <span class="method-result">string</span>
583 <span class="method-name">
584 SetSender
585 </span>
586 (<span class="var-type"></span>&nbsp;<span class="var-name">$sender</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$recipient</span>)
587 </div>
589 <ul class="parameters">
590 <li>
591 <span class="var-type">string</span>
592 <span class="var-name">$recipient</span><span class="var-description">: The e-mail address for the sender</span> </li>
593 <li>
594 <span class="var-type"></span>
595 <span class="var-name">$sender</span> </li>
596 </ul>
599 </div>
600 <a name="methodSetSubject" id="SetSubject"><!-- --></a>
601 <div class="oddrow">
603 <div class="method-header">
604 <img src="../../media/images/Method.png" />
605 <span class="method-title">SetSubject</span> (line <span class="line-number">181</span>)
606 </div>
608 <!-- ========== Info from phpDoc block ========= -->
609 <p class="short-description">Set the subject line for the email</p>
610 <ul class="tags">
611 <li><span class="field">return:</span> The new subject line.</li>
612 </ul>
614 <div class="method-signature">
615 <span class="method-result">string</span>
616 <span class="method-name">
617 SetSubject
618 </span>
619 (<span class="var-type"></span>&nbsp;<span class="var-name">$subject</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$recipient</span>)
620 </div>
622 <ul class="parameters">
623 <li>
624 <span class="var-type">string</span>
625 <span class="var-name">$recipient</span><span class="var-description">: The new subject line.</span> </li>
626 <li>
627 <span class="var-type"></span>
628 <span class="var-name">$subject</span> </li>
629 </ul>
632 </div>
634 </div>
635 </div>
639 Warning: strftime(): It is not safe to rely on the system's timezone settings. You are *required* to use the date.timezone setting or the date_default_timezone_set() function. In case you used any of those methods and you are still getting this warning, you most likely misspelled the timezone identifier. We selected the timezone 'UTC' for now, but please set date.timezone to select your timezone. in /usr/share/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 370
640 <p class="notes" id="credit">
641 Documentation generated on Wed, 04 Jul 2012 07:06:14 +0000 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
642 </p>
643 </div></body>
644 </html>