1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>Docs For Class Swift_Mime_Headers_MailboxHeader</title>
<link rel="stylesheet" href="../../media/stylesheet.css" />
<script src="../../media/lib/classTree.js"></script>
<link id="webfx-tab-style-sheet" type="text/css" rel="stylesheet" href="../../media/lib/tab.webfx.css" />
<script type="text/javascript" src="../../media/lib/tabpane.js"></script>
<script language="javascript" type="text/javascript" src="../../media/lib/ua.js"></script>
<script language="javascript" type="text/javascript">
var imgPlus = new Image();
var imgMinus = new Image();
imgPlus.src = "../../media/images/plus.gif";
imgMinus.src = "../../media/images/minus.gif";
function showNode(Node){
switch(navigator.family){
case 'nn4':
// Nav 4.x code fork...
var oTable = document.layers["span" + Node];
var oImg = document.layers["img" + Node];
break;
case 'ie4':
// IE 4/5 code fork...
var oTable = document.all["span" + Node];
var oImg = document.all["img" + Node];
break;
case 'gecko':
// Standards Compliant code fork...
var oTable = document.getElementById("span" + Node);
var oImg = document.getElementById("img" + Node);
break;
}
oImg.src = imgMinus.src;
oTable.style.display = "block";
}
function hideNode(Node){
switch(navigator.family){
case 'nn4':
// Nav 4.x code fork...
var oTable = document.layers["span" + Node];
var oImg = document.layers["img" + Node];
break;
case 'ie4':
// IE 4/5 code fork...
var oTable = document.all["span" + Node];
var oImg = document.all["img" + Node];
break;
case 'gecko':
// Standards Compliant code fork...
var oTable = document.getElementById("span" + Node);
var oImg = document.getElementById("img" + Node);
break;
}
oImg.src = imgPlus.src;
oTable.style.display = "none";
}
function nodeIsVisible(Node){
switch(navigator.family){
case 'nn4':
// Nav 4.x code fork...
var oTable = document.layers["span" + Node];
break;
case 'ie4':
// IE 4/5 code fork...
var oTable = document.all["span" + Node];
break;
case 'gecko':
// Standards Compliant code fork...
var oTable = document.getElementById("span" + Node);
break;
}
return (oTable && oTable.style.display == "block");
}
function toggleNodeVisibility(Node){
if (nodeIsVisible(Node)){
hideNode(Node);
}else{
showNode(Node);
}
}
</script>
<!-- template designed by Julien Damon based on PHPEdit's generated templates, and tweaked by Greg Beaver -->
<body bgcolor="#ffffff" >
<!-- Start of Class Data -->
<h2>
Class Swift_Mime_Headers_MailboxHeader
</h2> (line <span class="linenumber">20</span>)
<div class="tab-pane" id="tabPane1">
<script type="text/javascript">
tp1 = new WebFXTabPane( document.getElementById( "tabPane1" ));
</script>
<div class="tab-page" id="Description">
<h2 class="tab">Description</h2>
<pre>
<a href="../../Swift/Mime/Swift_Mime_Headers_AbstractHeader.html">Swift_Mime_Headers_AbstractHeader</a>
|
--Swift_Mime_Headers_MailboxHeader</pre>
<p>
<b><i>Located in File: <a href="_vendors---swiftMailer---classes---Swift---Mime---Headers---MailboxHeader.php.html">/vendors/swiftMailer/classes/Swift/Mime/Headers/MailboxHeader.php</a></i></b><br>
</p>
<!-- ========== Info from phpDoc block ========= -->
<h5>A Mailbox Address MIME Header for something like From or Sender.</h5>
<ul>
<li><strong>author:</strong> - Chris Corbyn</li>
</ul>
<br /><hr />
</div>
<script type="text/javascript">tp1.addTabPage( document.getElementById( "Description" ) );</script>
<div class="tab-page" id="tabPage1">
<h2 class="tab">Class Variables</h2>
<!-- ============ VARIABLE DETAIL =========== -->
<strong>Summary:</strong><br />
<hr />
<script type="text/javascript">tp1.addTabPage( document.getElementById( "tabPage1" ) );</script>
</div>
<div class="tab-page" id="constantsTabpage">
<h2 class="tab">Class Constants</h2>
<!-- ============ VARIABLE DETAIL =========== -->
<strong>Summary:</strong><br />
<hr />
<script type="text/javascript">tp1.addTabPage( document.getElementById( "constantsTabpage" ) );</script>
</div>
<div class="tab-page" id="tabPage2">
<h2 class="tab">Method Detail</h2>
<!-- ============ METHOD DETAIL =========== -->
<strong>Summary:</strong><br />
<div class="method-summary">
<div class="method-definition">
<span class="method-result">Swift_Mime_Headers_MailboxHeader</span>
<a href="#method__construct" title="details" class="method-name">__construct</a>
(<span class="var-type">string</span> <span class="var-name">$name</span>, <span class="var-type"><a href="../../Swift/Mime/Swift_Mime_HeaderEncoder.html">Swift_Mime_HeaderEncoder</a></span> <span class="var-name">$encoder</span>)
</div>
<div class="method-definition">
<span class="method-result">string</span>
<a href="#methodcreateDisplayNameString" title="details" class="method-name">createDisplayNameString</a>
(<span class="var-type">string</span> <span class="var-name">$displayName</span>, [<span class="var-type">boolean</span> <span class="var-name">$shorten</span> = <span class="var-default">false</span>])
</div>
<div class="method-definition">
<span class="method-result">string</span>
<a href="#methodcreateMailboxListString" title="details" class="method-name">createMailboxListString</a>
(<span class="var-type"></span> <span class="var-name">$mailboxes</span>)
</div>
<div class="method-definition">
<span class="method-result">string[]</span>
<a href="#methodgetAddresses" title="details" class="method-name">getAddresses</a>
()
</div>
<div class="method-definition">
<span class="method-result">string</span>
<a href="#methodgetFieldBody" title="details" class="method-name">getFieldBody</a>
()
</div>
<div class="method-definition">
<span class="method-result">array</span>
<a href="#methodgetFieldBodyModel" title="details" class="method-name">getFieldBodyModel</a>
()
</div>
<div class="method-definition">
<span class="method-result">int</span>
<a href="#methodgetFieldType" title="details" class="method-name">getFieldType</a>
()
</div>
<div class="method-definition">
<span class="method-result">string[]</span>
<a href="#methodgetNameAddresses" title="details" class="method-name">getNameAddresses</a>
()
</div>
<div class="method-definition">
<span class="method-result">string[]</span>
<a href="#methodgetNameAddressStrings" title="details" class="method-name">getNameAddressStrings</a>
()
</div>
<div class="method-definition">
<span class="method-result">string[]</span>
<a href="#methodnormalizeMailboxes" title="details" class="method-name">normalizeMailboxes</a>
(<span class="var-type"></span> <span class="var-name">$mailboxes</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#methodremoveAddresses" title="details" class="method-name">removeAddresses</a>
(<span class="var-type">string|string[]</span> <span class="var-name">$addresses</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#methodsetAddresses" title="details" class="method-name">setAddresses</a>
(<span class="var-type">string[]</span> <span class="var-name">$addresses</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#methodsetFieldBodyModel" title="details" class="method-name">setFieldBodyModel</a>
(<span class="var-type">mixed</span> <span class="var-name">$model</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#methodsetNameAddresses" title="details" class="method-name">setNameAddresses</a>
(<span class="var-type">string|string[]</span> <span class="var-name">$mailboxes</span>)
</div>
</div>
<hr />
<A NAME='method_detail'></A>
<a name="method__construct" id="method__construct"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../../media/images/Constructor.gif" border="0" /> <strong class="method">Constructor __construct</strong> (line <span class="linenumber">35</span>)
</h4>
<h4><i>Swift_Mime_Headers_MailboxHeader</i> <strong>__construct(
string
$name, <a href="../../Swift/Mime/Swift_Mime_HeaderEncoder.html">Swift_Mime_HeaderEncoder</a>
$encoder)</strong></h4>
<!-- ========== Info from phpDoc block ========= -->
<h5>Creates a new MailboxHeader with $name.</h5>
<h4>Parameters</h4>
<ul>
<li><strong>string $name</strong>: of Header</li>
<li><strong><a href="../../Swift/Mime/Swift_Mime_HeaderEncoder.html">Swift_Mime_HeaderEncoder</a> $encoder</strong>: </li>
</ul>
<h4>Info</h4>
<ul>
<li><strong>access</strong> - public</li>
</ul>
</div>
<a name="methodcreateDisplayNameString" id="methodcreateDisplayNameString"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method createDisplayNameString</strong> (line <span class="linenumber">253</span>)
</h4>
<h4><i>string</i> <strong>createDisplayNameString(
string
$displayName, [boolean
$shorten = false])</strong></h4>
<!-- ========== Info from phpDoc block ========= -->
<h5>Produces a compliant, formatted display-name based on the string given.</h5>
<h4>Parameters</h4>
<ul>
<li><strong>string $displayName</strong>: as displayed</li>
<li><strong>boolean $shorten</strong>: the first line to make remove for header name</li>
</ul>
<h4>Info</h4>
<ul>
<li><strong>access</strong> - protected</li>
</ul>
</div>
<a name="methodcreateMailboxListString" id="methodcreateMailboxListString"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method createMailboxListString</strong> (line <span class="linenumber">267</span>)
</h4>
<h4><i>string</i> <strong>createMailboxListString(
$mailboxes)</strong></h4>
<!-- ========== Info from phpDoc block ========= -->
<h5>Creates a string form of all the mailboxes in the passed array.</h5>
<h4>Parameters</h4>
<ul>
<li><strong>string[] $mailboxes</strong>: </li>
</ul>
<h4>Info</h4>
<ul>
<li><strong>throws</strong> - Swift_RfcComplianceException</li>
<li><strong>access</strong> - protected</li>
</ul>
</div>
<a name="methodgetAddresses" id="methodgetAddresses"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method getAddresses</strong> (line <span class="linenumber">179</span>)
</h4>
<h4><i>string[]</i> <strong>getAddresses(
)</strong></h4>
<!-- ========== Info from phpDoc block ========= -->
<h5>Get all email addresses in this Header.</h5>
<h4>Info</h4>
<ul>
<li><strong>see</strong> - <a href="../../Swift/Mime/Swift_Mime_Headers_MailboxHeader.html#methodgetNameAddresses">Swift_Mime_Headers_MailboxHeader::getNameAddresses()</a></li>
<li><strong>access</strong> - public</li>
</ul>
</div>
<a name="methodgetFieldBody" id="methodgetFieldBody"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method getFieldBody</strong> (line <span class="linenumber">205</span>)
</h4>
<h4><i>string</i> <strong>getFieldBody(
)</strong></h4>
<!-- ========== Info from phpDoc block ========= -->
<h5>Get the string value of the body in this Header.</h5>
<div class="desc"><p>This is not necessarily RFC 2822 compliant since folding white space will not be added at this stage (see <a href="../../Swift/Mime/Swift_Mime_Headers_AbstractHeader.html#methodtoString">toString()</a> for that).</p></div>
<h4>Info</h4>
<ul>
<li><strong>see</strong> - <a href="../../Swift/Mime/Swift_Mime_Headers_AbstractHeader.html#methodtoString">Swift_Mime_Headers_AbstractHeader::toString()</a></li>
<li><strong>throws</strong> - Swift_RfcComplianceException</li>
<li><strong>access</strong> - public</li>
</ul>
</div>
<a name="methodgetFieldBodyModel" id="methodgetFieldBodyModel"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method getFieldBodyModel</strong> (line <span class="linenumber">70</span>)
</h4>
<h4><i>array</i> <strong>getFieldBodyModel(
)</strong></h4>
<!-- ========== Info from phpDoc block ========= -->
<h5>Get the model for the field body.</h5>
<div class="desc"><p>This method returns an associative array like <a href="../../Swift/Mime/Swift_Mime_Headers_MailboxHeader.html#methodgetNameAddresses">getNameAddresses()</a></p></div>
<h4>Info</h4>
<ul>
<li><strong>throws</strong> - Swift_RfcComplianceException</li>
<li><strong>access</strong> - public</li>
</ul>
</div>
<a name="methodgetFieldType" id="methodgetFieldType"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method getFieldType</strong> (line <span class="linenumber">48</span>)
</h4>
<h4><i>int</i> <strong>getFieldType(
)</strong></h4>
<!-- ========== Info from phpDoc block ========= -->
<h5>Get the type of Header that this instance represents.</h5>
<h4>Info</h4>
<ul>
<li><strong>see</strong> - TYPE_TEXT, TYPE_PARAMETERIZED, TYPE_MAILBOX</li>
<li><strong>see</strong> - TYPE_DATE, TYPE_ID, TYPE_PATH</li>
<li><strong>access</strong> - public</li>
</ul>
</div>
<a name="methodgetNameAddresses" id="methodgetNameAddresses"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method getNameAddresses</strong> (line <span class="linenumber">148</span>)
</h4>
<h4><i>string[]</i> <strong>getNameAddresses(
)</strong></h4>
<!-- ========== Info from phpDoc block ========= -->
<h5>Get all mailboxes in this Header as key=>value pairs.</h5>
<div class="desc"><p>The key is the address and the value is the name (or null if none set). Example: <div class="src-code"><ol><li><div class="src-line"> <strong><?php</strong></div></li>
<li><div class="src-line"> <strong>$header </strong>= new <a href="../../Swift/Mime/Swift_Mime_Headers_MailboxHeader.html">Swift_Mime_Headers_MailboxHeader</a><strong>(</strong><font color="#66cccc">'From'</font><strong>,</strong></div></li>
<li><div class="src-line"> array<strong>(</strong><font color="#66cccc">'chris@swiftmailer.org' </font>=> <font color="#66cccc">'Chris Corbyn'</font><strong>,</strong></div></li>
<li><div class="src-line"> <font color="#66cccc">'mark@swiftmailer.org' </font>=> <font color="#66cccc">'Mark Corbyn'</font><strong>)</strong></div></li>
<li><div class="src-line"> <strong>)</strong><strong>;</strong></div></li>
<li><div class="src-line"> <a href="http://www.php.net/print_r">print_r</a><strong>(</strong><strong>$header</strong><strong>-></strong><a href="../../Swift/Mime/Swift_Mime_Headers_MailboxHeader.html#methodgetNameAddresses">getNameAddresses</a><strong>(</strong><strong>))</strong><strong>;</strong></div></li>
<li><div class="src-line"> <font color="green">// array (</font></div></li>
<li><div class="src-line"> <font color="green">// chris@swiftmailer.org => Chris Corbyn,</font></div></li>
<li><div class="src-line"> <font color="green">// mark@swiftmailer.org => Mark Corbyn</font></div></li>
<li><div class="src-line"> <font color="green">// )</font></div></li>
<li><div class="src-line"> <strong>?></strong></div></li>
</ol></div></p></div>
<h4>Info</h4>
<ul>
<li><strong>see</strong> - <a href="../../Swift/Mime/Swift_Mime_Headers_MailboxHeader.html#methodgetAddresses">Swift_Mime_Headers_MailboxHeader::getAddresses()</a></li>
<li><strong>see</strong> - <a href="../../Swift/Mime/Swift_Mime_Headers_MailboxHeader.html#methodgetNameAddressStrings">Swift_Mime_Headers_MailboxHeader::getNameAddressStrings()</a></li>
<li><strong>access</strong> - public</li>
</ul>
</div>
<a name="methodgetNameAddressStrings" id="methodgetNameAddressStrings"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method getNameAddressStrings</strong> (line <span class="linenumber">122</span>)
</h4>
<h4><i>string[]</i> <strong>getNameAddressStrings(
)</strong></h4>
<!-- ========== Info from phpDoc block ========= -->
<h5>Get the full mailbox list of this Header as an array of valid RFC 2822 strings.</h5>
<div class="desc"><p>Example: <div class="src-code"><ol><li><div class="src-line"> <strong><?php</strong></div></li>
<li><div class="src-line"> <strong>$header </strong>= new <a href="../../Swift/Mime/Swift_Mime_Headers_MailboxHeader.html">Swift_Mime_Headers_MailboxHeader</a><strong>(</strong><font color="#66cccc">'From'</font><strong>,</strong></div></li>
<li><div class="src-line"> array<strong>(</strong><font color="#66cccc">'chris@swiftmailer.org' </font>=> <font color="#66cccc">'Chris Corbyn'</font><strong>,</strong></div></li>
<li><div class="src-line"> <font color="#66cccc">'mark@swiftmailer.org' </font>=> <font color="#66cccc">'Mark Corbyn'</font><strong>)</strong></div></li>
<li><div class="src-line"> <strong>)</strong><strong>;</strong></div></li>
<li><div class="src-line"> <a href="http://www.php.net/print_r">print_r</a><strong>(</strong><strong>$header</strong><strong>-></strong><a href="../../Swift/Mime/Swift_Mime_Headers_MailboxHeader.html#methodgetNameAddressStrings">getNameAddressStrings</a><strong>(</strong><strong>))</strong><strong>;</strong></div></li>
<li><div class="src-line"> <font color="green">// array (</font></div></li>
<li><div class="src-line"> <font color="green">// 0 => Chris Corbyn <chris@swiftmailer.org>,</font></div></li>
<li><div class="src-line"> <font color="green">// 1 => Mark Corbyn <mark@swiftmailer.org></font></div></li>
<li><div class="src-line"> <font color="green">// )</font></div></li>
<li><div class="src-line"> <strong>?></strong></div></li>
</ol></div></p></div>
<h4>Info</h4>
<ul>
<li><strong>see</strong> - <a href="../../Swift/Mime/Swift_Mime_Headers_AbstractHeader.html#methodtoString">Swift_Mime_Headers_AbstractHeader::toString()</a></li>
<li><strong>see</strong> - <a href="../../Swift/Mime/Swift_Mime_Headers_MailboxHeader.html#methodgetNameAddresses">Swift_Mime_Headers_MailboxHeader::getNameAddresses()</a></li>
<li><strong>throws</strong> - Swift_RfcComplianceException</li>
<li><strong>access</strong> - public</li>
</ul>
</div>
<a name="methodnormalizeMailboxes" id="methodnormalizeMailboxes"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method normalizeMailboxes</strong> (line <span class="linenumber">223</span>)
</h4>
<h4><i>string[]</i> <strong>normalizeMailboxes(
$mailboxes)</strong></h4>
<!-- ========== Info from phpDoc block ========= -->
<h5>Normalizes a user-input list of mailboxes into consistent key=>value pairs.</h5>
<h4>Parameters</h4>
<ul>
<li><strong>string[] $mailboxes</strong>: </li>
</ul>
<h4>Info</h4>
<ul>
<li><strong>access</strong> - protected</li>
</ul>
</div>
<a name="methodremoveAddresses" id="methodremoveAddresses"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method removeAddresses</strong> (line <span class="linenumber">188</span>)
</h4>
<h4><i>void</i> <strong>removeAddresses(
string|string[]
$addresses)</strong></h4>
<!-- ========== Info from phpDoc block ========= -->
<h5>Remove one or more addresses from this Header.</h5>
<h4>Parameters</h4>
<ul>
<li><strong>string|string[] $addresses</strong>: </li>
</ul>
<h4>Info</h4>
<ul>
<li><strong>access</strong> - public</li>
</ul>
</div>
<a name="methodsetAddresses" id="methodsetAddresses"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method setAddresses</strong> (line <span class="linenumber">169</span>)
</h4>
<h4><i>void</i> <strong>setAddresses(
string[]
$addresses)</strong></h4>
<!-- ========== Info from phpDoc block ========= -->
<h5>Makes this Header represent a list of plain email addresses with no names.</h5>
<div class="desc"><p>Example: <div class="src-code"><ol><li><div class="src-line"> <strong><?php</strong></div></li>
<li><div class="src-line"> <font color="green">//Sets three email addresses as the Header data</font></div></li>
<li><div class="src-line"> <strong>$header</strong><strong>-></strong><a href="../../Swift/Mime/Swift_Mime_Headers_MailboxHeader.html#methodsetAddresses">setAddresses</a><strong>(</strong></div></li>
<li><div class="src-line"> array<strong>(</strong><font color="#66cccc">'one@domain.tld'</font><strong>, </strong><font color="#66cccc">'two@domain.tld'</font><strong>, </strong><font color="#66cccc">'three@domain.tld'</font><strong>)</strong></div></li>
<li><div class="src-line"> <strong>)</strong><strong>;</strong></div></li>
<li><div class="src-line"> <strong>?></strong></div></li>
</ol></div></p></div>
<h4>Parameters</h4>
<ul>
<li><strong>string[] $addresses</strong>: </li>
</ul>
<h4>Info</h4>
<ul>
<li><strong>see</strong> - setValue()</li>
<li><strong>see</strong> - <a href="../../Swift/Mime/Swift_Mime_Headers_MailboxHeader.html#methodsetNameAddresses">Swift_Mime_Headers_MailboxHeader::setNameAddresses()</a></li>
<li><strong>throws</strong> - Swift_RfcComplianceException</li>
<li><strong>access</strong> - public</li>
</ul>
</div>
<a name="methodsetFieldBodyModel" id="methodsetFieldBodyModel"><!-- --></a>
<div style="background='#ffffff'"><h4>
<img src="../../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method setFieldBodyModel</strong> (line <span class="linenumber">59</span>)
</h4>
<h4><i>void</i> <strong>setFieldBodyModel(
mixed
$model)</strong></h4>
<!-- ========== Info from phpDoc block ========= -->
<h5>Set the model for the field body.</h5>
<div class="desc"><p>This method takes a string, or an array of addresses.</p></div>
<h4>Parameters</h4>
<ul>
<li><strong>mixed $model</strong>: </li>
</ul>
<h4>Info</h4>
<ul>
<li><strong>throws</strong> - Swift_RfcComplianceException</li>
<li><strong>access</strong> - public</li>
</ul>
</div>
<a name="methodsetNameAddresses" id="methodsetNameAddresses"><!-- --></a>
<div style="background='#eeeeee'"><h4>
<img src="../../media/images/PublicMethod.gif" border="0" /> <strong class="method">Method setNameAddresses</strong> (line <span class="linenumber">95</span>)
</h4>
<h4><i>void</i> <strong>setNameAddresses(
string|string[]
$mailboxes)</strong></h4>
<!-- ========== Info from phpDoc block ========= -->
<h5>Set a list of mailboxes to be shown in this Header.</h5>
<div class="desc"><p>The mailboxes can be a simple array of addresses, or an array of key=>value pairs where (email => personalName). Example: <div class="src-code"><ol><li><div class="src-line"> <strong><?php</strong></div></li>
<li><div class="src-line"> <font color="green">//Sets two mailboxes in the Header, one with a personal name</font></div></li>
<li><div class="src-line"> <strong>$header</strong><strong>-></strong><a href="../../Swift/Mime/Swift_Mime_Headers_MailboxHeader.html#methodsetNameAddresses">setNameAddresses</a><strong>(</strong>array<strong>(</strong></div></li>
<li><div class="src-line"> <font color="#66cccc">'chris@swiftmailer.org' </font>=> <font color="#66cccc">'Chris Corbyn'</font><strong>,</strong></div></li>
<li><div class="src-line"> <font color="#66cccc">'mark@swiftmailer.org' </font><font color="green">//No associated personal name</font></div></li>
<li><div class="src-line"> <strong>))</strong><strong>;</strong></div></li>
<li><div class="src-line"> <strong>?></strong></div></li>
</ol></div></p></div>
<h4>Parameters</h4>
<ul>
<li><strong>string|string[] $mailboxes</strong>: </li>
</ul>
<h4>Info</h4>
<ul>
<li><strong>see</strong> - setValue()</li>
<li><strong>see</strong> - <a href="../../Swift/Mime/Swift_Mime_Headers_MailboxHeader.html#methodsetAddresses">Swift_Mime_Headers_MailboxHeader::setAddresses()</a></li>
<li><strong>see</strong> - <a href="../../Swift/Mime/Swift_Mime_Headers_MailboxHeader.html#method__construct">Swift_Mime_Headers_MailboxHeader::__construct()</a></li>
<li><strong>throws</strong> - Swift_RfcComplianceException</li>
<li><strong>access</strong> - public</li>
</ul>
</div>
<script type="text/javascript">tp1.addTabPage( document.getElementById( "tabPage2" ) );</script>
</div>
<div class="tab-page" id="iVars">
<h2 class="tab">Inherited Variables</h2>
<script type="text/javascript">tp1.addTabPage( document.getElementById( "iVars" ) );</script>
<!-- =========== VAR INHERITED SUMMARY =========== -->
<A NAME='var_inherited_summary'><!-- --></A>
<h3>Inherited Class Variable Summary</h3>
</div>
<div class="tab-page" id="iMethods">
<h2 class="tab">Inherited Methods</h2>
<script type="text/javascript">tp1.addTabPage( document.getElementById( "iMethods" ) );</script>
<!-- =========== INHERITED METHOD SUMMARY =========== -->
<A NAME='functions_inherited'><!-- --></A>
<h3>Inherited Method Summary</h3>
<!-- =========== Summary =========== -->
<h4>Inherited From Class <a href="../../Swift/Mime/Swift_Mime_Headers_AbstractHeader.html">Swift_Mime_Headers_AbstractHeader</a></h4>
<h4>
<img src="../../media/images/PublicMethod.gif" border="0" /><strong class="method"> <a href="../../Swift/Mime/Swift_Mime_Headers_AbstractHeader.html#methodclearCachedValueIf">Swift_Mime_Headers_AbstractHeader::clearCachedValueIf()</a></strong> - Clear the cached value if $condition is met.
</h4>
<h4>
<img src="../../media/images/PublicMethod.gif" border="0" /><strong class="method"> <a href="../../Swift/Mime/Swift_Mime_Headers_AbstractHeader.html#methodcreatePhrase">Swift_Mime_Headers_AbstractHeader::createPhrase()</a></strong> - Produces a compliant, formatted RFC 2822 'phrase' based on the string given.
</h4>
<h4>
<img src="../../media/images/PublicMethod.gif" border="0" /><strong class="method"> <a href="../../Swift/Mime/Swift_Mime_Headers_AbstractHeader.html#methodencodeWords">Swift_Mime_Headers_AbstractHeader::encodeWords()</a></strong> - Encode needed word tokens within a string of input.
</h4>
<h4>
<img src="../../media/images/PublicMethod.gif" border="0" /><strong class="method"> <a href="../../Swift/Mime/Swift_Mime_Headers_AbstractHeader.html#methodescapeSpecials">Swift_Mime_Headers_AbstractHeader::escapeSpecials()</a></strong> - Escape special characters in a string (convert to quoted-pairs).
</h4>
<h4>
<img src="../../media/images/PublicMethod.gif" border="0" /><strong class="method"> <a href="../../Swift/Mime/Swift_Mime_Headers_AbstractHeader.html#methodgenerateTokenLines">Swift_Mime_Headers_AbstractHeader::generateTokenLines()</a></strong> - Generates tokens from the given string which include CRLF as individual tokens.
</h4>
<h4>
<img src="../../media/images/PublicMethod.gif" border="0" /><strong class="method"> <a href="../../Swift/Mime/Swift_Mime_Headers_AbstractHeader.html#methodgetCachedValue">Swift_Mime_Headers_AbstractHeader::getCachedValue()</a></strong> - Get the value in the cache.
</h4>
<h4>
<img src="../../media/images/PublicMethod.gif" border="0" /><strong class="method"> <a href="../../Swift/Mime/Swift_Mime_Headers_AbstractHeader.html#methodgetCharset">Swift_Mime_Headers_AbstractHeader::getCharset()</a></strong> - Get the character set used in this Header.
</h4>
<h4>
<img src="../../media/images/PublicMethod.gif" border="0" /><strong class="method"> <a href="../../Swift/Mime/Swift_Mime_Headers_AbstractHeader.html#methodgetEncodableWordTokens">Swift_Mime_Headers_AbstractHeader::getEncodableWordTokens()</a></strong> - Splits a string into tokens in blocks of words which can be encoded quickly.
</h4>
<h4>
<img src="../../media/images/PublicMethod.gif" border="0" /><strong class="method"> <a href="../../Swift/Mime/Swift_Mime_Headers_AbstractHeader.html#methodgetEncoder">Swift_Mime_Headers_AbstractHeader::getEncoder()</a></strong> - Get the encoder used for encoding this Header.
</h4>
<h4>
<img src="../../media/images/PublicMethod.gif" border="0" /><strong class="method"> <a href="../../Swift/Mime/Swift_Mime_Headers_AbstractHeader.html#methodgetFieldName">Swift_Mime_Headers_AbstractHeader::getFieldName()</a></strong> - Get the name of this header (e.g. charset).
</h4>
<h4>
<img src="../../media/images/PublicMethod.gif" border="0" /><strong class="method"> <a href="../../Swift/Mime/Swift_Mime_Headers_AbstractHeader.html#methodgetGrammar">Swift_Mime_Headers_AbstractHeader::getGrammar()</a></strong> - Get the grammar defined for $name token.
</h4>
<h4>
<img src="../../media/images/PublicMethod.gif" border="0" /><strong class="method"> <a href="../../Swift/Mime/Swift_Mime_Headers_AbstractHeader.html#methodgetLanguage">Swift_Mime_Headers_AbstractHeader::getLanguage()</a></strong> - Get the language used in this Header.
</h4>
<h4>
<img src="../../media/images/PublicMethod.gif" border="0" /><strong class="method"> <a href="../../Swift/Mime/Swift_Mime_Headers_AbstractHeader.html#methodgetMaxLineLength">Swift_Mime_Headers_AbstractHeader::getMaxLineLength()</a></strong> - Get the maximum permitted length of lines in this Header.
</h4>
<h4>
<img src="../../media/images/PublicMethod.gif" border="0" /><strong class="method"> <a href="../../Swift/Mime/Swift_Mime_Headers_AbstractHeader.html#methodgetTokenAsEncodedWord">Swift_Mime_Headers_AbstractHeader::getTokenAsEncodedWord()</a></strong> - Get a token as an encoded word for safe insertion into headers.
</h4>
<h4>
<img src="../../media/images/PublicMethod.gif" border="0" /><strong class="method"> <a href="../../Swift/Mime/Swift_Mime_Headers_AbstractHeader.html#methodinitializeGrammar">Swift_Mime_Headers_AbstractHeader::initializeGrammar()</a></strong> - Initialize some RFC 2822 (and friends) ABNF grammar definitions.
</h4>
<h4>
<img src="../../media/images/PublicMethod.gif" border="0" /><strong class="method"> <a href="../../Swift/Mime/Swift_Mime_Headers_AbstractHeader.html#methodsetCachedValue">Swift_Mime_Headers_AbstractHeader::setCachedValue()</a></strong> - Set a value into the cache.
</h4>
<h4>
<img src="../../media/images/PublicMethod.gif" border="0" /><strong class="method"> <a href="../../Swift/Mime/Swift_Mime_Headers_AbstractHeader.html#methodsetCharset">Swift_Mime_Headers_AbstractHeader::setCharset()</a></strong> - Set the character set used in this Header.
</h4>
<h4>
<img src="../../media/images/PublicMethod.gif" border="0" /><strong class="method"> <a href="../../Swift/Mime/Swift_Mime_Headers_AbstractHeader.html#methodsetEncoder">Swift_Mime_Headers_AbstractHeader::setEncoder()</a></strong> - Set the encoder used for encoding the header.
</h4>
<h4>
<img src="../../media/images/PublicMethod.gif" border="0" /><strong class="method"> <a href="../../Swift/Mime/Swift_Mime_Headers_AbstractHeader.html#methodsetFieldName">Swift_Mime_Headers_AbstractHeader::setFieldName()</a></strong> - Set the name of this Header field.
</h4>
<h4>
<img src="../../media/images/PublicMethod.gif" border="0" /><strong class="method"> <a href="../../Swift/Mime/Swift_Mime_Headers_AbstractHeader.html#methodsetLanguage">Swift_Mime_Headers_AbstractHeader::setLanguage()</a></strong> - Set the language used in this Header.
</h4>
<h4>
<img src="../../media/images/PublicMethod.gif" border="0" /><strong class="method"> <a href="../../Swift/Mime/Swift_Mime_Headers_AbstractHeader.html#methodsetMaxLineLength">Swift_Mime_Headers_AbstractHeader::setMaxLineLength()</a></strong> - Set the maximum length of lines in the header (excluding EOL).
</h4>
<h4>
<img src="../../media/images/PublicMethod.gif" border="0" /><strong class="method"> <a href="../../Swift/Mime/Swift_Mime_Headers_AbstractHeader.html#methodtokenNeedsEncoding">Swift_Mime_Headers_AbstractHeader::tokenNeedsEncoding()</a></strong> - Test if a token needs to be encoded or not.
</h4>
<h4>
<img src="../../media/images/PublicMethod.gif" border="0" /><strong class="method"> <a href="../../Swift/Mime/Swift_Mime_Headers_AbstractHeader.html#methodtoString">Swift_Mime_Headers_AbstractHeader::toString()</a></strong> - Get this Header rendered as a RFC 2822 compliant string.
</h4>
<h4>
<img src="../../media/images/PublicMethod.gif" border="0" /><strong class="method"> <a href="../../Swift/Mime/Swift_Mime_Headers_AbstractHeader.html#methodtoTokens">Swift_Mime_Headers_AbstractHeader::toTokens()</a></strong> - Generate a list of all tokens in the final header.
</h4>
<h4>
<img src="../../media/images/PublicMethod.gif" border="0" /><strong class="method"> <a href="../../Swift/Mime/Swift_Mime_Headers_AbstractHeader.html#method__toString">Swift_Mime_Headers_AbstractHeader::__toString()</a></strong> - Returns a string representation of this object.
</h4>
<br />
</div>
</div>
<script type="text/javascript">
//<![CDATA[
setupAllTabs();
//]]>
</script>
<div id="credit">
<hr />
Documentation generated on Fri, 12 Nov 2010 20:45:24 +0000 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</div>
</body>
</html>
|
