-
Notifications
You must be signed in to change notification settings - Fork 41
/
imap.php
2926 lines (2545 loc) · 123 KB
/
imap.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
/***********************************************
* File : imap.php
* Project : Z-Push
* Descr : This backend is based on
* 'BackendDiff' and implements an
* IMAP interface
*
* Created : 10.10.2007
*
* Copyright 2007 - 2016 Zarafa Deutschland GmbH
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* Consult LICENSE file for details
************************************************/
// config file
require_once("backend/imap/config.php");
require_once("backend/imap/mime_calendar.php");
require_once("backend/imap/mime_encode.php");
require_once("backend/imap/user_identity.php");
// Add the path for Andrew's Web Libraries to include_path
// because it is required for the emails with ics attachments
// @see https://jira.z-hub.io/browse/ZP-1149
set_include_path(get_include_path() . PATH_SEPARATOR . '/usr/share/awl/inc' . PATH_SEPARATOR . dirname(__FILE__) . '/');
class BackendIMAP extends BackendDiff implements ISearchProvider {
private $wasteID;
private $sentID;
private $server;
private $mbox;
private $mboxFolder;
private $username;
private $password;
private $domain;
private $sinkfolders = array();
private $sinkstates = array();
private $changessinkinit = false;
private $folderhierarchy;
private $excludedFolders;
private static $mimeTypes = false;
private $imapParams = array();
private $dontStat = array(); //keys in this array represent mailboxes which can't be stat'd (ie, /NoSELECT status)
//define constants for imap mailbox attributes
const LATT_NOINFERIORS = 1;
const LATT_NOSELECT = 2;
const LATT_MARKED = 4;
const LATT_UNMARKED = 8;
const LATT_REFERRAL = 16;
const LATT_HASCHILDREN = 32;
const LATT_HASNOCHILDREN = 64;
public function __construct() {
if (BackendIMAP::$mimeTypes === false) {
BackendIMAP::$mimeTypes = $this->SystemExtensionMimeTypes();
}
$this->wasteID = false;
$this->sentID = false;
$this->mboxFolder = "";
if (!function_exists("imap_open"))
throw new FatalException("BackendIMAP(): php-imap module is not installed", 0, null, LOGLEVEL_FATAL);
if (!function_exists("mb_detect_order")) {
ZLog::Write(LOGLEVEL_WARN, sprintf("BackendIMAP(): php-mbstring module is not installed, you should install it for better encoding conversions"));
}
if (defined("IMAP_DISABLE_AUTHENTICATOR")) {
ZLog::Write(LOGLEVEL_INFO, sprintf("BackendIMAP(): The following authentication methods are disabled: %s", IMAP_DISABLE_AUTHENTICATOR));
$this->imapParams = array("DISABLE_AUTHENTICATOR" => array_map('trim' ,explode(',', IMAP_DISABLE_AUTHENTICATOR)));
}
if (!defined('IMAP_SEARCH_CHARSET')) {
ZLog::Write(LOGLEVEL_INFO, "BackendIMAP(): Using UTF-8 as Default Charset for Searches");
define('IMAP_SEARCH_CHARSET', 'UTF-8');
}
}
/**----------------------------------------------------------------------------------------------------------
* default backend methods
*/
/**
* Authenticates the user
*
* @param string $username
* @param string $domain
* @param string $password
*
* @access public
* @return boolean
* @throws FatalException if php-imap module can not be found
*/
public function Logon($username, $domain, $password) {
$this->wasteID = false;
$this->sentID = false;
$this->server = "{" . IMAP_SERVER . ":" . IMAP_PORT . "/imap" . IMAP_OPTIONS . "}";
if (!function_exists("imap_open"))
throw new FatalException("BackendIMAP(): php-imap module is not installed", 0, null, LOGLEVEL_FATAL);
if (defined('IMAP_FOLDER_CONFIGURED') && IMAP_FOLDER_CONFIGURED == false)
throw new FatalException("BackendIMAP(): You didn't configure your IMAP folder names. Do it before!", 0, null, LOGLEVEL_FATAL);
/* BEGIN fmbiete's contribution r1527, ZP-319 */
$this->excludedFolders = array();
if (defined('IMAP_EXCLUDED_FOLDERS') && strlen(IMAP_EXCLUDED_FOLDERS) > 0) {
$this->excludedFolders = explode("|", IMAP_EXCLUDED_FOLDERS);
ZLog::Write(LOGLEVEL_DEBUG, sprintf("BackendIMAP->Logon(): Excluding Folders (%s)", IMAP_EXCLUDED_FOLDERS));
}
/* END fmbiete's contribution r1527, ZP-319 */
// open the IMAP-mailbox
$this->mbox = @imap_open($this->server , $username, $password, OP_HALFOPEN, 0, $this->imapParams);
$this->mboxFolder = "";
if ($this->mbox) {
ZLog::Write(LOGLEVEL_DEBUG, sprintf("BackendIMAP->Logon(): User '%s' is authenticated on '%s'", $username, $this->server));
$this->username = $username;
$this->password = $password;
$this->domain = $domain;
return true;
}
else {
ZLog::Write(LOGLEVEL_ERROR, sprintf("BackendIMAP->Logon(): can't connect as user '%s' on '%s': %s", $username, $this->server, imap_last_error()));
return false;
}
}
/**
* Logs off
* Called before shutting down the request to close the IMAP connection
* writes errors to the log
*
* @access public
* @return boolean
*/
public function Logoff() {
$this->close_connection();
$this->SaveStorages();
}
/**
* Sends an e-mail
* This messages needs to be saved into the 'sent items' folder
*
* @param SyncSendMail $sm SyncSendMail object
*
* @access public
* @return boolean
* @throws StatusException
*/
public function SendMail($sm) {
ZLog::Write(LOGLEVEL_DEBUG, sprintf("BackendIMAP->SendMail(): RFC822: %d bytes forward-id: '%s' reply-id: '%s' parent-id: '%s' SaveInSent: '%s' ReplaceMIME: '%s'",
strlen($sm->mime),
Utils::PrintAsString($sm->forwardflag ? (isset($sm->source->itemid) ? $sm->source->itemid : "error no itemid") : false),
Utils::PrintAsString($sm->replyflag ? (isset($sm->source->itemid) ? $sm->source->itemid : "error no itemid") : false),
Utils::PrintAsString((isset($sm->source->folderid) ? $sm->source->folderid : false)),
Utils::PrintAsString(($sm->saveinsent)), Utils::PrintAsString(isset($sm->replacemime))));
// by splitting the message in several lines we can easily grep later
if(ZLog::IsWbxmlDebugEnabled()) {
$logWbxmlMime = "";
$startpos = 0;
// limit log to about 10 KB and use ZLog:Write() truncation
while ($startpos < 10240) {
if ($endpos = strpos($sm->mime, "\n", $startpos)) {
$logWbxmlMime .= "RFC822: " . trim(substr($sm->mime, $startpos, ($endpos - $startpos))) . PHP_EOL;
$startpos = ++$endpos;
}
else {
if (strlen(trim(substr($sm->mime, $startpos))) > 0) {
$logWbxmlMime .= "RFC822: " . trim(substr($sm->mime, $startpos)) . PHP_EOL;
}
break;
}
}
ZLog::Write(LOGLEVEL_WBXML, $logWbxmlMime);
unset($logWbxmlMime);
}
$sourceMessage = $sourceMail = false;
// If we have a reference to a source message and we are not replacing mime (since we wouldn't use it)
if (isset($sm->source->folderid) && isset($sm->source->itemid) && (!isset($sm->replacemime) || $sm->replacemime === false)) {
ZLog::Write(LOGLEVEL_DEBUG, sprintf("BackendIMAP->SendMail(): We have a source message and we try to fetch it"));
$parent = $this->getImapIdFromFolderId($sm->source->folderid);
if ($parent === false) {
throw new StatusException(sprintf("BackendIMAP->SendMail(): Could not get imapid from source folderid '%'", $sm->source->folderid), SYNC_COMMONSTATUS_ITEMNOTFOUND);
}
else {
$this->imap_reopen_folder($parent);
$sourceMail = @imap_fetchheader($this->mbox, $sm->source->itemid, FT_UID) . @imap_body($this->mbox, $sm->source->itemid, FT_PEEK | FT_UID);
$mobj = new Mail_mimeDecode($sourceMail);
$sourceMessage = $mobj->decode(array('decode_headers' => false, 'decode_bodies' => true, 'include_bodies' => true, 'rfc_822bodies' => true, 'charset' => 'utf-8'));
unset($mobj);
//We will need $sourceMail if the message is forwarded and not inlined
// If it's a reply, we mark the original message as answered
if ($sm->replyflag) {
if (!@imap_setflag_full($this->mbox, $sm->source->itemid, "\\Answered", ST_UID)) {
ZLog::Write(LOGLEVEL_WARN, sprintf("BackendIMAP->SendMail(): Unable to mark the message as Answered"));
}
}
// If it's a forward, we mark the original message as forwarded
if ($sm->forwardflag) {
if (!@imap_setflag_full($this->mbox, $sm->source->itemid, "\$Forwarded", ST_UID)) {
ZLog::Write(LOGLEVEL_WARN, sprintf("BackendIMAP->SendMail(): Unable to mark the message as Forwarded"));
}
}
}
}
ZLog::Write(LOGLEVEL_DEBUG, sprintf("BackendIMAP->SendMail(): We get the new message"));
$mobj = new Mail_mimeDecode($sm->mime);
$message = $mobj->decode(array('decode_headers' => 'utf-8', 'decode_bodies' => true, 'include_bodies' => true, 'rfc_822bodies' => true, 'charset' => 'utf-8'));
unset($mobj);
ZLog::Write(LOGLEVEL_DEBUG, sprintf("BackendIMAP->SendMail(): We get the From and To"));
$Mail_RFC822 = new Mail_RFC822();
$this->setFromHeaderValue($message->headers);
$fromaddr = $this->parseAddr($Mail_RFC822->parseAddressList($message->headers["from"]));
$toaddr = "";
if (isset($message->headers["to"])) {
// don't validate atoms, headers might be UTF-8 not ASCII
$toaddr = $Mail_RFC822->parseAddressList($message->headers["to"], null, null, false, null);
$message->headers["to"] = Utils::CheckAndFixEncodingInHeadersOfSentMail($toaddr);
$toaddr = $this->parseAddr($toaddr);
ZLog::Write(LOGLEVEL_DEBUG, sprintf("BackendIMAP->SendMail(): To defined: %s", $toaddr));
}
if (isset($message->headers["cc"])) {
$message->headers["cc"] = Utils::CheckAndFixEncodingInHeadersOfSentMail($Mail_RFC822->parseAddressList($message->headers["cc"], null, null, false, null));
}
if (isset($message->headers["bcc"])) {
$message->headers["bcc"] = Utils::CheckAndFixEncodingInHeadersOfSentMail($Mail_RFC822->parseAddressList($message->headers["bcc"], null, null, false, null));
}
unset($Mail_RFC822);
if (isset($message->headers["subject"]) && mb_detect_encoding($message->headers["subject"], "UTF-8") != false && preg_match('/[^\x00-\x7F]/', $message->headers["subject"]) == 1) {
mb_internal_encoding("UTF-8");
ZLog::Write(LOGLEVEL_DEBUG, sprintf("BackendIMAP->SendMail(): Subject in raw UTF-8: %s", $message->headers["subject"]));
$message->headers["subject"] = mb_encode_mimeheader($message->headers["subject"]);
}
$this->setReturnPathValue($message->headers, $fromaddr);
$finalBody = "";
$finalHeaders = array();
// if it's a S/MIME message or has VCALENDAR objects I don't do anything with it
if (is_smime($message) || has_calendar_object($message)) {
$mobj = new Mail_mimeDecode($sm->mime);
$parts = $mobj->getSendArray();
unset($mobj);
if ($parts === false) {
throw new StatusException(sprintf("BackendIMAP->SendMail(): Could not getSendArray for SMIME messages"), SYNC_COMMONSTATUS_MAILSUBMISSIONFAILED);
}
else {
list($recipients, $finalHeaders, $finalBody) = $parts;
$this->setFromHeaderValue($finalHeaders);
$this->setReturnPathValue($finalHeaders, $fromaddr);
}
}
else {
//http://pear.php.net/manual/en/package.mail.mail-mime.example.php
//http://pear.php.net/manual/en/package.mail.mail-mimedecode.decode.php
//http://pear.php.net/manual/en/package.mail.mail-mimepart.addsubpart.php
// I don't mind if the new message is multipart or not, I always will create a multipart. It's simpler
$finalEmail = new Mail_mimePart('', array('content_type' => 'multipart/mixed'));
if ($sm->replyflag && (!isset($sm->replacemime) || $sm->replacemime === false)) {
ZLog::Write(LOGLEVEL_DEBUG, sprintf("BackendIMAP->SendMail(): Replying message"));
$this->addTextParts($finalEmail, $message, $sourceMessage, true);
if (isset($message->parts)) {
// We add extra parts from the replying message
add_extra_sub_parts($finalEmail, $message->parts);
}
// A replied message doesn't include the original attachments
}
else if ($sm->forwardflag && (!isset($sm->replacemime) || $sm->replacemime === false)) {
if (!defined('IMAP_INLINE_FORWARD') || IMAP_INLINE_FORWARD === false) {
ZLog::Write(LOGLEVEL_DEBUG, "BackendIMAP->SendMail(): Forwarding message as attached file - eml");
$finalEmail->addSubPart($sourceMail, array('content_type' => 'message/rfc822', 'encoding' => 'base64', 'disposition' => 'attachment', 'dfilename' => 'forwarded_message.eml'));
}
else {
ZLog::Write(LOGLEVEL_DEBUG, "BackendIMAP->SendMail(): Forwarding inlined message");
$this->addTextParts($finalEmail, $message, $sourceMessage, false);
if (isset($message->parts)) {
// We add extra parts from the forwarding message
add_extra_sub_parts($finalEmail, $message->parts);
}
if (isset($sourceMessage->parts)) {
// We add extra parts from the forwarded message
add_extra_sub_parts($finalEmail, $sourceMessage->parts);
}
}
}
else {
ZLog::Write(LOGLEVEL_DEBUG, sprintf("BackendIMAP->SendMail(): is a new message or we are replacing mime"));
$this->addTextPartsMessage($finalEmail, $message);
if (isset($message->parts)) {
// We add extra parts from the new message
add_extra_sub_parts($finalEmail, $message->parts);
}
}
// We encode the final message
$boundary = '=_' . md5(rand() . microtime());
$finalEmail = $finalEmail->encode($boundary);
$finalHeaders = array('MIME-Version' => '1.0');
// We copy all the non-existent headers, minus content_type
ZLog::Write(LOGLEVEL_DEBUG, sprintf("BackendIMAP->SendMail(): Copying new headers"));
foreach ($message->headers as $k => $v) {
if (strcasecmp($k, 'content-type') != 0 && strcasecmp($k, 'content-transfer-encoding') != 0 && strcasecmp($k, 'mime-version') != 0) {
if (!isset($finalHeaders[$k]))
$finalHeaders[ucwords($k)] = $v;
}
}
foreach ($finalEmail['headers'] as $k => $v) {
if (!isset($finalHeaders[$k]))
$finalHeaders[$k] = $v;
}
$finalBody = "This is a multi-part message in MIME format.\n" . $finalEmail['body'];
unset($finalEmail);
}
unset($sourceMail);
unset($message);
unset($sourceMessage);
ZLog::Write(LOGLEVEL_DEBUG, sprintf("BackendIMAP->SendMail(): Final mail to send:"));
if(ZLog::IsWbxmlDebugEnabled()) {
$logWbxmlHeaders = "";
foreach ($finalHeaders as $k => $v) {
$logWbxmlHeaders .= $k . ": " . $v . PHP_EOL;
}
ZLog::Write(LOGLEVEL_WBXML, $logWbxmlHeaders, false);
unset($logWbxmlHeaders);
$logWbxmlBody = "";
foreach (preg_split("/((\r)?\n)/", $finalBody) as $bodyline) {
$logWbxmlBody .= "Body: " . $bodyline . PHP_EOL;
}
ZLog::Write(LOGLEVEL_WBXML, $logWbxmlBody, false);
unset($logWbxmlBody);
}
$send = $this->sendMessage($fromaddr, $toaddr, $finalHeaders, $finalBody);
if ($send) {
if (isset($sm->saveinsent)) {
$this->saveSentMessage($finalHeaders, $finalBody);
}
else {
ZLog::Write(LOGLEVEL_DEBUG, "BackendIMAP->SendMail(): Not saving in SentFolder");
}
}
unset($finalHeaders);
unset($finalBody);
return $send;
}
/**
* Add text parts to a mimepart object, with reply or forward tags
*
* @param Mail_mimePart $email reference to the object
* @param Mail_mimeDecode $message reference to the message
* @param Mail_mimeDecode $sourceMessage reference to the original message
* @param boolean $isReply true if it's a reply, false if it's a forward
*
* @access private
* @return void
*/
private function addTextParts(&$email, &$message, &$sourceMessage, $isReply = true) {
$htmlBody = $plainBody = '';
Mail_mimeDecode::getBodyRecursive($message, "html", $htmlBody);
Mail_mimeDecode::getBodyRecursive($message, "plain", $plainBody);
$htmlSource = $plainSource = '';
Mail_mimeDecode::getBodyRecursive($sourceMessage, "html", $htmlSource);
Mail_mimeDecode::getBodyRecursive($sourceMessage, "plain", $plainSource);
$separator = '';
if ($isReply) {
$separator = ">\r\n";
$separatorHtml = "<blockquote>";
$separatorHtmlEnd = "</blockquote></body></html>";
}
else {
$separator = "";
$separatorHtml = "<div>";
$separatorHtmlEnd = "</div>";
}
$altEmail = new Mail_mimePart('', array('content_type' => 'multipart/alternative'));
if (strlen($htmlBody) > 0) {
ZLog::Write(LOGLEVEL_DEBUG, sprintf("BackendIMAP->addTextParts(): The message has HTML body"));
if (strlen($htmlSource) > 0) {
ZLog::Write(LOGLEVEL_DEBUG, sprintf("BackendIMAP->addTextParts(): The original message had HTML body"));
$altEmail->addSubPart($htmlBody . $separatorHtml . $htmlSource . $separatorHtmlEnd, array('content_type' => 'text/html; charset=utf-8', 'encoding' => 'base64'));
}
else {
ZLog::Write(LOGLEVEL_DEBUG, sprintf("BackendIMAP->addTextParts(): The original message had not HTML body, we use original PLAIN body to create HTML"));
$altEmail->addSubPart($htmlBody . $separatorHtml . "<p>" . $plainSource . "</p>" . $separatorHtmlEnd, array('content_type' => 'text/html; charset=utf-8', 'encoding' => 'base64'));
}
}
if (strlen($plainBody) > 0) {
ZLog::Write(LOGLEVEL_DEBUG, sprintf("BackendIMAP->addTextParts(): The message has PLAIN body"));
if (strlen($plainSource) > 0) {
ZLog::Write(LOGLEVEL_DEBUG, sprintf("BackendIMAP->addTextParts(): The original message had PLAIN body"));
$altEmail->addSubPart($plainBody . $separator . str_replace("\n", "\n> ", "> " . $plainSource), array('content_type' => 'text/plain; charset=utf-8', 'encoding' => 'base64'));
}
else {
ZLog::Write(LOGLEVEL_DEBUG, sprintf("BackendIMAP->addTextParts(): The original message had not PLAIN body, we use original HTML body to create PLAIN"));
$altEmail->addSubPart($plainBody . $separator . str_replace("\n", "\n> ", "> " . Utils::ConvertHtmlToText($htmlSource)), array('content_type' => 'text/plain; charset=utf-8', 'encoding' => 'base64'));
}
}
$boundary = '=_' . md5(rand() . microtime());
$altEmail = $altEmail->encode($boundary);
$email->addSubPart($altEmail['body'], array('content_type' => 'multipart/alternative;'."\n".' boundary="'.$boundary.'"'));
unset($altEmail);
unset($htmlBody);
unset($htmlSource);
unset($plainBody);
unset($plainSource);
}
/**
* Add text parts to a mimepart object
*
* @param Mail_mimePart $email reference to the object
* @param Mail_mimeDecode $message reference to the message
*
* @access private
* @return void
*/
private function addTextPartsMessage(&$email, &$message) {
$altEmail = new Mail_mimePart('', array('content_type' => 'multipart/alternative'));
foreach (array("plain", "html", "calendar") as $type) {
$body = '';
Mail_mimeDecode::getBodyRecursive($message, $type, $body);
if (strlen($body) > 0) {
ZLog::Write(LOGLEVEL_DEBUG, sprintf("BackendIMAP->addTextPartsMessage(): The message has %s body", $type));
$altEmail->addSubPart($body, array('content_type' => sprintf("text/%s; charset=utf-8", $type), 'encoding' => 'base64'));
}
}
unset($body);
$boundary = '=_' . md5(rand() . microtime());
$altEmail = $altEmail->encode($boundary);
$email->addSubPart($altEmail['body'], array('content_type' => 'multipart/alternative;'."\n".' boundary="'.$boundary.'"'));
unset($altEmail);
}
/**
* Returns the waste basket
*
* @access public
* @return string
*/
public function GetWasteBasket() {
// TODO this could be retrieved from the DeviceFolderCache
if ($this->wasteID == false) {
//try to get the waste basket without doing complete hierarchy sync
$folder_name = IMAP_FOLDER_TRASH;
if (defined('IMAP_FOLDER_PREFIX') && strlen(IMAP_FOLDER_PREFIX) > 0)
$folder_name = IMAP_FOLDER_PREFIX . $this->getServerDelimiter() . $folder_name;
$wastebaskt = @imap_getmailboxes($this->mbox, $this->server, $folder_name);
if (isset($wastebaskt[0])) {
$this->wasteID = $this->convertImapId(substr($wastebaskt[0]->name, strlen($this->server)));
return $this->wasteID;
}
//try get waste id from hierarchy if it wasn't possible with above for some reason
$this->GetHierarchy();
}
return $this->wasteID;
}
/**
* Returns the content of the named attachment as stream. The passed attachment identifier is
* the exact string that is returned in the 'AttName' property of an SyncAttachment.
* Any information necessary to find the attachment must be encoded in that 'attname' property.
*
* @param string $attname
*
* @access public
* @return SyncItemOperationsAttachment
* @throws StatusException
*/
public function GetAttachmentData($attname) {
ZLog::Write(LOGLEVEL_DEBUG, sprintf("BackendIMAP->GetAttachmentData('%s')", $attname));
list($folderid, $id, $part) = explode(":", $attname);
if (!isset($folderid) || !isset($id) || !isset($part))
throw new StatusException(sprintf("BackendIMAP->GetAttachmentData('%s'): Error, attachment name key can not be parsed", $attname), SYNC_ITEMOPERATIONSSTATUS_INVALIDATT);
// convert back to work on an imap-id
$folderImapid = $this->getImapIdFromFolderId($folderid);
$this->imap_reopen_folder($folderImapid);
$mail = @imap_fetchheader($this->mbox, $id, FT_UID) . @imap_body($this->mbox, $id, FT_PEEK | FT_UID);
if (empty($mail)) {
throw new StatusException(sprintf("BackendIMAP->GetAttachmentData('%s'): Error, message not found, maybe was moved", $attname), SYNC_ITEMOPERATIONSSTATUS_INVALIDATT);
}
$mobj = new Mail_mimeDecode($mail);
unset($mail);
$message = $mobj->decode(array('decode_headers' => 'utf-8', 'decode_bodies' => true, 'include_bodies' => true, 'rfc_822bodies' => true, 'charset' => 'utf-8'));
unset($mobj);
if (!isset($message->parts)) {
throw new StatusException(sprintf("BackendIMAP->GetAttachmentData('%s'): Error, message without parts. Requesting part key: '%d'", $attname, $part), SYNC_ITEMOPERATIONSSTATUS_INVALIDATT);
}
/* BEGIN fmbiete's contribution r1528, ZP-320 */
//trying parts
$mparts = $message->parts;
for ($i = 0; $i < count($mparts); $i++) {
$auxpart = $mparts[$i];
//recursively add parts
if($auxpart->ctype_primary == "multipart" && ($auxpart->ctype_secondary == "mixed" || $auxpart->ctype_secondary == "alternative" || $auxpart->ctype_secondary == "related")) {
foreach($auxpart->parts as $spart)
$mparts[] = $spart;
}
}
/* END fmbiete's contribution r1528, ZP-320 */
if (!isset($mparts[$part]->body))
throw new StatusException(sprintf("BackendIMAP->GetAttachmentData('%s'): Error, requested part key can not be found: '%d'", $attname, $part), SYNC_ITEMOPERATIONSSTATUS_INVALIDATT);
$attachment = new SyncItemOperationsAttachment();
/* BEGIN fmbiete's contribution r1528, ZP-320 */
$attachment->data = StringStreamWrapper::Open($mparts[$part]->body);
if (isset($mparts[$part]->ctype_primary) && isset($mparts[$part]->ctype_secondary))
$attachment->contenttype = $mparts[$part]->ctype_primary .'/'.$mparts[$part]->ctype_secondary;
unset($mparts);
unset($message);
ZLog::Write(LOGLEVEL_DEBUG, sprintf("BackendIMAP->GetAttachmentData contenttype %s", $attachment->contenttype));
/* END fmbiete's contribution r1528, ZP-320 */
return $attachment;
}
/**
* Deletes all contents of the specified folder.
* This is generally used to empty the trash (wastebasked), but could also be used on any
* other folder.
*
* @param string $folderid
* @param boolean $includeSubfolders (opt) also delete sub folders, default true
*
* @access public
* @return boolean
* @throws StatusException
*/
public function EmptyFolder($folderid, $includeSubfolders = true) {
ZLog::Write(LOGLEVEL_DEBUG, sprintf("BackendIMAP->EmptyFolder('%s', '%s')", $folderid, Utils::PrintAsString($includeSubfolders)));
$folderImapid = $this->getImapIdFromFolderId($folderid);
if ($folderImapid === false) {
throw new StatusException(sprintf("BackendIMAP->EmptyFolder('%s','%s'): Error, unable to open folder (no entry id)", $folderid, Utils::PrintAsString($includeSubfolders)), SYNC_ITEMOPERATIONSSTATUS_SERVERERROR);
}
if (!$this->imap_reopen_folder($folderImapid)) {
throw new StatusException(sprintf("BackendIMAP->EmptyFolder('%s','%s'): Error, unable to open parent folder (open entry)", $folderid, Utils::PrintAsString($includeSubfolders)), SYNC_ITEMOPERATIONSSTATUS_SERVERERROR);
}
ZLog::Write(LOGLEVEL_DEBUG, sprintf("BackendIMAP->EmptyFolder('%s','%s'): emptying folder", $folderid, Utils::PrintAsString($includeSubfolders)));
// TODO: make transactional all these deletes: see comment bellow
if (@imap_delete($this->mbox, "1:*")) {
@imap_expunge($this->mbox);
// An error erasing any subfolder won't return an error to the device, because we should undelete the already expunged messages, and we cannot undelete a folder
if ($includeSubfolders) {
ZLog::Write(LOGLEVEL_DEBUG, sprintf("BackendIMAP->EmptyFolder('%s','%s'): deleting subfolders", $folderid, Utils::PrintAsString($includeSubfolders)));
// Find subfolders
$subfolders = @imap_getmailboxes($this->mbox, $this->server . $folderImapid, "*");
if (is_array($subfolders)) {
// delete mailbox and its content
foreach ($subfolders as $val) {
$subname = substr($val->name, strlen($this->server));
if (!@imap_deletemailbox($this->mbox, $val->name)) {
ZLog::Write(LOGLEVEL_ERROR, sprintf("BackendIMAP->EmptyFolder('%s','%s'): Error deleting subfolder %s", $folderid, Utils::PrintAsString($includeSubfolders), $subname));
}
}
}
else {
ZLog::Write(LOGLEVEL_ERROR, sprintf("BackendIMAP->EmptyFolder('%s','%s'): Error getting subfolder list", $folderid, Utils::PrintAsString($includeSubfolders)));
}
}
}
else {
throw new StatusException(sprintf("BackendIMAP->EmptyFolder('%s','%s'): Error, imap_delete() failed; '%s'", $folderid, Utils::PrintAsString($includeSubfolders), @imap_last_error()), SYNC_ITEMOPERATIONSSTATUS_SERVERERROR);
}
return true;
}
/**
* Indicates if the backend has a ChangesSink.
* A sink is an active notification mechanism which does not need polling.
* The IMAP backend simulates a sink by polling status information of the folder
*
* @access public
* @return boolean
*/
public function HasChangesSink() {
return true;
}
/**
* The folder should be considered by the sink.
* Folders which were not initialized should not result in a notification
* of IBacken->ChangesSink().
*
* @param string $folderid
*
* @access public
* @return boolean false if found can not be found
*/
public function ChangesSinkInitialize($folderid) {
ZLog::Write(LOGLEVEL_DEBUG, sprintf("BackendIMAP->ChangesSinkInitialize(): folderid '%s'", $folderid));
$imapid = $this->getImapIdFromFolderId($folderid);
if (!$this->changessinkinit) {
// First folder, store the actual folder structure
$list= $this->get_attributes_list();
foreach ($list as $l) {
//ZLog::Write(LOGLEVEL_INFO, sprintf("BackendIMAP->ChangesSinkInitialize(): adding '%s' with attributes: '%s'", $l['name'], print_r($l,true)));
$this->folderhierarchy[] = $l['name'];
if (isset($l['noSelect']) && $l['noSelect'] != false) {
$dontStatFolder = str_replace( $this->server, '', $l['name']);
//ZLog::Write(LOGLEVEL_INFO, sprintf("BackendIMAP->ChangesSinkInitialize(): adding '%s' to dontStatFolders()", $dontStatFolder));
$this->dontStatFolders[$dontStatFolder] = true;
}
}
}
if (($imapid !== false) && !(isset($this->dontStatFolders[$imapid]) )) {
$this->sinkfolders[] = $imapid;
$this->changessinkinit = true;
}
return $this->changessinkinit;
}
/**
* The actual ChangesSink.
* For max. the $timeout value this method should block and if no changes
* are available return an empty array.
* If changes are available a list of folderids is expected.
*
* @param int $timeout max. amount of seconds to block
*
* @access public
* @return array
*/
public function ChangesSink($timeout = 30) {
$notifications = array();
$stopat = time() + $timeout - 1;
//We can get here and the ChangesSink not be initialized yet
if (!$this->changessinkinit) {
ZLog::Write(LOGLEVEL_DEBUG, sprintf("BackendIMAP>ChangesSink - Not initialized ChangesSink, sleep and exit"));
// We sleep and do nothing else
sleep($timeout);
return $notifications;
}
// Reconnect IMAP server
$this->imap_reconnect();
// Check folder hierarchy and create change
if (count(array_diff($this->folderhierarchy, $this->get_folder_list())) > 0) {
ZLog::Write(LOGLEVEL_DEBUG, "BackendIMAP->ChangesSink(): Changes in folder hierarchy detected!!");
throw new StatusException("BackendIMAP->ChangesSink(): HierarchySync required.", SyncCollections::HIERARCHY_CHANGED);
}
$flaggedMessages = array();
$answeredMessages = array();
$forwardedMessages = array();
// only check once to reduce pressure in the IMAP server
foreach ($this->sinkfolders as $i => $imapid) {
$this->imap_reopen_folder($imapid);
// courier-imap only clears the status cache after checking
@imap_check($this->mbox);
// get count of recent, unseen and overall messages
$status = @imap_status($this->mbox, $this->server . $imapid, SA_ALL);
// get count of flagged messages (ZP-1561)
$flaggedMessages = @imap_search($this->mbox, 'FLAGGED');
$flaggedMessages = is_array($flaggedMessages) ? count($flaggedMessages) : 0;
// search for answered messages
$answeredMessages = @imap_search($this->mbox, 'ANSWERED');
$answeredMessages = is_array($answeredMessages) ? count($answeredMessages) : 0;
// search for forwarded messages
$forwardedMessages = @imap_search($this->mbox, 'KEYWORD $Forwarded');
$forwardedMessages = is_array($forwardedMessages) ? count($forwardedMessages) : 0;
if (!$status) {
ZLog::Write(LOGLEVEL_WARN, sprintf("ChangesSink: could not stat folder '%s': %s ", $this->getFolderIdFromImapId($imapid), imap_last_error()));
}
else {
$newstate = "M:". $status->messages ."-R:". $status->recent ."-U:". $status->unseen ."-F:". $flaggedMessages ."-A:". $answeredMessages ."-W:". $forwardedMessages;
if (! isset($this->sinkstates[$imapid]) ) {
$this->sinkstates[$imapid] = $newstate;
}
if ($this->sinkstates[$imapid] != $newstate) {
$notifications[] = $this->getFolderIdFromImapId($imapid);
$this->sinkstates[$imapid] = $newstate;
ZLog::Write(LOGLEVEL_DEBUG, "BackendIMAP->ChangesSink(): ChangesSink detected!!");
}
}
}
// Close IMAP connection, we will reconnect in the next execution. This will reduce IMAP pressure
$this->close_connection();
// Wait to timeout
if (empty($notifications)) {
while ($stopat > time()) {
sleep(1);
}
}
return $notifications;
}
/**----------------------------------------------------------------------------------------------------------
* implemented DiffBackend methods
*/
/**
* Returns a list (array) of folders.
*
* @access public
* @return array/boolean false if the list could not be retrieved
*/
public function GetFolderList() {
$folders = array();
$list = $this->get_folder_list();
foreach ($list as $val) {
// don't return the excluded folders
$notExcluded = true;
for ($i = 0, $cnt = count($this->excludedFolders); $notExcluded && $i < $cnt; $i++) { // expr1, expr2 modified by mku ZP-329
// fix exclude folders with special chars by mku ZP-329
if (strpos(strtolower($val), strtolower(Utils::Utf8_to_utf7imap($this->excludedFolders[$i]))) !== false) {
$notExcluded = false;
ZLog::Write(LOGLEVEL_DEBUG, sprintf("Pattern: <%s> found, excluding folder: '%s'", $this->excludedFolders[$i], $val)); // sprintf added by mku ZP-329
}
}
if ($notExcluded) {
$box = array();
// cut off serverstring
$imapid = substr($val, strlen($this->server));
$box["id"] = $this->convertImapId($imapid);
$folders[] = $box;
}
}
return $folders;
}
/**
* Returns an actual SyncFolder object
*
* @param string $id id of the folder
*
* @access public
* @return object SyncFolder with information
*/
public function GetFolder($id) {
$folder = new SyncFolder();
$folder->serverid = $id;
// convert back to work on an imap-id
$imapid = $this->getImapIdFromFolderId($id);
// explode hierarchy
$fhir = explode($this->getServerDelimiter(), $imapid);
// TODO WasteID or SentID could be saved for later ussage
if (strcasecmp($imapid, $this->create_name_folder(IMAP_FOLDER_INBOX)) == 0) {
$folder->parentid = "0";
$folder->displayname = "Inbox";
$folder->type = SYNC_FOLDER_TYPE_INBOX;
}
else if (strcasecmp($imapid, $this->create_name_folder(IMAP_FOLDER_DRAFT)) == 0) {
$folder->parentid = "0";
$folder->displayname = "Drafts";
$folder->type = SYNC_FOLDER_TYPE_DRAFTS;
}
else if (strcasecmp($imapid, $this->create_name_folder(IMAP_FOLDER_SENT)) == 0) {
$folder->parentid = "0";
$folder->displayname = "Sent";
$folder->type = SYNC_FOLDER_TYPE_SENTMAIL;
$this->sentID = $id;
}
else if (strcasecmp($imapid, $this->create_name_folder(IMAP_FOLDER_TRASH)) == 0) {
$folder->parentid = "0";
$folder->displayname = "Trash";
$folder->type = SYNC_FOLDER_TYPE_WASTEBASKET;
$this->wasteID = $id;
}
else if (strcasecmp($imapid, $this->create_name_folder(IMAP_FOLDER_SPAM)) == 0) {
$folder->parentid = "0";
$folder->displayname = "Junk";
$folder->type = SYNC_FOLDER_TYPE_USER_MAIL;
}
else if (strcasecmp($imapid, $this->create_name_folder(IMAP_FOLDER_ARCHIVE)) == 0) {
$folder->parentid = "0";
$folder->displayname = "Archive";
$folder->type = SYNC_FOLDER_TYPE_USER_MAIL;
}
else {
if (defined('IMAP_FOLDER_PREFIX') && strlen(IMAP_FOLDER_PREFIX) > 0) {
if (strcasecmp($fhir[0], IMAP_FOLDER_PREFIX) == 0) {
// Discard prefix
array_shift($fhir);
}
else {
ZLog::Write(LOGLEVEL_WARN, sprintf("BackendIMAP->GetFolder('%s'): '%s'; using server delimiter '%s', first part '%s' is not equal to the prefix defined '%s'. Something is wrong with your config.", $id, $imapid, $this->getServerDelimiter(), $fhir[0], IMAP_FOLDER_PREFIX));
}
}
if (count($fhir) == 1) {
$folder->displayname = Utils::Utf7imap_to_utf8($fhir[0]);
$folder->parentid = "0";
}
else {
$this->getModAndParentNames($fhir, $folder->displayname, $imapparent);
$folder->displayname = Utils::Utf7imap_to_utf8($folder->displayname);
if ($imapparent === null) {
ZLog::Write(LOGLEVEL_WARN, sprintf("BackendIMAP->GetFolder('%s'): '%s'; we didn't found a valid parent name for the folder, but we should... contact the developers for further info", $id, $imapid));
$folder->parentid = "0"; // We put the folder as root folder, so we see it
}
else {
$folder->parentid = $this->convertImapId($imapparent);
}
}
$folder->type = SYNC_FOLDER_TYPE_USER_MAIL;
}
//advanced debugging
ZLog::Write(LOGLEVEL_DEBUG, sprintf("BackendIMAP->GetFolder('%s'): '%s'", $id, $folder));
return $folder;
}
/**
* Returns folder stats. An associative array with properties is expected.
*
* @param string $id id of the folder
*
* @access public
* @return array
*/
public function StatFolder($id) {
$folder = $this->GetFolder($id);
$stat = array();
$stat["id"] = $id;
$stat["parent"] = $folder->parentid;
$stat["mod"] = $folder->displayname;
return $stat;
}
/**
* Creates or modifies a folder
* The folder type is ignored in IMAP, as all folders are Email folders
*
* @param string $folderid id of the parent folder
* @param string $oldid if empty -> new folder created, else folder is to be renamed
* @param string $displayname new folder name (to be created, or to be renamed to)
* @param int $type folder type
*
* @access public
* @return boolean status
* @throws StatusException could throw specific SYNC_FSSTATUS_* exceptions
*
*/
public function ChangeFolder($folderid, $oldid, $displayname, $type){
ZLog::Write(LOGLEVEL_INFO, sprintf("BackendIMAP->ChangeFolder('%s','%s','%s','%s')", $folderid, $oldid, $displayname, $type));
// if $id is set => rename mailbox, otherwise create
if ($oldid) {
// rename doesn't work properly with IMAP
// the activesync client doesn't support a 'changing ID'
// TODO this would be solved by implementing hex ids (Mantis #459)
//$csts = imap_renamemailbox($this->mbox, $this->server . imap_utf7_encode(str_replace(".", $this->getServerDelimiter(), $oldid)), $newname);
ZLog::Write(LOGLEVEL_ERROR, "BackendIMAP->ChangeFolder() : we do not support rename for now");
return false;
}
else {
// build name for new mailboxBackendMaildir
$displayname = Utils::Utf8_to_utf7imap($displayname);
if ($folderid == "0") {
$newimapid = $displayname;
}
else {
$imapid = $this->getImapIdFromFolderId($folderid);
$newimapid = $imapid . $this->getServerDelimiter() . $displayname;
}
$csts = imap_createmailbox($this->mbox, $this->server . $newimapid);
ZLog::Write(LOGLEVEL_DEBUG, sprintf("BackendIMAP->ChangeFolder() createmailbox: '%s'", $newimapid));
if ($csts) {
imap_subscribe($this->mbox, $this->server . $newimapid);
$newid = $this->convertImapId($newimapid);
return $this->StatFolder($newid);
}
else {
ZLog::Write(LOGLEVEL_WARN, "BackendIMAP->ChangeFolder() : mailbox creation failed");
return false;
}
}
}
/**
* Deletes a folder
*
* @param string $id
* @param string $parent is normally false
*
* @access public
* @return boolean status - false if e.g. does not exist
* @throws StatusException could throw specific SYNC_FSSTATUS_* exceptions
*
*/
public function DeleteFolder($id, $parentid){
$imapid = $this->getImapIdFromFolderId($id);
if ($imapid) {
return imap_deletemailbox($this->mbox, $this->server.$imapid);
}
return false;