forked from rbairwell/PHP-Bounce-Handler
-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathbounce_driver.class.php
1715 lines (1613 loc) · 58.9 KB
/
bounce_driver.class.php
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
<?php
/**
* BOUNCE HANDLER Class, Version 7.4
*
* Tries to extract information about why an email bounced.
*
* PHP version 5.3
*
* The BSD License
* Copyright (c) 2006-forever, Chris Fortune http://cfortune.kics.bc.ca
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* - Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
* - Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* - Neither the name of the BounceHandler nor the names of its contributors may
* be used to endorse or promote products derived from this
* software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
* OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
* ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* @category Email
* @package BounceHandler
* @author Chris Fortune <[email protected]>
* Original development. http://cfortune.kics.bc.ca
* @author Richard Bairwell <[email protected]>
* Code cleanups and restructuring. http://blog.rac.me.uk
* @author "Kanon" <[email protected]>
* @author Jamie McClelland <[email protected]>
* https://mayfirst.org/jamie-mcclelland
* @author Michael Cooper <[email protected]>
* @author Thomas Seifert <[email protected]>
* @author Tim Petrowsky <[email protected]>
* http://neuecouch.de
* @author Willy T. Koch <[email protected]>
* http://apeland.no
* @author ganeshaspeaks.com <[email protected]>
* FBL development
* @author Richard Catto <[email protected]>
* FBL development
* @author Scott Brynen <[email protected]>
* FBL development http://visioncritical.com
* https://github.com/visioncritical/PHP-Bounce-Handler
* @copyright 2006-2014 Chris Fortune and others.
* @license http://opensource.org/licenses/BSD-2-Clause BSD
* @link https://github.com/cfortune/PHP-Bounce-Handler/
* @link http://www.anti-spam-man.com/php_bouncehandler/v7.3/
* @link http://www.phpclasses.org/browse/file/11665.html
*/
/**
* Class BounceHandler.
*
* Interprets email bounces.
*
* @category Email
* @package BounceHandler
* @author Multiple <[email protected]>
* @license http://opensource.org/licenses/BSD-2-Clause BSD
* @link https://github.com/cfortune/PHP-Bounce-Handler/
*/
class BounceHandler
{
/**
* Extracted header information.
*
* @var array
*/
public $head_hash = array();
/**
* Extracted ARF/FBL data.
*
* @var array
*/
public $fbl_hash = array();
/**
* Extracted returned body part data.
*
* @var array
*/
public $returned_hash = array();
/**
* Not necessary(?)
*
* @var array
*/
public $body_hash = array();
/**
* Set if this looks like a bounce.
*
* @var bool
*/
public $looks_like_a_bounce = false;
/**
* Set if this looks like an ARF/FBL "abuse" request.
*
* @var bool
*/
public $looks_like_an_FBL = false;
/**
* Set if this looks like an autoresponder.
*
* @var bool
*/
public $looks_like_an_autoresponse = false;
/**
* Set if this looks like a Hotmail FBL request.
*
* @var bool
*/
public $is_hotmail_fbl = false;
/**
* Regular expression to look for web beacons from emails.
*
* E.g. <img src="http://mysite.com/track.php?u=userId12345">
*
* @var string
*/
public $web_beacon_preg_1 = "";
/**
* Regular expression to look for web beacons from emails.
*
* E.g. <img src="http://mysite.com/track.php?u=userId12345">
*
* @var string
*/
public $web_beacon_preg_2 = "";
/**
* String to look for beacons in the email headers.
*
* E.g. X-my-custom-header: userId12345
*
* @var string
*/
public $x_header_search_1 = "";
/**
* String to look for beacons in the email headers.
*
* E.g. X-my-custom-header: userId12345
*
* @var string
*/
public $x_header_search_2 = "";
/**
* Type of email - either autoresponse, fbl, bounce or "false"
*
* @var string|bool
*/
public $type = false;
/**
* Result of the $web_beacon_preg_1 regular expression.
*
* @var string
*/
public $web_beacon_1 = "";
/**
* Result of the $web_beacon_preg_2 regular expression.
*
* @var string
*/
public $web_beacon_2 = "";
/**
* FBL feedback type if any.
*
* @var string
*/
public $feedback_type = "";
/**
* Result of the x_header_search_1 search.
*
* @var string
*/
public $x_header_beacon_1 = "";
/**
* Result of the x_header_search_2 search.
*
* @var string
*/
public $x_header_beacon_2 = "";
/**
* An accessor for $this->_bouncehandler->get_the_facts()[0]['action']
*
* Recommendation action for the email.
*
* Only useful for FBL's or if the output array only has one index
*
* @var string
*/
public $action = "";
/**
* An accessor for $this->_bouncehandler->get_the_facts()[0]['status'].
*
* Status of the email.
* Only useful for FBL's or if the output array only has one index.
*
* @var string
*/
public $status = "";
/**
* An accessor for $this->_bouncehandler->get_the_facts()[0]['subect'].
*
* Subject of the email.
* Only useful for FBL's or if the output array only has one index.
*
* @var string
*/
public $subject = "";
/**
* An accessor for $this->_bouncehandler->get_the_facts()[0]['recipient'].
*
* Recipient of the original email.
* Only useful for FBL's or if the output array only has one index.
*
* @var string
*/
public $recipient = "";
/**
* @var array
*/
public $output = array();
/**
* Our cached list of bounce strings to look out for.
*
* @var array
*/
private $_bouncelist = array();
/**
* Cached list of auto-respond subjects to look out for.
*
* @var array
*/
private $_autorespondlist = array();
/**
* Cached list of bounce subjects to look out for.
*
* @var array
*/
private $_bouncesubj = array();
/**
* @var array
*/
private $_first_body_hash = array();
/**
* If this is an auto-response, how did we detect it?
*
* @var string
*/
private $_autoresponse = '';
/**
* Constructor.
*
* If bouncelist, autorespondlist or bouncesubj is empty, then load them
* in from the bounce_responses.php file.
*
* @param array $bouncelist text in messages from which to figure out
* kind of bounce this is.
* @param array $autorespondlist triggers for autoresponders
* @param array $bouncesubj trigger subject lines for bounces
*/
public function __construct(
$bouncelist = array(),
$autorespondlist = array(),
$bouncesubj = array()
) {
$this->_bouncelist = $bouncelist;
$this->_autorespondlist = $autorespondlist;
$this->_bouncesubj = $bouncesubj;
if (empty($bouncelist) || empty($autorespondlist)
|| empty($bouncesubj)
) {
include 'bounce_responses.php';
if (empty($this->_bouncelist)) {
$this->_bouncelist = $bouncelist;
}
if (empty($this->_autorespondlist)) {
$this->_autorespondlist = $autorespondlist;
}
if (empty($bouncesubj)) {
$this->_bouncesubj = $bouncesubj;
}
}
$this->init_bouncehandler();
}
/**
* Most commonly used public method - quick and dirty email parsing.
*
* Usage: $multiArray = $this->get_the_facts($strEmail);
*
* @param string $eml Contents of the email.
*
* @return array
*/
public function parse_email($eml)
{
return $this->get_the_facts($eml);
}
/**
* Gets the facts about the email
*
* @param string $eml Contents of the email.
*
* @return array
*/
public function get_the_facts($eml)
{
// fluff up the email
$bounce = $this->init_bouncehandler($eml);
if (strpos($bounce, "\r\n\r\n") !== false) {
list($head, $body) = preg_split("/\r\n\r\n/", $bounce, 2);
} else {
list($head, $body) = array($bounce, '');
}
$this->head_hash = $this->parse_head($head);
// parse the email into data structures
$boundary = isset($this->head_hash['Content-type']['boundary'])
? $this->head_hash['Content-type']['boundary'] : '';
$mime_sections = $this->parse_body_into_mime_sections($body, $boundary);
$this->body_hash = preg_split("/\r\n/", $body);
$this->_first_body_hash = isset($mime_sections['first_body_part'])
? $this->parse_head($mime_sections['first_body_part']) : array();
$this->looks_like_a_bounce
= $this->is_RFC1892_multipart_report() || $this->is_a_bounce();
$this->looks_like_an_FBL = $this->is_an_ARF();
$this->looks_like_an_autoresponse = $this->is_an_autoresponse();
/* now we try all our weird text parsing methods (E-mail is weird!) */
/**
* Is it a feedback loop in abuse feedback reporting format (ARF)?
*
* @link http://en.wikipedia.org/wiki/Abuse_Reporting_Format
* #Abuse_Feedback_Reporting_Format_.28ARF.29
*/
if ($this->looks_like_an_FBL) {
$this->output[0]['action'] = 'failed';
$this->output[0]['status'] = "5.7.1";
$this->subject = trim(
str_ireplace("Fw:", "", $this->head_hash['Subject'])
);
if ($this->is_hotmail_fbl === true) {
// fill in the fbl_hash with sensible values
$this->fbl_hash['Source-ip'] = '';
$this->fbl_hash['Original-mail-from'] = '';
$this->fbl_hash['Original-rcpt-to'] = '';
$this->fbl_hash['Feedback-type'] = 'abuse';
$this->fbl_hash['Content-disposition'] = 'inline';
$this->fbl_hash['Content-type'] = 'message/feedback-report';
$this->fbl_hash['User-agent'] = 'Hotmail FBL';
if (isset($this->_first_body_hash['Date'])) {
$this->fbl_hash['Received-date']
= $this->_first_body_hash['Date'];
}
if (isset($this->head_hash['Subject'])
&& preg_match(
'/complaint about message from ([0-9.]+)/',
$this->head_hash['Subject'], $matches
)
) {
$this->fbl_hash['Source-ip'] = $matches[1];
}
if (!empty($this->recipient)) {
$this->fbl_hash['Original-rcpt-to'] = $this->recipient;
}
if (isset($this->_first_body_hash['X-sid-pra'])) {
$this->fbl_hash['Original-mail-from']
= $this->_first_body_hash['X-sid-pra'];
}
} else {
$this->fbl_hash = $this->standard_parser(
$mime_sections['machine_parsable_body_part']
);
$returnedhash = $this->standard_parser(
$mime_sections['returned_message_body_part']
);
if (!empty($returnedhash['Return-path'])) {
$this->fbl_hash['Original-mail-from']
= $returnedhash['Return-path'];
} elseif (empty($this->fbl_hash['Original-mail-from'])
&& !empty($returnedhash['From'])
) {
$this->fbl_hash['Original-mail-from']
= $returnedhash['From'];
}
if (empty($this->fbl_hash['Original-rcpt-to'])
&& !empty($this->fbl_hash['Removal-recipient'])
) {
$this->fbl_hash['Original-rcpt-to']
= $this->fbl_hash['Removal-recipient'];
} elseif (isset($returnedhash['To'])) {
$this->fbl_hash['Original-rcpt-to'] = $returnedhash['To'];
} else {
$this->fbl_hash['Original-rcpt-to'] = '';
}
if (!isset($this->fbl_hash['Source-ip'])) {
if (!empty($returnedhash['X-originating-ip'])) {
$this->fbl_hash['Source-ip']
= $this->_strip_angle_brackets(
$returnedhash['X-originating-ip']
);
} else {
$this->fbl_hash['Source-ip'] = '';
}
}
}
// warning, some servers will remove the name of the original
// intended recipient from the FBL report,
// replacing it with [email protected], making it utterly
// useless, of course (unless you used a web-beacon).
// here we try our best to give you the actual intended recipient,
// if possible.
if (preg_match(
'/Undisclosed|redacted/i',
$this->fbl_hash['Original-rcpt-to']
)
&& isset($this->fbl_hash['Removal-recipient'])
) {
$this->fbl_hash['Original-rcpt-to']
= @$this->fbl_hash['Removal-recipient'];
}
if (empty($this->fbl_hash['Received-date'])
&& !empty($this->fbl_hash[@'Arrival-date'])
) {
$this->fbl_hash['Received-date']
= @$this->fbl_hash['Arrival-date'];
}
$this->fbl_hash['Original-mail-from'] = $this->_strip_angle_brackets(
@$this->fbl_hash['Original-mail-from']
);
$this->fbl_hash['Original-rcpt-to'] = $this->_strip_angle_brackets(
@$this->fbl_hash['Original-rcpt-to']
);
$this->output[0]['recipient'] = $this->fbl_hash['Original-rcpt-to'];
} elseif ($this->looks_like_an_autoresponse) {
// is this an autoresponse ?
$this->output[0]['action'] = 'autoresponse';
$this->output[0]['autoresponse'] = $this->_autoresponse;
$this->output[0]['status'] = '2.0';
// grab the first recipient and break
$this->output[0]['recipient']
= isset($this->head_hash['Return-path'])
? $this->_strip_angle_brackets($this->head_hash['Return-path'])
: '';
if (empty($this->output[0]['recipient'])) {
$this->output[0]['recipient']
= isset($this->head_hash['From'])
? $this->_strip_angle_brackets($this->head_hash['From'])
: '';
}
if (empty($this->output[0]['recipient'])) {
$arrFailed = $this->find_email_addresses($body);
for ($j = 0; $j < count($arrFailed); $j++) {
$this->output[$j]['recipient'] = trim($arrFailed[$j]);
break;
}
}
} else if ($this->is_RFC1892_multipart_report() === true) {
$this->returned_hash = isset($mime_sections['returned_message_body_part'])
? $this->get_head_from_returned_message_body_part($mime_sections) : array();
$rpt_hash = $this->parse_machine_parsable_body_part(
$mime_sections['machine_parsable_body_part']
);
if (isset($rpt_hash['per_recipient'])) {
for ($i = 0; $i < count($rpt_hash['per_recipient']); $i++) {
$this->output[$i]['recipient'] = $this->find_recipient(
$rpt_hash['per_recipient'][$i]
);
$mycode = @$this->format_status_code(
$rpt_hash['per_recipient'][$i]['Status']
);
$this->output[$i]['status'] = $mycode['code'];
$this->output[$i]['action']
= $this->get_action_from_status_code($mycode['code']);
$this->output[$i]['diagnosticCode'] = $this->format_diagnostic_code(
$rpt_hash['per_recipient'][$i]['Diagnostic-code']
);
}
} else {
$arrFailed = $this->find_email_addresses(
$mime_sections['first_body_part']
);
for ($j = 0; $j < count($arrFailed); $j++) {
$this->output[$j]['recipient'] = trim($arrFailed[$j]);
$this->output[$j]['status']
= $this->get_status_code_from_text(
$this->output[$j]['recipient'], 0
);
$this->output[$j]['action']
= $this->get_action_from_status_code(
$this->output[$j]['status']
);
}
}
} else if (isset($this->head_hash['X-failed-recipients'])) {
$this->returned_hash = $this->get_head_from_message_body();
// Busted Exim MTA
// Up to 50 email addresses can be listed on each header.
// There can be multiple X-Failed-Recipients: headers. - (not supported)
$arrFailed = explode(',', $this->head_hash['X-failed-recipients']);
for ($j = 0; $j < count($arrFailed); $j++) {
$this->output[$j]['recipient'] = trim($arrFailed[$j]);
$this->output[$j]['status'] = $this->get_status_code_from_text(
$this->output[$j]['recipient'], 0
);
$this->output[$j]['action']
= $this->get_action_from_status_code(
$this->output[$j]['status']
);
$this->looks_like_a_bounce = true;
}
} else {
if (!empty($boundary)) {
// oh god it could be anything, but at least it has mime parts,
// so let's try anyway
$arrFailed = $this->find_email_addresses(
$mime_sections['first_body_part']
);
for ($j = 0; $j < count($arrFailed); $j++) {
$this->output[$j]['recipient'] = trim($arrFailed[$j]);
$this->output[$j]['status']
= $this->get_status_code_from_text(
$this->output[$j]['recipient'], 0
);
$this->output[$j]['action']
= $this->get_action_from_status_code(
$this->output[$j]['status']
);
}
} else {
$this->returned_hash = $this->get_head_from_message_body();
// last ditch attempt
// could possibly produce erroneous output, or be very resource
// consuming, so be careful. You should comment out this
// section if you are very concerned
// about 100% accuracy or if you want very fast performance.
// Leave it turned on if you know that all messages to be
// analyzed are bounces.
$arrFailed = $this->find_email_addresses($body);
for ($j = 0; $j < count($arrFailed); $j++) {
$this->output[$j]['recipient'] = trim($arrFailed[$j]);
$this->output[$j]['status']
= $this->get_status_code_from_text(
$this->output[$j]['recipient'], 0
);
$this->output[$j]['action']
= $this->get_action_from_status_code(
$this->output[$j]['status']
);
}
}
}
// else if()..... add a parser for your busted-ass MTA here
// remove empty array indices
$tmp = array();
foreach ($this->output as $arr) {
if (empty($arr['recipient']) && empty($arr['status'])
&& empty($arr['action'])
) {
continue;
}
$tmp[] = $arr;
}
$this->output = $tmp;
// accessors
/*if it is an FBL, you could use the class variables to access the
data (Unlike Multipart-reports, FBL's report only one bounce)
*/
$this->type = $this->find_type();
$this->action = isset($this->output[0]['action'])
? $this->output[0]['action'] : '';
$this->status = isset($this->output[0]['status'])
? $this->output[0]['status'] : '';
$this->subject = ($this->subject) ? $this->subject
: $this->head_hash['Subject'];
$this->recipient = isset($this->output[0]['recipient'])
? $this->output[0]['recipient'] : '';
$this->feedback_type = (isset($this->fbl_hash['Feedback-type']))
? $this->fbl_hash['Feedback-type'] : "";
// sniff out any web beacons
if ($this->web_beacon_preg_1) {
$this->web_beacon_1 = $this->find_web_beacon(
$body, $this->web_beacon_preg_1
);
}
if ($this->web_beacon_preg_2) {
$this->web_beacon_2 = $this->find_web_beacon(
$body, $this->web_beacon_preg_2
);
}
if ($this->x_header_search_1) {
$this->x_header_beacon_1 = $this->find_x_header(
$this->x_header_search_1
);
}
if ($this->x_header_search_2) {
$this->x_header_beacon_2 = $this->find_x_header(
$this->x_header_search_2
);
}
return $this->output;
}
/**
* Setup/reset thge bounce handler.
*
* @param string $blob Inbound email
* @param string $format Not currently used
*
* @return string Contents of email
*/
function init_bouncehandler($blob = '', $format = 'string')
{
$this->head_hash = array();
$this->fbl_hash = array();
$this->body_hash = array();
$this->looks_like_a_bounce = false;
$this->looks_like_an_FBL = false;
$this->is_hotmail_fbl = false;
$this->type = false;
$this->feedback_type = "";
$this->action = "";
$this->status = "";
$this->subject = "";
$this->recipient = "";
$this->output = array();
$this->output[0]['action'] = '';
$this->output[0]['status'] = '';
$this->output[0]['recipient'] = '';
$strEmail = '';
if ('' !== $blob) {
// TODO: accept several formats (XML, string, array)
// currently accepts only string
//if($format=='xml_array'){
// $strEmail = "";
// $out = "";
// for($i=0; $i<$blob; $i++){
// $out = preg_replace("/<HEADER>/i", "", $blob[$i]);
// $out = preg_replace("/</HEADER>/i", "", $out);
// $out = preg_replace("/<MESSAGE>/i", "", $out);
// $out = preg_replace("/</MESSAGE>/i", "", $out);
// $out = rtrim($out) . "\r\n";
// $strEmail .= $out;
// }
//}
//else if($format=='string'){
$strEmail = str_replace("\r\n", "\n", $blob); // line returns 1
$strEmail = str_replace("\n", "\r\n", $strEmail);// line returns 2
// $strEmail = str_replace("=\r\n", "", $strEmail);
// remove MIME line breaks (would never exist as #1 above would have
// have dealt with)
// $strEmail = str_replace("=3D", "=", $strEmail);
// equals sign - dealt with in the MIME decode section now
// $strEmail = str_replace("=09", " ", $strEmail); // tabs
//}
//else if($format=='array'){
// $strEmail = "";
// for($i=0; $i<$blob; $i++){
// $strEmail .= rtrim($blob[$i]) . "\r\n";
// }
//}
}
return $strEmail;
}
/**
* Try to extract useful info from the headers bounces produced by
* busted MTAs.
*
* @param string|array $headers Headers of the email
*
* @return array
*/
function parse_head($headers)
{
if (!is_array($headers)) {
$headers = explode("\r\n", $headers);
}
$hash = $this->standard_parser($headers);
if (isset($hash['Content-type'])) {
//preg_match('/Multipart\/Report/i', $hash['Content-type'])){
$multipart_report = explode(';', $hash['Content-type']);
$hash['Content-type'] = '';
$hash['Content-type']['type'] = strtolower($multipart_report[0]);
foreach ($multipart_report as $mr) {
if (preg_match('/([^=.]*?)=(.*)/i', $mr, $matches)) {
// didn't work when the content-type boundary ID contained
// an equal sign,
// that exists in bounces from many Exchange servers
//if(preg_match('/([a-z]*)=(.*)?/i', $mr, $matches)){
$hash['Content-type'][strtolower(trim($matches[1]))]
= str_replace('"', '', $matches[2]);
}
}
}
return $hash;
}
/**
* Try and understand information from the headers of the email.
*
* @param string|array $content Header of the email
*
* @return array
*/
function standard_parser($content)
{
// associative array orstr
// receives email head as array of lines
// simple parse (Entity: value\n)
$hash = array('Received' => '');
if (!is_array($content)) {
$content = explode("\r\n", $content);
}
foreach ($content as $line) {
if (preg_match('/^([^\s.]*):\s*(.*)\s*/', $line, $array)) {
$entity = ucfirst(strtolower($array[1]));
if (isset($array[2]) && strpos($array[2], '=?') !== false) {
// decode MIME Header encoding (subject lines etc)
$array[2] = @iconv_mime_decode(
$array[2], ICONV_MIME_DECODE_CONTINUE_ON_ERROR, "UTF-8"
);
}
if (empty($hash[$entity])) {
$hash[$entity] = trim($array[2]);
} else if ($hash['Received']) {
// grab extra Received headers :(
// pile it on with pipe delimiters,
// oh well, SMTP is broken in this way
if ($entity and $array[2] and $array[2] != $hash[$entity]) {
$hash[$entity] .= "|" . trim($array[2]);
}
}
} elseif (isset($line) && isset($entity)
&& preg_match(
'/^\s+(.+)\s*/', $line, $array
)
&& $entity
) {
$line = trim($line);
if (true === isset($array[1])
&& strpos($array[1], '=?') !== false
&& isset($array[2])
) {
$line = iconv_mime_decode(
$array[2], ICONV_MIME_DECODE_CONTINUE_ON_ERROR, "UTF-8"
);
}
$hash[$entity] .= ' ' . $line;
}
}
// special formatting
$hash['Received'] = @explode('|', $hash['Received']);
$hash['Subject'] = isset($hash['Subject']) ? $hash['Subject'] : '';
return $hash;
}
/**
* Split an email into multiple mime sections
*
* @param string|array $body Body of the email
* @param string $boundary The boundary MIME separator.
*
* @return array
*/
function parse_body_into_mime_sections($body, $boundary)
{
if (!$boundary) {
return array();
}
if (is_array($body)) {
$body = implode("\r\n", $body);
}
$body = explode(rtrim($boundary, '='), $body);
$mime_sections['first_body_part'] = isset($body[1])
? $this->contenttype_decode($body[1]) : ''; // proper MIME decode
$mime_sections['machine_parsable_body_part'] = isset($body[2])
? $this->contenttype_decode($body[2]) : '';
$mime_sections['returned_message_body_part'] = isset($body[3])
? $this->contenttype_decode($body[3]) : '';
return $mime_sections;
}
/**
* Decode a content transfer-encoded part of the email.
*
* @param string $mimepart MIME encoded email body
*
* @return string
*/
function contenttype_decode($mimepart)
{
$encoding = '7bit';
$decoded = '';
foreach (explode("\r\n", $mimepart) as $line) {
if (preg_match(
"/^Content-Transfer-Encoding:\s*(\S+)/", $line, $match
)) {
$encoding = $match[1];
$decoded .= $line . "\r\n";
} else {
switch ($encoding) {
case 'quoted-printable':
if (substr($line, -1) == '=') {
$line = substr($line, 0, -1);
} else {
$line .= "\r\n";
}
$decoded .= preg_replace_callback(
"/=([0-9A-F][0-9A-F])/", function ($matches) {
return chr(hexdec($matches[0]));
}, $line
);
break;
case 'base64':
$decoded .= base64_decode($line);
break;
default: // 7bit, 8bit, binary
$decoded .= $line . "\r\n";
}
}
}
return $decoded;
}
/**
* Sees if this is an "obvious bounce".
*
* @return bool
*/
function is_a_bounce()
{
if (true === isset($this->head_hash['From'])
&& preg_match(
'/^(postmaster|mailer-daemon)\@?/i', $this->head_hash['From']
)
) {
return true;
}
foreach ($this->_bouncesubj as $s) {
if (preg_match("/^$s/i", $this->head_hash['Subject'])) {
return true;
}
}
return false;
}
/**
* Sees if this is an obvious "Abuse reporting format" email.
*
* @return bool
*/
function is_an_ARF()
{
if (isset($this->head_hash['Content-type']['report-type'])
&& preg_match(
'/feedback-report/',
$this->head_hash['Content-type']['report-type']
)
) {
return true;
}
if (isset($this->head_hash['X-loop'])
&& preg_match(
'/scomp/', $this->head_hash['X-loop']
)
) {
return true;
}
if (isset($this->head_hash['X-hmxmroriginalrecipient'])) {
$this->is_hotmail_fbl = true;
$this->recipient = $this->head_hash['X-hmxmroriginalrecipient'];
return true;
}
if (isset($this->_first_body_hash['X-hmxmroriginalrecipient'])) {
$this->is_hotmail_fbl = true;
$this->recipient
= $this->_first_body_hash['X-hmxmroriginalrecipient'];
return true;
}
return false;
}
/**
* Sees if this is an obvious autoresponder email.
*
* @return bool
*/
function is_an_autoresponse()
{
if (true === isset($this->head_hash['Auto-submitted'])) {
if (preg_match(
'/auto-notified|vacation|away/i',
$this->head_hash['Auto-submitted']
)) {
$this->_autoresponse
= 'Auto-submitted: ' . $this->head_hash['Auto-submitted'];
return true;
}
}
if (true === isset($this->head_hash['X-autorespond'])) {
if (preg_match(
'/auto-notified|vacation|away/i',
$this->head_hash['X-autorespond']
)) {
$this->_autoresponse
= 'X-autorespond: ' . $this->head_hash['X-autorespond'];
return true;
}
}
if (true === isset($this->head_hash['Precedence'])
&& preg_match(
'/^auto-reply/i', $this->head_hash['Precedence']
)
) {
$this->_autoresponse
= 'Precedence: ' . $this->head_hash['Precedence'];
return true;
}
if (true === isset($this->head_hash['X-Precedence'])
&& preg_match(
'/^auto-reply/i', $this->head_hash['X-Precedence']
)
) {
$this->_autoresponse
= 'X-Precedence: ' . $this->head_hash['X-Precedence'];
return true;
}
if (true == isset($this->head_hash['Subject'])) {
foreach ($this->_autorespondlist as $a) {
$result = preg_match("/$a/i", $this->head_hash['Subject']);
if (false === $result) {
die('Bad autoresponse regular expression ('
. preg_last_error() . ') while processing:' . $a);
}
if (1 === $result) {
$this->_autoresponse = $this->head_hash['Subject'];
return true;
}
}
}