?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
The real release 0.46 :-)
[awl.git] / docs / api / awl / EMail / EMail.html
blob22fdb77cbf8b10b87bd2db450213b7fdf54929f5
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 EMail</title>
7 <link rel="stylesheet" href="../../media/stylesheet.css" />
8 <script src="../../media/lib/classTree.js"></script>
9 <script language="javascript" type="text/javascript">
10 var imgPlus = new Image();
11 var imgMinus = new Image();
12 imgPlus.src = "../../media/images/plus.png";
13 imgMinus.src = "../../media/images/minus.png";
14
15 function showNode(Node){
16 switch(navigator.family){
17 case 'nn4':
18 // Nav 4.x code fork...
19 var oTable = document.layers["span" + Node];
20 var oImg = document.layers["img" + Node];
21 break;
22 case 'ie4':
23 // IE 4/5 code fork...
24 var oTable = document.all["span" + Node];
25 var oImg = document.all["img" + Node];
26 break;
27 case 'gecko':
28 // Standards Compliant code fork...
29 var oTable = document.getElementById("span" + Node);
30 var oImg = document.getElementById("img" + Node);
31 break;
32 }
33 oImg.src = imgMinus.src;
34 oTable.style.display = "block";
35 }
36
37 function hideNode(Node){
38 switch(navigator.family){
39 case 'nn4':
40 // Nav 4.x code fork...
41 var oTable = document.layers["span" + Node];
42 var oImg = document.layers["img" + Node];
43 break;
44 case 'ie4':
45 // IE 4/5 code fork...
46 var oTable = document.all["span" + Node];
47 var oImg = document.all["img" + Node];
48 break;
49 case 'gecko':
50 // Standards Compliant code fork...
51 var oTable = document.getElementById("span" + Node);
52 var oImg = document.getElementById("img" + Node);
53 break;
54 }
55 oImg.src = imgPlus.src;
56 oTable.style.display = "none";
57 }
58
59 function nodeIsVisible(Node){
60 switch(navigator.family){
61 case 'nn4':
62 // Nav 4.x code fork...
63 var oTable = document.layers["span" + Node];
64 break;
65 case 'ie4':
66 // IE 4/5 code fork...
67 var oTable = document.all["span" + Node];
68 break;
69 case 'gecko':
70 // Standards Compliant code fork...
71 var oTable = document.getElementById("span" + Node);
72 break;
73 }
74 return (oTable && oTable.style.display == "block");
75 }
76
77 function toggleNodeVisibility(Node){
78 if (nodeIsVisible(Node)){
79 hideNode(Node);
80 }else{
81 showNode(Node);
82 }
83 }
84 </script>
85 </head>
86 <body>
87 <div class="page-body">
88 <h2 class="class-name"><img src="../../media/images/Class_logo.png"
89 alt=" Class"
90 title=" Class"
91 style="vertical-align: middle"> EMail</h2>
92
93 <a name="sec-description"></a>
94 <div class="info-box">
95 <div class="info-box-title">Description</div>
96 <div class="nav-bar">
97 <span class="disabled">Description</span> |
98 <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
99
100 </div>
101 <div class="info-box-body">
102 <!-- ========== Info from phpDoc block ========= -->
103 <p class="short-description">Lightweight class for sending an e-mail.</p>
104 <p class="notes">
105 Located in <a class="field" href="_EMail.php.html">/EMail.php</a> (line <span class="field">16</span>)
106 </p>
107
108
109 <pre></pre>
110
111 </div>
112 </div>
113
114
115
116
117 <a name="sec-method-summary"></a>
118 <div class="info-box">
119 <div class="info-box-title">Method Summary</span></div>
120 <div class="nav-bar">
121 <a href="#sec-description">Description</a> |
122 <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
123 </div>
124 <div class="info-box-body">
125 <div class="method-summary">
126
127 <div class="method-definition">
128 <img src="../../media/images/Constructor.png" alt=" "/>
129 <span class="method-result">EMail</span>
130 <a href="#EMail" title="details" class="method-name">EMail</a>
131 ([<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>])
132 </div>
133
134 <div class="method-definition">
135 <img src="../../media/images/Method.png" alt=" "/>
136 <span class="method-result">string</span>
137 <a href="#AddBcc" title="details" class="method-name">AddBcc</a>
138 (<span class="var-type">string</span>&nbsp;<span class="var-name">$recipient</span>)
139 </div>
140
141 <div class="method-definition">
142 <img src="../../media/images/Method.png" alt=" "/>
143 <span class="method-result">string</span>
144 <a href="#AddCc" title="details" class="method-name">AddCc</a>
145 (<span class="var-type">string</span>&nbsp;<span class="var-name">$recipient</span>)
146 </div>
147
148 <div class="method-definition">
149 <img src="../../media/images/Method.png" alt=" "/>
150 <span class="method-result">string</span>
151 <a href="#AddErrorsTo" title="details" class="method-name">AddErrorsTo</a>
152 (<span class="var-type">string</span>&nbsp;<span class="var-name">$recipient</span>)
153 </div>
154
155 <div class="method-definition">
156 <img src="../../media/images/Method.png" alt=" "/>
157 <span class="method-result">string</span>
158 <a href="#AddReplyTo" title="details" class="method-name">AddReplyTo</a>
159 (<span class="var-type">string</span>&nbsp;<span class="var-name">$recipient</span>)
160 </div>
161
162 <div class="method-definition">
163 <img src="../../media/images/Method.png" alt=" "/>
164 <span class="method-result">string</span>
165 <a href="#AddTo" title="details" class="method-name">AddTo</a>
166 (<span class="var-type">string</span>&nbsp;<span class="var-name">$recipient</span>)
167 </div>
168
169 <div class="method-definition">
170 <img src="../../media/images/Method.png" alt=" "/>
171 <span class="method-result">void</span>
172 <a href="#Send" title="details" class="method-name">Send</a>
173 (<span class="var-type">string</span>&nbsp;<span class="var-name">$recipient</span>)
174 </div>
175
176 <div class="method-definition">
177 <img src="../../media/images/Method.png" alt=" "/>
178 <span class="method-result">string</span>
179 <a href="#SetBody" title="details" class="method-name">SetBody</a>
180 (<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>)
181 </div>
182
183 <div class="method-definition">
184 <img src="../../media/images/Method.png" alt=" "/>
185 <span class="method-result">string</span>
186 <a href="#SetFrom" title="details" class="method-name">SetFrom</a>
187 (<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>)
188 </div>
189
190 <div class="method-definition">
191 <img src="../../media/images/Method.png" alt=" "/>
192 <span class="method-result">string</span>
193 <a href="#SetSender" title="details" class="method-name">SetSender</a>
194 (<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>)
195 </div>
196
197 <div class="method-definition">
198 <img src="../../media/images/Method.png" alt=" "/>
199 <span class="method-result">string</span>
200 <a href="#SetSubject" title="details" class="method-name">SetSubject</a>
201 (<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>)
202 </div>
203
204 <div class="method-definition">
205 <img src="../../media/images/Method.png" alt=" "/>
206 <span class="method-result">string</span>
207 <a href="#_AppendDelimited" title="details" class="method-name">_AppendDelimited</a>
208 (<span class="var-type">stringref</span>&nbsp;<span class="var-name">&$onto</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$extra</span>)
209 </div>
210 </div>
211 </div>
212 </div>
213
214
215 <a name="sec-methods"></a>
216 <div class="info-box">
217 <div class="info-box-title">Methods</div>
218 <div class="nav-bar">
219 <a href="#sec-description">Description</a> |
220 <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
221
222 </div>
223 <div class="info-box-body">
224 <A NAME='method_detail'></A>
225 <a name="methodEMail" id="EMail"><!-- --></a>
226 <div class="oddrow">
227
228 <div class="method-header">
229 <img src="../../media/images/Constructor.png" />
230 <span class="method-title">Constructor EMail</span> (line <span class="line-number">82</span>)
231 </div>
232
233 <!-- ========== Info from phpDoc block ========= -->
234 <p class="short-description">Create the e-mail, optionally assigning the subject and primary recipient.</p>
235
236 <div class="method-signature">
237 <span class="method-result">EMail</span>
238 <span class="method-name">
239 EMail
240 </span>
241 ([<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>])
242 </div>
243
244 <ul class="parameters">
245 <li>
246 <span class="var-type">string</span>
247 <span class="var-name">$subject</span><span class="var-description">: The subject line of the email.</span> </li>
248 <li>
249 <span class="var-type">string</span>
250 <span class="var-name">$to</span><span class="var-description">: A comma-separated list of addresses for the primary recipient(s).</span> </li>
251 </ul>
252
253
254 </div>
255 <a name="methodAddBcc" id="AddBcc"><!-- --></a>
256 <div class="evenrow">
257
258 <div class="method-header">
259 <img src="../../media/images/Method.png" />
260 <span class="method-title">AddBcc</span> (line <span class="line-number">131</span>)
261 </div>
262
263 <!-- ========== Info from phpDoc block ========= -->
264 <p class="short-description">Add another Bcc recipient to the email</p>
265 <ul class="tags">
266 <li><span class="field">return:</span> The new Bcc recipient list.</li>
267 </ul>
268
269 <div class="method-signature">
270 <span class="method-result">string</span>
271 <span class="method-name">
272 AddBcc
273 </span>
274 (<span class="var-type">string</span>&nbsp;<span class="var-name">$recipient</span>)
275 </div>
276
277 <ul class="parameters">
278 <li>
279 <span class="var-type">string</span>
280 <span class="var-name">$recipient</span><span class="var-description">: The email address to append.</span> </li>
281 </ul>
282
283
284 </div>
285 <a name="methodAddCc" id="AddCc"><!-- --></a>
286 <div class="oddrow">
287
288 <div class="method-header">
289 <img src="../../media/images/Method.png" />
290 <span class="method-title">AddCc</span> (line <span class="line-number">122</span>)
291 </div>
292
293 <!-- ========== Info from phpDoc block ========= -->
294 <p class="short-description">Add another Cc recipient to the email</p>
295 <ul class="tags">
296 <li><span class="field">return:</span> The new Cc recipient list.</li>
297 </ul>
298
299 <div class="method-signature">
300 <span class="method-result">string</span>
301 <span class="method-name">
302 AddCc
303 </span>
304 (<span class="var-type">string</span>&nbsp;<span class="var-name">$recipient</span>)
305 </div>
306
307 <ul class="parameters">
308 <li>
309 <span class="var-type">string</span>
310 <span class="var-name">$recipient</span><span class="var-description">: The email address to append.</span> </li>
311 </ul>
312
313
314 </div>
315 <a name="methodAddErrorsTo" id="AddErrorsTo"><!-- --></a>
316 <div class="evenrow">
317
318 <div class="method-header">
319 <img src="../../media/images/Method.png" />
320 <span class="method-title">AddErrorsTo</span> (line <span class="line-number">149</span>)
321 </div>
322
323 <!-- ========== Info from phpDoc block ========= -->
324 <p class="short-description">Add another Error recipient to the email</p>
325 <ul class="tags">
326 <li><span class="field">return:</span> The new Error recipient list.</li>
327 </ul>
328
329 <div class="method-signature">
330 <span class="method-result">string</span>
331 <span class="method-name">
332 AddErrorsTo
333 </span>
334 (<span class="var-type">string</span>&nbsp;<span class="var-name">$recipient</span>)
335 </div>
336
337 <ul class="parameters">
338 <li>
339 <span class="var-type">string</span>
340 <span class="var-name">$recipient</span><span class="var-description">: The email address to append.</span> </li>
341 </ul>
342
343
344 </div>
345 <a name="methodAddReplyTo" id="AddReplyTo"><!-- --></a>
346 <div class="oddrow">
347
348 <div class="method-header">
349 <img src="../../media/images/Method.png" />
350 <span class="method-title">AddReplyTo</span> (line <span class="line-number">140</span>)
351 </div>
352
353 <!-- ========== Info from phpDoc block ========= -->
354 <p class="short-description">Add another Reply-to address to the email</p>
355 <ul class="tags">
356 <li><span class="field">return:</span> The new Reply-to list.</li>
357 </ul>
358
359 <div class="method-signature">
360 <span class="method-result">string</span>
361 <span class="method-name">
362 AddReplyTo
363 </span>
364 (<span class="var-type">string</span>&nbsp;<span class="var-name">$recipient</span>)
365 </div>
366
367 <ul class="parameters">
368 <li>
369 <span class="var-type">string</span>
370 <span class="var-name">$recipient</span><span class="var-description">: The email address to append.</span> </li>
371 </ul>
372
373
374 </div>
375 <a name="methodAddTo" id="AddTo"><!-- --></a>
376 <div class="evenrow">
377
378 <div class="method-header">
379 <img src="../../media/images/Method.png" />
380 <span class="method-title">AddTo</span> (line <span class="line-number">113</span>)
381 </div>
382
383 <!-- ========== Info from phpDoc block ========= -->
384 <p class="short-description">Add another recipient to the email</p>
385 <ul class="tags">
386 <li><span class="field">return:</span> The new recipient list.</li>
387 </ul>
388
389 <div class="method-signature">
390 <span class="method-result">string</span>
391 <span class="method-name">
392 AddTo
393 </span>
394 (<span class="var-type">string</span>&nbsp;<span class="var-name">$recipient</span>)
395 </div>
396
397 <ul class="parameters">
398 <li>
399 <span class="var-type">string</span>
400 <span class="var-name">$recipient</span><span class="var-description">: The email address to append.</span> </li>
401 </ul>
402
403
404 </div>
405 <a name="methodSend" id="Send"><!-- --></a>
406 <div class="oddrow">
407
408 <div class="method-header">
409 <img src="../../media/images/Method.png" />
410 <span class="method-title">Send</span> (line <span class="line-number">202</span>)
411 </div>
412
413 <!-- ========== Info from phpDoc block ========= -->
414 <p class="short-description">Actually send the email</p>
415
416 <div class="method-signature">
417 <span class="method-result">void</span>
418 <span class="method-name">
419 Send
420 </span>
421 (<span class="var-type">string</span>&nbsp;<span class="var-name">$recipient</span>)
422 </div>
423
424 <ul class="parameters">
425 <li>
426 <span class="var-type">string</span>
427 <span class="var-name">$recipient</span><span class="var-description">: The email address to append.</span> </li>
428 </ul>
429
430
431 </div>
432 <a name="methodSetBody" id="SetBody"><!-- --></a>
433 <div class="evenrow">
434
435 <div class="method-header">
436 <img src="../../media/images/Method.png" />
437 <span class="method-title">SetBody</span> (line <span class="line-number">192</span>)
438 </div>
439
440 <!-- ========== Info from phpDoc block ========= -->
441 <p class="short-description">Set the body of the e-mail.</p>
442 <ul class="tags">
443 <li><span class="field">return:</span> The new body of the e-mail.</li>
444 </ul>
445
446 <div class="method-signature">
447 <span class="method-result">string</span>
448 <span class="method-name">
449 SetBody
450 </span>
451 (<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>)
452 </div>
453
454 <ul class="parameters">
455 <li>
456 <span class="var-type">string</span>
457 <span class="var-name">$recipient</span><span class="var-description">: The email address to append.</span> </li>
458 <li>
459 <span class="var-type"></span>
460 <span class="var-name">$body</span> </li>
461 </ul>
462
463
464 </div>
465 <a name="methodSetFrom" id="SetFrom"><!-- --></a>
466 <div class="oddrow">
467
468 <div class="method-header">
469 <img src="../../media/images/Method.png" />
470 <span class="method-title">SetFrom</span> (line <span class="line-number">159</span>)
471 </div>
472
473 <!-- ========== Info from phpDoc block ========= -->
474 <p class="short-description">Set the visible From address for the e-mail.</p>
475 <ul class="tags">
476 <li><span class="field">return:</span> The new From address</li>
477 </ul>
478
479 <div class="method-signature">
480 <span class="method-result">string</span>
481 <span class="method-name">
482 SetFrom
483 </span>
484 (<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>)
485 </div>
486
487 <ul class="parameters">
488 <li>
489 <span class="var-type">string</span>
490 <span class="var-name">$recipient</span><span class="var-description">: The visible From address</span> </li>
491 <li>
492 <span class="var-type"></span>
493 <span class="var-name">$sender</span> </li>
494 </ul>
495
496
497 </div>
498 <a name="methodSetSender" id="SetSender"><!-- --></a>
499 <div class="evenrow">
500
501 <div class="method-header">
502 <img src="../../media/images/Method.png" />
503 <span class="method-title">SetSender</span> (line <span class="line-number">170</span>)
504 </div>
505
506 <!-- ========== Info from phpDoc block ========= -->
507 <p class="short-description">Set the envelope sender address for the e-mail.</p>
508 <ul class="tags">
509 <li><span class="field">return:</span> The new envelope sender address.</li>
510 </ul>
511
512 <div class="method-signature">
513 <span class="method-result">string</span>
514 <span class="method-name">
515 SetSender
516 </span>
517 (<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>)
518 </div>
519
520 <ul class="parameters">
521 <li>
522 <span class="var-type">string</span>
523 <span class="var-name">$recipient</span><span class="var-description">: The e-mail address for the sender</span> </li>
524 <li>
525 <span class="var-type"></span>
526 <span class="var-name">$sender</span> </li>
527 </ul>
528
529
530 </div>
531 <a name="methodSetSubject" id="SetSubject"><!-- --></a>
532 <div class="oddrow">
533
534 <div class="method-header">
535 <img src="../../media/images/Method.png" />
536 <span class="method-title">SetSubject</span> (line <span class="line-number">181</span>)
537 </div>
538
539 <!-- ========== Info from phpDoc block ========= -->
540 <p class="short-description">Set the subject line for the email</p>
541 <ul class="tags">
542 <li><span class="field">return:</span> The new subject line.</li>
543 </ul>
544
545 <div class="method-signature">
546 <span class="method-result">string</span>
547 <span class="method-name">
548 SetSubject
549 </span>
550 (<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>)
551 </div>
552
553 <ul class="parameters">
554 <li>
555 <span class="var-type">string</span>
556 <span class="var-name">$recipient</span><span class="var-description">: The new subject line.</span> </li>
557 <li>
558 <span class="var-type"></span>
559 <span class="var-name">$subject</span> </li>
560 </ul>
561
562
563 </div>
564 <a name="method_AppendDelimited" id="_AppendDelimited"><!-- --></a>
565 <div class="evenrow">
566
567 <div class="method-header">
568 <img src="../../media/images/Method.png" />
569 <span class="method-title">_AppendDelimited</span> (line <span class="line-number">101</span>)
570 </div>
571
572 <!-- ========== Info from phpDoc block ========= -->
573 <p class="short-description">Append something with a comma delimter onto the existing referenced string</p>
574 <ul class="tags">
575 <li><span class="field">return:</span> The new string.</li>
576 </ul>
577
578 <div class="method-signature">
579 <span class="method-result">string</span>
580 <span class="method-name">
581 _AppendDelimited
582 </span>
583 (<span class="var-type">stringref</span>&nbsp;<span class="var-name">&$onto</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$extra</span>)
584 </div>
585
586 <ul class="parameters">
587 <li>
588 <span class="var-type">stringref</span>
589 <span class="var-name">&$onto</span><span class="var-description">: The string we will be appending to.</span> </li>
590 <li>
591 <span class="var-type">string</span>
592 <span class="var-name">$extra</span><span class="var-description">: What we will be appending</span> </li>
593 </ul>
594
595
596 </div>
597
598 </div>
599 </div>
600
601
602 <p class="notes" id="credit">
603 Documentation generated on Tue, 28 Dec 2010 02:01:36 +1300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
604 </p>
605 </div></body>
606 </html>
Andrew's Web Libraries