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
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
|
<?php
/**
* Zend Framework
*
* LICENSE
*
* This source file is subject to the new BSD license that is bundled
* with this package in the file LICENSE.txt.
* It is also available through the world-wide-web at this URL:
* http://framework.zend.com/license/new-bsd
* If you did not receive a copy of the license and are unable to
* obtain it through the world-wide-web, please send an email
* to license@zend.com so we can send you a copy immediately.
*
* @category Zend
* @package Zend_Mail
* @copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
* @version $Id$
*/
/**
* @see Zend_Mail_Transport_Abstract
*/
/**
* @see Zend_Mime
*/
/**
* @see Zend_Mime_Message
*/
/**
* @see Zend_Mime_Part
*/
/**
* Class for sending an email.
*
* @category Zend
* @package Zend_Mail
* @copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
*/
class Zend_Mail extends Zend_Mime_Message
{
/**#@+
* @access protected
*/
/**
* @var Zend_Mail_Transport_Abstract
* @static
*/
protected static $_defaultTransport = null;
/**
* @var array
* @static
*/
protected static $_defaultFrom;
/**
* @var array
* @static
*/
protected static $_defaultReplyTo;
/**
* Mail character set
* @var string
*/
protected $_charset = 'iso-8859-1';
/**
* Mail headers
* @var array
*/
protected $_headers = array();
/**
* Encoding of Mail headers
* @var string
*/
protected $_headerEncoding = Zend_Mime::ENCODING_QUOTEDPRINTABLE;
/**
* From: address
* @var string
*/
protected $_from = null;
/**
* To: addresses
* @var array
*/
protected $_to = array();
/**
* Array of all recipients
* @var array
*/
protected $_recipients = array();
/**
* Reply-To header
* @var string
*/
protected $_replyTo = null;
/**
* Return-Path header
* @var string
*/
protected $_returnPath = null;
/**
* Subject: header
* @var string
*/
protected $_subject = null;
/**
* Date: header
* @var string
*/
protected $_date = null;
/**
* Message-ID: header
* @var string
*/
protected $_messageId = null;
/**
* text/plain MIME part
* @var false|Zend_Mime_Part
*/
protected $_bodyText = false;
/**
* text/html MIME part
* @var false|Zend_Mime_Part
*/
protected $_bodyHtml = false;
/**
* MIME boundary string
* @var string
*/
protected $_mimeBoundary = null;
/**
* Content type of the message
* @var string
*/
protected $_type = null;
/**#@-*/
/**
* Flag: whether or not email has attachments
* @var boolean
*/
public $hasAttachments = false;
/**
* Sets the default mail transport for all following uses of
* Zend_Mail::send();
*
* @todo Allow passing a string to indicate the transport to load
* @todo Allow passing in optional options for the transport to load
* @param Zend_Mail_Transport_Abstract $transport
*/
public static function setDefaultTransport(Zend_Mail_Transport_Abstract $transport)
{
self::$_defaultTransport = $transport;
}
/**
* Gets the default mail transport for all following uses of
* unittests
*
* @todo Allow passing a string to indicate the transport to load
* @todo Allow passing in optional options for the transport to load
*/
public static function getDefaultTransport()
{
return self::$_defaultTransport;
}
/**
* Clear the default transport property
*/
public static function clearDefaultTransport()
{
self::$_defaultTransport = null;
}
/**
* Public constructor
*
* @param string $charset
*/
public function __construct($charset = null)
{
if ($charset != null) {
$this->_charset = $charset;
}
}
/**
* Return charset string
*
* @return string
*/
public function getCharset()
{
return $this->_charset;
}
/**
* Set content type
*
* Should only be used for manually setting multipart content types.
*
* @param string $type Content type
* @return Zend_Mail Implements fluent interface
* @throws Zend_Mail_Exception for types not supported by Zend_Mime
*/
public function setType($type)
{
$allowed = array(
Zend_Mime::MULTIPART_ALTERNATIVE,
Zend_Mime::MULTIPART_MIXED,
Zend_Mime::MULTIPART_RELATED,
);
if (!in_array($type, $allowed)) {
/**
* @see Zend_Mail_Exception
*/
throw new Zend_Mail_Exception('Invalid content type "' . $type . '"');
}
$this->_type = $type;
return $this;
}
/**
* Get content type of the message
*
* @return string
*/
public function getType()
{
return $this->_type;
}
/**
* Set an arbitrary mime boundary for the message
*
* If not set, Zend_Mime will generate one.
*
* @param string $boundary
* @return Zend_Mail Provides fluent interface
*/
public function setMimeBoundary($boundary)
{
$this->_mimeBoundary = $boundary;
return $this;
}
/**
* Return the boundary string used for the message
*
* @return string
*/
public function getMimeBoundary()
{
return $this->_mimeBoundary;
}
/**
* Return encoding of mail headers
*
* @deprecated use {@link getHeaderEncoding()} instead
* @return string
*/
public function getEncodingOfHeaders()
{
return $this->getHeaderEncoding();
}
/**
* Return the encoding of mail headers
*
* Either Zend_Mime::ENCODING_QUOTEDPRINTABLE or Zend_Mime::ENCODING_BASE64
*
* @return string
*/
public function getHeaderEncoding()
{
return $this->_headerEncoding;
}
/**
* Set the encoding of mail headers
*
* @deprecated Use {@link setHeaderEncoding()} instead.
* @param string $encoding
* @return Zend_Mail
*/
public function setEncodingOfHeaders($encoding)
{
return $this->setHeaderEncoding($encoding);
}
/**
* Set the encoding of mail headers
*
* @param string $encoding Zend_Mime::ENCODING_QUOTEDPRINTABLE or
* Zend_Mime::ENCODING_BASE64
* @return Zend_Mail Provides fluent interface
* @throws Zend_Mail_Exception
*/
public function setHeaderEncoding($encoding)
{
$allowed = array(
Zend_Mime::ENCODING_BASE64,
Zend_Mime::ENCODING_QUOTEDPRINTABLE
);
if (!in_array($encoding, $allowed)) {
/**
* @see Zend_Mail_Exception
*/
throw new Zend_Mail_Exception('Invalid encoding "' . $encoding . '"');
}
$this->_headerEncoding = $encoding;
return $this;
}
/**
* Sets the text body for the message.
*
* @param string $txt
* @param string $charset
* @param string $encoding
* @return Zend_Mail Provides fluent interface
*/
public function setBodyText($txt, $charset = null, $encoding = Zend_Mime::ENCODING_QUOTEDPRINTABLE)
{
if ($charset === null) {
$charset = $this->_charset;
}
$mp = new Zend_Mime_Part($txt);
$mp->encoding = $encoding;
$mp->type = Zend_Mime::TYPE_TEXT;
$mp->disposition = Zend_Mime::DISPOSITION_INLINE;
$mp->charset = $charset;
$this->_bodyText = $mp;
return $this;
}
/**
* Return text body Zend_Mime_Part or string
*
* @param bool $textOnly Whether to return just the body text content or
* the MIME part; defaults to false, the MIME part
* @return false|Zend_Mime_Part|string
*/
public function getBodyText($textOnly = false)
{
if ($textOnly && $this->_bodyText) {
$body = $this->_bodyText;
return $body->getContent();
}
return $this->_bodyText;
}
/**
* Sets the HTML body for the message
*
* @param string $html
* @param string $charset
* @param string $encoding
* @return Zend_Mail Provides fluent interface
*/
public function setBodyHtml($html, $charset = null, $encoding = Zend_Mime::ENCODING_QUOTEDPRINTABLE)
{
if ($charset === null) {
$charset = $this->_charset;
}
$mp = new Zend_Mime_Part($html);
$mp->encoding = $encoding;
$mp->type = Zend_Mime::TYPE_HTML;
$mp->disposition = Zend_Mime::DISPOSITION_INLINE;
$mp->charset = $charset;
$this->_bodyHtml = $mp;
return $this;
}
/**
* Return Zend_Mime_Part representing body HTML
*
* @param bool $htmlOnly Whether to return the body HTML only, or the MIME part; defaults to false, the MIME part
* @return false|Zend_Mime_Part|string
*/
public function getBodyHtml($htmlOnly = false)
{
if ($htmlOnly && $this->_bodyHtml) {
$body = $this->_bodyHtml;
return $body->getContent();
}
return $this->_bodyHtml;
}
/**
* Adds an existing attachment to the mail message
*
* @param Zend_Mime_Part $attachment
* @return Zend_Mail Provides fluent interface
*/
public function addAttachment(Zend_Mime_Part $attachment)
{
$this->addPart($attachment);
$this->hasAttachments = true;
return $this;
}
/**
* Creates a Zend_Mime_Part attachment
*
* Attachment is automatically added to the mail object after creation. The
* attachment object is returned to allow for further manipulation.
*
* @param string $body
* @param string $mimeType
* @param string $disposition
* @param string $encoding
* @param string $filename OPTIONAL A filename for the attachment
* @return Zend_Mime_Part Newly created Zend_Mime_Part object (to allow
* advanced settings)
*/
public function createAttachment($body,
$mimeType = Zend_Mime::TYPE_OCTETSTREAM,
$disposition = Zend_Mime::DISPOSITION_ATTACHMENT,
$encoding = Zend_Mime::ENCODING_BASE64,
$filename = null)
{
$mp = new Zend_Mime_Part($body);
$mp->encoding = $encoding;
$mp->type = $mimeType;
$mp->disposition = $disposition;
$mp->filename = $filename;
$this->addAttachment($mp);
return $mp;
}
/**
* Return a count of message parts
*
* @return integer
*/
public function getPartCount()
{
return count($this->_parts);
}
/**
* Encode header fields
*
* Encodes header content according to RFC1522 if it contains non-printable
* characters.
*
* @param string $value
* @return string
*/
protected function _encodeHeader($value)
{
if (Zend_Mime::isPrintable($value) === false) {
if ($this->getHeaderEncoding() === Zend_Mime::ENCODING_QUOTEDPRINTABLE) {
$value = Zend_Mime::encodeQuotedPrintableHeader($value, $this->getCharset(), Zend_Mime::LINELENGTH, Zend_Mime::LINEEND);
} else {
$value = Zend_Mime::encodeBase64Header($value, $this->getCharset(), Zend_Mime::LINELENGTH, Zend_Mime::LINEEND);
}
}
return $value;
}
/**
* Add a header to the message
*
* Adds a header to this message. If append is true and the header already
* exists, raises a flag indicating that the header should be appended.
*
* @param string $headerName
* @param string $value
* @param bool $append
*/
protected function _storeHeader($headerName, $value, $append = false)
{
if (isset($this->_headers[$headerName])) {
$this->_headers[$headerName][] = $value;
} else {
$this->_headers[$headerName] = array($value);
}
if ($append) {
$this->_headers[$headerName]['append'] = true;
}
}
/**
* Clear header from the message
*
* @param string $headerName
* @deprecated use public method directly
*/
protected function _clearHeader($headerName)
{
$this->clearHeader($headerName);
}
/**
* Helper function for adding a recipient and the corresponding header
*
* @param string $headerName
* @param string $email
* @param string $name
*/
protected function _addRecipientAndHeader($headerName, $email, $name)
{
$email = $this->_filterEmail($email);
$name = $this->_filterName($name);
// prevent duplicates
$this->_recipients[$email] = 1;
$this->_storeHeader($headerName, $this->_formatAddress($email, $name), true);
}
/**
* Adds To-header and recipient, $email can be an array, or a single string
* address
*
* @param string|array $email
* @param string $name
* @return Zend_Mail Provides fluent interface
*/
public function addTo($email, $name='')
{
if (!is_array($email)) {
$email = array($name => $email);
}
foreach ($email as $n => $recipient) {
$this->_addRecipientAndHeader('To', $recipient, is_int($n) ? '' : $n);
$this->_to[] = $recipient;
}
return $this;
}
/**
* Adds Cc-header and recipient, $email can be an array, or a single string
* address
*
* @param string|array $email
* @param string $name
* @return Zend_Mail Provides fluent interface
*/
public function addCc($email, $name='')
{
if (!is_array($email)) {
$email = array($name => $email);
}
foreach ($email as $n => $recipient) {
$this->_addRecipientAndHeader('Cc', $recipient, is_int($n) ? '' : $n);
}
return $this;
}
/**
* Adds Bcc recipient, $email can be an array, or a single string address
*
* @param string|array $email
* @return Zend_Mail Provides fluent interface
*/
public function addBcc($email)
{
if (!is_array($email)) {
$email = array($email);
}
foreach ($email as $recipient) {
$this->_addRecipientAndHeader('Bcc', $recipient, '');
}
return $this;
}
/**
* Return list of recipient email addresses
*
* @return array (of strings)
*/
public function getRecipients()
{
return array_keys($this->_recipients);
}
/**
* Clear header from the message
*
* @param string $headerName
* @return Zend_Mail Provides fluent inter
*/
public function clearHeader($headerName)
{
if (isset($this->_headers[$headerName])){
unset($this->_headers[$headerName]);
}
return $this;
}
/**
* Clears list of recipient email addresses
*
* @return Zend_Mail Provides fluent interface
*/
public function clearRecipients()
{
$this->_recipients = array();
$this->_to = array();
$this->clearHeader('To');
$this->clearHeader('Cc');
$this->clearHeader('Bcc');
return $this;
}
/**
* Sets From-header and sender of the message
*
* @param string $email
* @param string $name
* @return Zend_Mail Provides fluent interface
* @throws Zend_Mail_Exception if called subsequent times
*/
public function setFrom($email, $name = null)
{
if (null !== $this->_from) {
/**
* @see Zend_Mail_Exception
*/
throw new Zend_Mail_Exception('From Header set twice');
}
$email = $this->_filterEmail($email);
$name = $this->_filterName($name);
$this->_from = $email;
$this->_storeHeader('From', $this->_formatAddress($email, $name), true);
return $this;
}
/**
* Set Reply-To Header
*
* @param string $email
* @param string $name
* @return Zend_Mail
* @throws Zend_Mail_Exception if called more than one time
*/
public function setReplyTo($email, $name = null)
{
if (null !== $this->_replyTo) {
/**
* @see Zend_Mail_Exception
*/
throw new Zend_Mail_Exception('Reply-To Header set twice');
}
$email = $this->_filterEmail($email);
$name = $this->_filterName($name);
$this->_replyTo = $email;
$this->_storeHeader('Reply-To', $this->_formatAddress($email, $name), true);
return $this;
}
/**
* Returns the sender of the mail
*
* @return string
*/
public function getFrom()
{
return $this->_from;
}
/**
* Returns the current Reply-To address of the message
*
* @return string|null Reply-To address, null when not set
*/
public function getReplyTo()
{
return $this->_replyTo;
}
/**
* Clears the sender from the mail
*
* @return Zend_Mail Provides fluent interface
*/
public function clearFrom()
{
$this->_from = null;
$this->clearHeader('From');
return $this;
}
/**
* Clears the current Reply-To address from the message
*
* @return Zend_Mail Provides fluent interface
*/
public function clearReplyTo()
{
$this->_replyTo = null;
$this->clearHeader('Reply-To');
return $this;
}
/**
* Sets Default From-email and name of the message
*
* @param string $email
* @param string $name optional
* @return void
*/
public static function setDefaultFrom($email, $name = null)
{
self::$_defaultFrom = array('email' => $email, 'name' => $name);
}
/**
* Returns the default sender of the mail
*
* @return null|array Null if none was set.
*/
public static function getDefaultFrom()
{
return self::$_defaultFrom;
}
/**
* Clears the default sender from the mail
*
* @return void
*/
public static function clearDefaultFrom()
{
self::$_defaultFrom = null;
}
/**
* Sets From-name and -email based on the defaults
*
* @return Zend_Mail Provides fluent interface
* @throws Zend_Mail_Exception
*/
public function setFromToDefaultFrom() {
$from = self::getDefaultFrom();
if($from === null) {
throw new Zend_Mail_Exception(
'No default From Address set to use');
}
$this->setFrom($from['email'], $from['name']);
return $this;
}
/**
* Sets Default ReplyTo-address and -name of the message
*
* @param string $email
* @param string $name optional
* @return void
*/
public static function setDefaultReplyTo($email, $name = null)
{
self::$_defaultReplyTo = array('email' => $email, 'name' => $name);
}
/**
* Returns the default Reply-To Address and Name of the mail
*
* @return null|array Null if none was set.
*/
public static function getDefaultReplyTo()
{
return self::$_defaultReplyTo;
}
/**
* Clears the default ReplyTo-address and -name from the mail
*
* @return void
*/
public static function clearDefaultReplyTo()
{
self::$_defaultReplyTo = null;
}
/**
* Sets ReplyTo-name and -email based on the defaults
*
* @return Zend_Mail Provides fluent interface
* @throws Zend_Mail_Exception
*/
public function setReplyToFromDefault() {
$replyTo = self::getDefaultReplyTo();
if($replyTo === null) {
throw new Zend_Mail_Exception(
'No default Reply-To Address set to use');
}
$this->setReplyTo($replyTo['email'], $replyTo['name']);
return $this;
}
/**
* Sets the Return-Path header of the message
*
* @param string $email
* @return Zend_Mail Provides fluent interface
* @throws Zend_Mail_Exception if set multiple times
*/
public function setReturnPath($email)
{
if ($this->_returnPath === null) {
$email = $this->_filterEmail($email);
$this->_returnPath = $email;
$this->_storeHeader('Return-Path', $email, false);
} else {
/**
* @see Zend_Mail_Exception
*/
throw new Zend_Mail_Exception('Return-Path Header set twice');
}
return $this;
}
/**
* Returns the current Return-Path address of the message
*
* If no Return-Path header is set, returns the value of {@link $_from}.
*
* @return string
*/
public function getReturnPath()
{
if (null !== $this->_returnPath) {
return $this->_returnPath;
}
return $this->_from;
}
/**
* Clears the current Return-Path address from the message
*
* @return Zend_Mail Provides fluent interface
*/
public function clearReturnPath()
{
$this->_returnPath = null;
$this->clearHeader('Return-Path');
return $this;
}
/**
* Sets the subject of the message
*
* @param string $subject
* @return Zend_Mail Provides fluent interface
* @throws Zend_Mail_Exception
*/
public function setSubject($subject)
{
if ($this->_subject === null) {
$subject = $this->_filterOther($subject);
$this->_subject = $this->_encodeHeader($subject);
$this->_storeHeader('Subject', $this->_subject);
} else {
/**
* @see Zend_Mail_Exception
*/
throw new Zend_Mail_Exception('Subject set twice');
}
return $this;
}
/**
* Returns the encoded subject of the message
*
* @return string
*/
public function getSubject()
{
return $this->_subject;
}
/**
* Clears the encoded subject from the message
*
* @return Zend_Mail Provides fluent interface
*/
public function clearSubject()
{
$this->_subject = null;
$this->clearHeader('Subject');
return $this;
}
/**
* Sets Date-header
*
* @param int|string|Zend_Date $date
* @return Zend_Mail Provides fluent interface
* @throws Zend_Mail_Exception if called subsequent times or wrong date
* format.
*/
public function setDate($date = null)
{
if ($this->_date === null) {
if ($date === null) {
$date = date('r');
} else if (is_int($date)) {
$date = date('r', $date);
} else if (is_string($date)) {
$date = strtotime($date);
if ($date === false || $date < 0) {
/**
* @see Zend_Mail_Exception
*/
throw new Zend_Mail_Exception('String representations of Date Header must be ' .
'strtotime()-compatible');
}
$date = date('r', $date);
} else if ($date instanceof Zend_Date) {
$date = $date->get(Zend_Date::RFC_2822);
} else {
/**
* @see Zend_Mail_Exception
*/
throw new Zend_Mail_Exception(__METHOD__ . ' only accepts UNIX timestamps, Zend_Date objects, ' .
' and strtotime()-compatible strings');
}
$this->_date = $date;
$this->_storeHeader('Date', $date);
} else {
/**
* @see Zend_Mail_Exception
*/
throw new Zend_Mail_Exception('Date Header set twice');
}
return $this;
}
/**
* Returns the formatted date of the message
*
* @return string
*/
public function getDate()
{
return $this->_date;
}
/**
* Clears the formatted date from the message
*
* @return Zend_Mail Provides fluent interface
*/
public function clearDate()
{
$this->_date = null;
$this->clearHeader('Date');
return $this;
}
/**
* Sets the Message-ID of the message
*
* @param boolean|string $id
* true :Auto
* false :No set
* null :No set
* string:Sets given string (Angle brackets is not necessary)
* @return Zend_Mail Provides fluent interface
* @throws Zend_Mail_Exception
*/
public function setMessageId($id = true)
{
if ($id === null || $id === false) {
return $this;
} elseif ($id === true) {
$id = $this->createMessageId();
}
if ($this->_messageId === null) {
$id = $this->_filterOther($id);
$this->_messageId = $id;
$this->_storeHeader('Message-Id', '<' . $this->_messageId . '>');
} else {
/**
* @see Zend_Mail_Exception
*/
throw new Zend_Mail_Exception('Message-ID set twice');
}
return $this;
}
/**
* Returns the Message-ID of the message
*
* @return string
*/
public function getMessageId()
{
return $this->_messageId;
}
/**
* Clears the Message-ID from the message
*
* @return Zend_Mail Provides fluent interface
*/
public function clearMessageId()
{
$this->_messageId = null;
$this->clearHeader('Message-Id');
return $this;
}
/**
* Creates the Message-ID
*
* @return string
*/
public function createMessageId() {
$time = time();
if ($this->_from !== null) {
$user = $this->_from;
} elseif (isset($_SERVER['REMOTE_ADDR'])) {
$user = $_SERVER['REMOTE_ADDR'];
} else {
$user = getmypid();
}
$rand = mt_rand();
if ($this->_recipients !== array()) {
$recipient = array_rand($this->_recipients);
} else {
$recipient = 'unknown';
}
if (isset($_SERVER["SERVER_NAME"])) {
$hostName = $_SERVER["SERVER_NAME"];
} else {
$hostName = php_uname('n');
}
return sha1($time . $user . $rand . $recipient) . '@' . $hostName;
}
/**
* Add a custom header to the message
*
* @param string $name
* @param string $value
* @param boolean $append
* @return Zend_Mail Provides fluent interface
* @throws Zend_Mail_Exception on attempts to create standard headers
*/
public function addHeader($name, $value, $append = false)
{
$prohibit = array('to', 'cc', 'bcc', 'from', 'subject',
'reply-to', 'return-path',
'date', 'message-id',
);
if (in_array(strtolower($name), $prohibit)) {
/**
* @see Zend_Mail_Exception
*/
throw new Zend_Mail_Exception('Cannot set standard header from addHeader()');
}
$value = $this->_filterOther($value);
$value = $this->_encodeHeader($value);
$this->_storeHeader($name, $value, $append);
return $this;
}
/**
* Return mail headers
*
* @return array
*/
public function getHeaders()
{
return $this->_headers;
}
/**
* Sends this email using the given transport or a previously
* set DefaultTransport or the internal mail function if no
* default transport had been set.
*
* @param Zend_Mail_Transport_Abstract $transport
* @return Zend_Mail Provides fluent interface
*/
public function send($transport = null)
{
if ($transport === null) {
if (! self::$_defaultTransport instanceof Zend_Mail_Transport_Abstract) {
$transport = new Zend_Mail_Transport_Sendmail();
} else {
$transport = self::$_defaultTransport;
}
}
if ($this->_date === null) {
$this->setDate();
}
if(null === $this->_from && null !== self::getDefaultFrom()) {
$this->setFromToDefaultFrom();
}
if(null === $this->_replyTo && null !== self::getDefaultReplyTo()) {
$this->setReplyToFromDefault();
}
$transport->send($this);
return $this;
}
/**
* Filter of email data
*
* @param string $email
* @return string
*/
protected function _filterEmail($email)
{
$rule = array("\r" => '',
"\n" => '',
"\t" => '',
'"' => '',
',' => '',
'<' => '',
'>' => '',
);
return strtr($email, $rule);
}
/**
* Filter of name data
*
* @param string $name
* @return string
*/
protected function _filterName($name)
{
$rule = array("\r" => '',
"\n" => '',
"\t" => '',
'"' => "'",
'<' => '[',
'>' => ']',
);
return trim(strtr($name, $rule));
}
/**
* Filter of other data
*
* @param string $data
* @return string
*/
protected function _filterOther($data)
{
$rule = array("\r" => '',
"\n" => '',
"\t" => '',
);
return strtr($data, $rule);
}
/**
* Formats e-mail address
*
* @param string $email
* @param string $name
* @return string
*/
protected function _formatAddress($email, $name)
{
if ($name === '' || $name === null || $name === $email) {
return $email;
} else {
$encodedName = $this->_encodeHeader($name);
if ($encodedName === $name && strcspn($name, '()<>[]:;@\\,.') != strlen($name)) {
$format = '"%s" <%s>';
} else {
$format = '%s <%s>';
}
return sprintf($format, $encodedName, $email);
}
}
}
|