/
modules.php
866 lines (803 loc) · 39.1 KB
/
modules.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
<?php
/**
* IMAP folder management
* @package modules
* @subpackage imap_folders
*/
if (!defined('DEBUG_MODE')) { die(); }
// require_once APP_PATH.'modules/sievefilters/modules.php';
/**
* @subpackage imap_folders/handler
*/
class Hm_Handler_fix_folder_assignments extends Hm_Handler_Module {
public function process() {
/* only run on login */
if (!$this->session->loaded) {
return;
}
/* check for already fixed settings */
$specials = $this->user_config->get('special_imap_folders', array());
if (count($specials) == 0 || array_key_exists('imap_server', reset($specials))) {
return;
}
$updated = array();
$count = 0;
/* update special folders with imap details */
foreach ($specials as $index => $vals) {
if (!array_key_exists('imap_server', $vals)) {
$count++;
$server = Hm_IMAP_List::dump($index);
if (!is_array($server) || !array_key_exists('server', $server)) {
continue;
}
$vals['imap_user'] = $server['user'];
$vals['imap_server'] = $server['server'];
$updated[$index] = $vals;
}
}
/* save permanently if we updated anything */
if ($count) {
$this->user_config->set('special_imap_folders', $updated);
$this->user_config->save_on_login = true;
}
}
}
/**
* @subpackage imap_folders/handler
*/
class Hm_Handler_add_folder_manage_link extends Hm_Handler_Module {
public function process() {
$server = false;
$folder = false;
if (array_key_exists('imap_server_id', $this->request->post)) {
$server = $this->request->post['imap_server_id'];
}
if (array_key_exists('folder', $this->request->post)) {
$folder = $this->request->post['folder'];
}
if (($server || $server === 0) && !$folder) {
$this->out('imap_folder_manage_link', sprintf('?page=folders&imap_server_id=%s', $server));
}
}
}
/**
* @subpackage imap_folders/handler
*/
class Hm_Handler_process_clear_special_folder extends Hm_Handler_Module {
public function process() {
list($success, $form) = $this->process_form(array('special_folder_type', 'imap_server_id'));
if (!$success || !in_array($form['special_folder_type'], array('sent', 'draft', 'trash', 'archive'), true)) {
return;
}
$specials = $this->user_config->get('special_imap_folders', array());
if (array_key_exists($form['imap_server_id'], $specials)) {
$specials[$form['imap_server_id']][$form['special_folder_type']] = '';
}
$this->user_config->set('special_imap_folders', $specials);
Hm_Msgs::add('Special folder unassigned');
$this->session->record_unsaved('Special folder unassigned');
$this->out('imap_special_name', '');
}
}
/**
* @subpackage imap_folders/handler
*/
class Hm_Handler_process_special_folder extends Hm_Handler_Module {
public function process() {
list($success, $form) = $this->process_form(array('special_folder_type', 'folder', 'imap_server_id'));
if (!$success || !in_array($form['special_folder_type'], array('sent', 'draft', 'trash', 'archive', 'junk'), true)) {
return;
}
$cache = Hm_IMAP_List::get_cache($this->cache, $form['imap_server_id']);
$imap = Hm_IMAP_List::connect($form['imap_server_id'], $cache);
if (!is_object($imap) || $imap->get_state() != 'authenticated') {
Hm_Msgs('ERRUnable to connect to the selected IMAP server');
return;
}
$new_folder = prep_folder_name($imap, $form['folder'], true);
if (!$new_folder || !$imap->select_mailbox($new_folder)) {
Hm_Msgs('ERRSelected folder not found');
return;
}
$specials = $this->user_config->get('special_imap_folders', array());
if (!array_key_exists($form['imap_server_id'], $specials)) {
$specials[$form['imap_server_id']] = array('sent' => '', 'draft' => '', 'trash' => '', 'archive' => '', 'junk' => '');
}
$specials[$form['imap_server_id']][$form['special_folder_type']] = $new_folder;
$this->user_config->set('special_imap_folders', $specials);
Hm_Msgs::add('Special folder assigned');
$this->session->record_unsaved('Special folder assigned');
$this->out('imap_special_name', $new_folder);
}
}
/**
* @subpackage imap_folders/handler
*/
class Hm_Handler_process_accept_special_folders extends Hm_Handler_Module {
public function process() {
list($success, $form) = $this->process_form(array('imap_server_id', 'imap_service_name'));
if ($success) {
$cache = Hm_IMAP_List::get_cache($this->cache, $form['imap_server_id']);
$imap = Hm_IMAP_List::connect($form['imap_server_id'], $cache);
if (!is_object($imap) || $imap->get_state() != 'authenticated') {
Hm_Msgs('ERRUnable to connect to the selected IMAP server');
return;
}
$specials = $this->user_config->get('special_imap_folders', array());
$exposed = $imap->get_special_use_mailboxes();
if ($form['imap_service_name'] == 'gandi') {
$specials[$form['imap_server_id']] = array(
'sent' => 'Sent',
'draft' => 'Drafts',
'trash' => 'Trash',
'archive' => 'Archive',
'junk' => 'Junk'
);
} else {
$specials[$form['imap_server_id']] = array(
'sent' => $exposed['sent'] ?? '',
'draft' => $exposed['drafts'] ?? '',
'trash' => $exposed['trash'] ?? '',
'archive' => $exposed['archive'] ?? '',
'junk' => $exposed['junk'] ?? ''
);
}
$this->user_config->set('special_imap_folders', $specials);
$user_data = $this->user_config->dump();
$this->session->set('user_data', $user_data);
Hm_Msgs::add('Special folders assigned');
$this->session->record_unsaved('Special folders assigned');
$this->session->close_early();
}
}
}
/**
* @subpackage imap_folders/handler
*/
class Hm_Handler_process_folder_create extends Hm_Handler_Module {
public function process() {
list($success, $form) = $this->process_form(array('folder', 'imap_server_id'));
if ($success) {
$parent = false;
$parent_str = false;
if (array_key_exists('parent', $this->request->post) && trim($this->request->post['parent'])) {
$parent_str = decode_folder_str($this->request->post['parent']);
}
$cache = Hm_IMAP_List::get_cache($this->cache, $form['imap_server_id']);
$imap = Hm_IMAP_List::connect($form['imap_server_id'], $cache);
if (is_object($imap) && $imap->get_state() == 'authenticated') {
$new_folder = prep_folder_name($imap, $form['folder'], false, $parent_str);
if ($new_folder && $imap->create_mailbox($new_folder)) {
Hm_Msgs::add('Folder created');
$this->cache->del('imap_folders_imap_'.$form['imap_server_id'].'_');
$this->out('imap_folders_success', true);
}
else {
Hm_Msgs::add('ERRAn error occurred creating the folder');
}
}
}
}
}
/**
* @subpackage imap_folders/handler
*/
class Hm_Handler_process_folder_rename extends Hm_Handler_Module {
public function process() {
list($success, $form) = $this->process_form(array('imap_server_id', 'folder', 'new_folder'));
if ($success) {
$cache = Hm_IMAP_List::get_cache($this->cache, $form['imap_server_id']);
$imap = Hm_IMAP_List::connect($form['imap_server_id'], $cache);
$parent_str = false;
if (array_key_exists('parent', $this->request->post)) {
$parent_str = $this->request->post['parent'];
}
if (is_object($imap) && $imap->get_state() == 'authenticated') {
$old_folder = prep_folder_name($imap, $form['folder'], true);
$new_folder = prep_folder_name($imap, $form['new_folder'], false, $parent_str);
if ($new_folder && $old_folder && $imap->rename_mailbox($old_folder, $new_folder)) {
if ($this->module_is_supported('sievefilters') && $this->user_config->get('enable_sieve_filter_setting', true)) {
$imap_servers = $this->user_config->get('imap_servers');
$imap_account = $imap_servers[$form['imap_server_id']];
$linked_mailboxes = get_sieve_linked_mailbox($imap_account, $this);
if ($linked_mailboxes && in_array($old_folder, $linked_mailboxes)) {
list($sieve_host, $sieve_port, $sieve_tls) = parse_sieve_config_host($imap_account['sieve_config_host']);
try {
$client = new \PhpSieveManager\ManageSieve\Client($sieve_host, $sieve_port);
$client->connect($imap_account['user'], $imap_account['pass'], $sieve_tls, "", "PLAIN");
$script_names = array_filter(
$linked_mailboxes,
function ($value) use($old_folder) {
return $value == $old_folder;
}
);
$script_names = array_keys($script_names);
foreach ($script_names as $script_name) {
$script_parsed = $client->getScript($script_name);
$script_parsed = str_replace('"'.$old_folder.'"', '"'.$new_folder.'"', $script_parsed);
$old_actions = base64_decode(preg_split('#\r?\n#', $script_parsed, 0)[2]);
$new_actions = base64_encode(str_replace('"'.$old_folder.'"', '"'.$new_folder.'"', $old_actions));
$script_parsed = str_replace(base64_encode($old_actions), $new_actions, $script_parsed);
$client->removeScripts($script_name);
$client->putScript(
$script_name,
$script_parsed
);
}
$client->close();
Hm_Msgs::add('This folder is used in one or many filters, and it will be renamed as well');
} catch (Exception $e) {
Hm_Msgs::add("ERRFailed to rename folder in sieve scripts");
}
}
}
Hm_Msgs::add('Folder renamed');
$this->cache->del('imap_folders_imap_'.$form['imap_server_id'].'_');
$this->out('imap_folders_success', true);
}
else {
Hm_Msgs::add('ERRAn error occurred renaming the folder');
}
}
}
}
}
/**
* @subpackage imap_folders/handler
*/
class Hm_Handler_process_folder_delete extends Hm_Handler_Module {
public function process() {
list($success, $form) = $this->process_form(array('imap_server_id', 'folder'));
if ($success) {
$cache = Hm_IMAP_List::get_cache($this->cache, $form['imap_server_id']);
$imap = Hm_IMAP_List::connect($form['imap_server_id'], $cache);
if (is_object($imap) && $imap->get_state() == 'authenticated') {
$del_folder = prep_folder_name($imap, $form['folder'], true);
if ($this->module_is_supported('sievefilters') && $this->user_config->get('enable_sieve_filter_setting', true)) {
if (is_mailbox_linked_with_filters($del_folder, $form['imap_server_id'], $this)) {
Hm_Msgs::add('ERRThis folder can\'t be deleted because it is used in a filter.');
return;
}
}
if ($del_folder && $imap->delete_mailbox($del_folder)) {
Hm_Msgs::add('Folder deleted');
$this->cache->del('imap_folders_imap_'.$form['imap_server_id'].'_');
$this->out('imap_folders_success', true);
}
else {
Hm_Msgs::add('ERRAn error occurred deleting the folder');
}
}
}
}
}
/**
* @subpackage imap_folders/handler
*/
class Hm_Handler_special_folders extends Hm_Handler_Module {
public function process() {
if (array_key_exists('imap_server_id', $this->request->get)) {
$specials = $this->user_config->get('special_imap_folders', array());
if (array_key_exists($this->request->get['imap_server_id'], $specials)) {
$this->out('sent_folder', $specials[$this->request->get['imap_server_id']]['sent']);
$this->out('trash_folder', $specials[$this->request->get['imap_server_id']]['trash']);
$this->out('archive_folder', $specials[$this->request->get['imap_server_id']]['archive']);
$this->out('draft_folder', $specials[$this->request->get['imap_server_id']]['draft']);
$this->out('junk_folder', $specials[$this->request->get['imap_server_id']]['junk']);
}
}
else {
$this->out('special_imap_folders', $this->user_config->get('special_imap_folders'));
}
}
}
/**
* @subpackage imap_folders/handler
*/
class Hm_Handler_folders_server_id extends Hm_Handler_Module {
public function process() {
if (array_key_exists('imap_server_id', $this->request->get)) {
$this->out('folder_server', $this->request->get['imap_server_id']);
$this->out('page', $this->request->get['page']);
}
}
}
/**
* @subpackage imap_folders/handler
*/
class Hm_Handler_imap_folder_check extends Hm_Handler_Module {
public function process() {
$this->out('imap_support', $this->module_is_supported('imap'));
}
}
/**
* @subpackage imap_folders/handler
*/
class Hm_Handler_process_imap_folder_subscription extends Hm_Handler_Module {
public function process() {
list($success, $form) = $this->process_form(array('folder', 'subscription_state'));
if ($success) {
$imap_server_id = $this->request->get['imap_server_id'];
$cache = Hm_IMAP_List::get_cache($this->cache, $imap_server_id);
$imap = Hm_IMAP_List::connect($imap_server_id, $cache);
if (imap_authed($imap)) {
$folder = hex2bin($form['folder']);
$success = $imap->mailbox_subscription($folder, $form['subscription_state']);
if ($success) {
Hm_Msgs::add(sprintf('%s to %s', $form['subscription_state']? 'Subscribed': 'Unsubscribed', $folder));
$this->cache->del('imap_folders_imap_'.$imap_server_id.'_');
} else {
Hm_Msgs::add(sprintf('ERRAn error occurred %s to %s', $form['subscription_state']? 'subscribing': 'unsubscribing', $folder));
}
$this->out('imap_folder_subscription', $success);
}
}
}
}
/**
* Process input from the folder subscription setting in the settings page
* @subpackage imap/handler
*/
class Hm_Handler_process_only_subscribed_folders_setting extends Hm_Handler_Module {
public function process() {
function only_subscribed_folders_setting_callback($val) {
return $val;
}
process_site_setting('only_subscribed_folders', $this, 'only_subscribed_folders_setting_callback', false, true);
}
}
/**
* @subpackage imap_folders/output
*/
class Hm_Output_folders_server_select extends Hm_Output_Module {
protected function output() {
$server_id = $this->get('folder_server', '');
$res = '<div class="folders_page mt-4 row mb-4"><div class="col-lg-5 col-sm-12"><form id="form_folder_imap" method="get">';
$res .= '<input type="hidden" name="page" value="'.$this->get('page', 'folders').'" />';
$res .= '<div class="form-floating"><select class="form-select" id="imap_server_folder" name="imap_server_id">';
$res .= '<option ';
if (empty($server_id)) {
$res .= 'selected="selected" ';
}
$res .= 'value="">'.$this->trans('Select an IMAP server').'</option>';
foreach ($this->get('imap_servers', array()) as $id => $server) {
$res .= '<option ';
if ($server_id == $id) {
$res .= 'selected="selected" ';
}
$res .= 'value="'.$this->html_safe($id).'">';
$res .= $this->html_safe($server['name']);
}
$res .= '</select><label for="imap_server_folder">'.$this->trans('IMAP Server').'</label></div></form></div></div>';
$res .= '<input type="hidden" id="server_error" value="'.$this->trans('You must select an IMAP server first').'" />';
$res .= '<input type="hidden" id="folder_name_error" value="'.$this->trans('New folder name is required').'" />';
$res .= '<input type="hidden" id="delete_folder_error" value="'.$this->trans('Folder to delete is required').'" />';
$res .= '<input type="hidden" id="delete_folder_confirm" value="'.$this->trans('Are you sure you want to delete this folder, and all the messages in it?').'" />';
$res .= '<input type="hidden" id="rename_folder_error" value="'.$this->trans('Folder to rename is required').'" />';
return $res;
}
}
/**
* @subpackage imap_folders/output
*/
class Hm_Output_folders_delete_dialog extends Hm_Output_Module {
protected function output() {
if ($this->get('folder_server') !== NULL) {
$res = '<div class="row m-0 px-3 mt-3">';
$res .= '<div data-target=".delete_dialog" class="settings_subtitle col-12 border-bottom px-0">
<a href="#" class="pe-auto">'.$this->trans('Delete a Folder').'</a>
</div>';
$res .= '<div class="delete_dialog folder_dialog col-lg-4 col-md-6 col-sm-12 py-1 px-0">
<div class="folder_row">
<a href="#" class="select_delete_folder">'.$this->trans('Select Folder').'</a>:
<span class="selected_delete"></span>
</div>
<ul class="folders delete_folder_select">
<li class="delete_title">
<a href="#" class="close">'.$this->trans('Cancel').'</a>
</li>
</ul>
<input type="hidden" value="" id="delete_source" />
<input type="button" id="delete_folder" class="btn btn-danger" value="'.$this->trans('Delete').'">
</div></div>';
return $res;
}
}
}
/**
* @subpackage imap_folders/output
*/
class Hm_Output_folders_rename_dialog extends Hm_Output_Module {
protected function output() {
if ($this->get('folder_server') !== NULL) {
$res = '<div class="row m-0 px-3 mt-3">
<div data-target=".rename_dialog" class="settings_subtitle col-12 border-bottom px-0">
<a href="#" class="pe-auto">'.$this->trans('Rename a Folder').'</a>
</div>
<div class="rename_dialog folder_dialog col-lg-4 col-md-6 col-sm-12 py-3 px-0">
<div class="folder_row">
<a href="#" class="select_rename_folder">'.$this->trans('Select Folder').'</a>:
<span class="selected_rename"></span>
</div>
<div class="form-floating mb-3">
<input id="rename_value" type="text" class="form-control" value="" placeholder="'.$this->trans('New Folder Name').'">
<label for="rename_value">'.$this->trans('New Folder Name').'</label>
</div>
<ul class="folders rename_folder_select">
<li class="rename_title">
<a href="#" class="close">'.$this->trans('Cancel').'</a>
</li>
</ul>
<div class="folder_row">
<a href="#" class="select_rename_parent_folder">'.$this->trans('Select Parent Folder (optional)').'</a>:
<span class="selected_rename_parent"></span>
</div>
<ul class="folders rename_parent_folder_select">
<li class="rename_parent_title">
<a href="#" class="close">'.$this->trans('Cancel').'</a>
</li>
</ul>
<input type="hidden" value="" id="rename_parent_source" />
<input type="hidden" value="" id="rename_source" />
<input type="button" id="rename_folder" class="btn btn-primary" value="'.$this->trans('Rename').'">
</div>
</div>';
return $res;
}
}
}
/**
* @subpackage imap_folders/output
*/
class Hm_Output_folders_sent_dialog extends Hm_Output_Module {
protected function output() {
if ($this->get('folder_server') === NULL) {
return;
}
$sent_folder = $this->get('sent_folder', $this->trans('Not set'));
if (!$sent_folder) {
$sent_folder = $this->trans('Not set');
}
$res = '<div class="row m-0 px-3 mt-3">';
$res .= '<div data-target=".sent_folder_dialog" class="settings_subtitle col-12 border-bottom px-0">
<a href="#" class="pe-auto">'.$this->trans('Sent Folder').':<span id="sent_val">'.$sent_folder.'</span></a>
</div>';
$res .= '<div class="folder_dialog sent_folder_dialog col-lg-6 col-md-6 col-sm-12 py-3 px-0">
<div class="folder_row">
<div class="sp_description">'.$this->trans('If set, a copy of outbound mail sent with a profile tied to this IMAP account, will be saved in this folder').'</div>
</div>
<div class="folder_row">
<a href="#" class="select_sent_folder">'.$this->trans('Select Folder').'</a>:
<span class="selected_sent"></span>
</div>
<ul class="folders sent_folder_select">
<li class="sent_title">
<a href="#" class="close">'.$this->trans('Cancel').'</a>
</li>
</ul>
<input type="hidden" value="" id="sent_source" />
<div class="btn-group mt-3" role="group" aria-label="Sent Folder Actions">
<input type="button" id="set_sent_folder" class="btn btn-primary" value="'.$this->trans('Update').'" />
<input type="button" id="clear_sent_folder" class="btn btn-secondary" value="'.$this->trans('Remove').'" />
</div>
<br /><br />
</div>
</div>';
return $res;
}
}
/**
* @subpackage imap_folders/output
*/
class Hm_Output_folders_archive_dialog extends Hm_Output_Module {
protected function output() {
if ($this->get('folder_server') === NULL) {
return;
}
$archive_folder = $this->get('archive_folder', $this->trans('Not set'));
if (!$archive_folder) {
$archive_folder = $this->trans('Not set');
}
$res = '<div class="row m-0 px-3 mt-3">';
$res .= '<div data-target=".archive_folder_dialog" class="settings_subtitle col-12 border-bottom px-0">
<a href="#" class="pe-auto">'.$this->trans('Archive Folder').':<span id="archive_val">'.$archive_folder.'</span></a>
</div>';
$res .= '<div class="folder_dialog archive_folder_dialog col-lg-6 col-md-6 col-sm-12 py-3 px-0">
<div class="folder_row">
<div class="sp_description">'.$this->trans('If set, archived messages for this account will be moved to this folder').'</div>
</div>
<div class="folder_row">
<a href="#" class="select_archive_folder">'.$this->trans('Select Folder').'</a>:
<span class="selected_archive"></span>
</div>
<ul class="folders archive_folder_select">
<li class="archive_title">
<a href="#" class="close">'.$this->trans('Cancel').'</a>
</li>
</ul>
<input type="hidden" value="" id="archive_source" />
<div class="btn-group mt-3" role="group" aria-label="Archive Folder Actions">
<input type="button" id="set_archive_folder" class="btn btn-primary" value="'.$this->trans('Update').'" />
<input type="button" id="clear_archive_folder" class="btn btn-secondary" value="'.$this->trans('Remove').'" />
</div>
<br /><br />
</div>
</div>';
return $res;
}
}
/**
* @subpackage imap_folders/output
*/
class Hm_Output_folders_draft_dialog extends Hm_Output_Module {
protected function output() {
if ($this->get('folder_server') === NULL) {
return;
}
$draft_folder = $this->get('draft_folder', $this->trans('Not set'));
if (!$draft_folder) {
$draft_folder = $this->trans('Not set');
}
$res = '<div class="row m-0 px-3 mt-3">';
$res .= '<div data-target=".draft_folder_dialog" class="settings_subtitle col-12 border-bottom px-0">
<a href="#" class="pe-auto">'.$this->trans('Draft Folder').':<span id="draft_val">'.$draft_folder.'</span></a>
</div>';
$res .= '<div class="folder_dialog draft_folder_dialog col-lg-6 col-md-6 col-sm-12 py-3 px-0">
<div class="folder_row">
<div class="sp_description">'.$this->trans('If set, drafts will be saved in this folder').'</div>
</div>
<div class="folder_row">
<a href="#" class="select_draft_folder">'.$this->trans('Select Folder').'</a>:
<span class="selected_draft"></span>
</div>
<ul class="folders draft_folder_select">
<li class="draft_title">
<a href="#" class="close">'.$this->trans('Cancel').'</a>
</li>
</ul>
<input type="hidden" value="" id="draft_source" />
<div class="btn-group mt-3" role="group" aria-label="Draft Folder Actions">
<input type="button" id="set_draft_folder" class="btn btn-primary" value="'.$this->trans('Update').'" />
<input type="button" id="clear_draft_folder" class="btn btn-secondary" value="'.$this->trans('Remove').'" />
</div>
<br /><br />
</div>
</div>';
return $res;
}
}
/**
* @subpackage imap_folders/output
*/
class Hm_Output_folders_trash_dialog extends Hm_Output_Module {
protected function output() {
if ($this->get('folder_server') === NULL) {
return;
}
$trash_folder = $this->get('trash_folder', $this->trans('Not set'));
if (!$trash_folder) {
$trash_folder = $this->trans('Not set');
}
$res = '<div class="row m-0 px-3 mt-3">';
$res .= '<div data-target=".trash_folder_dialog" class="settings_subtitle col-12 border-bottom px-0">
<a href="#" class="pe-auto">'.$this->trans('Trash Folder').':<span id="trash_val">'.$trash_folder.'</span></a>
</div>';
$res .= '<input type="hidden" id="not_set_string" value="'.$this->trans('Not set').'" />';
$res .= '<div class="folder_dialog trash_folder_dialog col-lg-6 col-md-6 col-sm-12 py-3 px-0">
<div class="sp_description">'.$this->trans('If set, deleted messages for this account will be moved to this folder').'</div>
<div class="folder_row">
<a href="#" class="select_trash_folder">'.$this->trans('Select Folder').'</a>:
<span class="selected_trash"></span>
</div>
<ul class="folders trash_folder_select">
<li class="trash_title">
<a href="#" class="close">'.$this->trans('Cancel').'</a>
</li>
</ul>
<input type="hidden" value="" id="trash_source" />
<div class="btn-group mt-1" role="group" aria-label="Trash Folder Actions">
<input type="button" id="set_trash_folder" class="btn btn-primary" value="'.$this->trans('Update').'" />
<input type="button" id="clear_trash_folder" class="btn btn-secondary" value="'.$this->trans('Remove').'" />
</div>
</div></div>';
return $res;
}
}
/**
* @subpackage imap_folders/output
*/
class Hm_Output_folders_junk_dialog extends Hm_Output_Module {
protected function output() {
if ($this->get('folder_server') === NULL) {
return;
}
$junk_folder = $this->get('junk_folder', $this->trans('Not set'));
if (!$junk_folder) {
$junk_folder = $this->trans('Not set');
}
$res = '<div class="row m-0 px-3 mt-3">';
$res .= '<div data-target=".junk_folder_dialog" class="settings_subtitle col-12 border-bottom px-0">
<a href="#" class="pe-auto">'.$this->trans('Junk Folder').':<span id="junk_val">'.$junk_folder.'</span></a>
</div>';
$res .= '<input type="hidden" id="not_set_string" value="'.$this->trans('Not set').'" />';
$res .= '<div class="folder_dialog junk_folder_dialog col-lg-6 col-md-6 col-sm-12 py-3 px-0">
<div class="sp_description">'.$this->trans('If set, spams will be saved in this folder').'</div>
<div class="folder_row">
<a href="#" class="select_junk_folder">'.$this->trans('Select Folder').'</a>:
<span class="selected_junk"></span>
</div>
<ul class="folders junk_folder_select">
<li class="junk_title">
<a href="#" class="close">'.$this->trans('Cancel').'</a>
</li>
</ul>
<input type="hidden" value="" id="junk_source" />
<div class="btn-group mt-3" role="group" aria-label="Junk Folder Actions">
<input type="button" id="set_junk_folder" class="btn btn-primary" value="'.$this->trans('Update').'" />
<input type="button" id="clear_junk_folder" class="btn btn-secondary" value="'.$this->trans('Remove').'" />
</div>
<br /><br />
</div>
</div>';
$res .= '</div>';
return $res;
}
}
class Hm_Output_folders_folder_subscription extends Hm_Output_Module {
protected function output() {
if ($this->get('only_subscribed_folders_setting', 0) && ($server = $this->get('folder_server')) !== NULL) {
$res = '<div class="folder_row"><a href="#" class="subscribe_parent_folder" style="display:none;">';
$res .= $this->trans('Select Folder').'</a><span class="subscribe_parent"></span></div>';
$res .= '<ul class="folders subscribe_parent_folder_select"><li class="subscribe_title"></li></ul>';
$res .= '<input type="hidden" value="" id="subscribe_parent" />';
return $res;
}
}
}
/**
* @subpackage imap_folders/handler
*/
class Hm_Handler_get_only_subscribed_folders_setting extends Hm_Handler_Module {
public function process() {
$this->out('only_subscribed_folders_setting', $this->user_config->get('only_subscribed_folders_setting', 0));
}
}
/**
* @subpackage imap_folders/output
*/
class Hm_Output_folders_folder_subscription_button extends Hm_Output_Module {
protected function output() {
if ($this->get('only_subscribed_folders_setting', 0)) {
$server = $this->get('folder_server');
$results = '<div class="folder_subscription_btn"><a href="?page=folders_subscription';
$results .= !is_null($server)? '&imap_server_id='.$server: '';
$results .= '" title="'.$this->trans('Folders subscription').'"><i class="bi bi-gear-fill account_icon float-end"></i> ';
$results .= '</a></div>';
return $results;
}
}
}
/**
* @subpackage imap_folders/output
*/
class Hm_Output_folders_create_dialog extends Hm_Output_Module {
protected function output() {
if ($this->get('folder_server') !== NULL) {
$res = '<div class="row m-0 px-3 mt-3">
<div data-target=".create_dialog" class="settings_subtitle col-12 border-bottom px-0">
<a href="#" class="pe-auto">'.$this->trans('Create a New Folder').'</a>
</div>
<div class="create_dialog folder_dialog col-lg-4 col-md-6 col-sm-12 py-3 px-0">
<div class="form-floating mb-3">
<input class="form-control create_folder_name" id="create_value" type="text" value="" placeholder="'.$this->trans('New Folder Name').'">
<label for="create_value">'.$this->trans('New Folder Name').'</label>
</div>
<div class="folder_row">
<a href="#" class="select_parent_folder">'.$this->trans('Select Parent Folder (optional)').'</a>:
<span class="selected_parent"></span>
</div>
<ul class="folders parent_folder_select">
<li class="parent_title">
<a href="#" class="close">'.$this->trans('Cancel').'</a>
</li>
</ul>
<input type="hidden" value="" id="create_parent" />
<input type="button" id="create_folder" class="btn btn-primary mt-3" value="'.$this->trans('Create').'">
</div>
</div>';
return $res;
}
}
}
/**
* @subpackage imap_folders/output
*/
class Hm_Output_folders_subscription_content_start extends Hm_Output_Module {
protected function output() {
$res = '<div class="content_title">'.$this->trans('Folders subscription').'</div>';
return $res;
}
}
/**
* @subpackage imap_folders/output
*/
class Hm_Output_folders_content_start extends Hm_Output_Module {
protected function output() {
$res = '<div class="content_title">'.$this->trans('Folders').'</div>';
return $res;
}
}
/**
* @subpackage imap_folders/output
*/
class Hm_Output_folders_page_link extends Hm_Output_Module {
protected function output() {
if ($this->get('imap_support')) {
$res = '<li class="menu_folders"><a class="unread_link" href="?page=folders">';
if (!$this->get('hide_folder_icons')) {
$res .= '<i class="bi bi-folder-fill fs-5 me-2"></i>';
}
$res .= $this->trans('Folders').'</a></li>';
if ($this->format == 'HTML5') {
return $res;
}
$this->concat('formatted_folder_list', $res);
}
}
}
/**
* Option to enable/disable showing only subscribed folders
* @subpackage imap/output
*/
class Hm_Output_imap_only_subscribed_folders_setting extends Hm_Output_Module {
protected function output() {
$checked = '';
$reset = '';
$settings = $this->get('user_settings', array());
if (array_key_exists('only_subscribed_folders', $settings) && $settings['only_subscribed_folders']) {
$checked = ' checked="checked"';
$reset = '<span class="tooltip_restore" restore_aria_label="Restore default value"><i class="bi bi-arrow-repeat refresh_list reset_default_value_checkbox"></i></span>';
}
return '<tr class="general_setting"><td><label for="only_subscribed_folders">'.
$this->trans('Showing subscribed folders only').'</label></td>'.
'<td><input type="checkbox" '.$checked.' id="only_subscribed_folders" name="only_subscribed_folders" value="1" class="form-check-input" />'.$reset.'</td></tr>';
}
}
if (!hm_exists('get_sieve_linked_mailbox')) {
function get_sieve_linked_mailbox ($imap_account, $module) {
if (!$module->module_is_supported('sievefilters') && $module->user_config->get('enable_sieve_filter_setting', true)) {
return;
}
list($sieve_host, $sieve_port, $sieve_tls) = parse_sieve_config_host($imap_account['sieve_config_host']);
$client = new \PhpSieveManager\ManageSieve\Client($sieve_host, $sieve_port);
try {
$client->connect($imap_account['user'], $imap_account['pass'], $sieve_tls, "", "PLAIN");
$scripts = $client->listScripts();
$folders = [];
foreach ($scripts as $s) {
$script = $client->getScript($s);
$base64_obj = str_replace("# ", "", preg_split('#\r?\n#', $script, 0)[2]);
$obj = json_decode(base64_decode($base64_obj))[0];
if ($obj && in_array($obj->action, ['copy', 'move'])) {
$folders[$s] = $obj->value;
}
}
$client->close();
return $folders;
} catch (Exception $e) {
Hm_Msgs::add("ERRSieve: {$e->getMessage()}");
return;
}
}
}
if (!hm_exists('is_mailbox_linked_with_filters')) {
function is_mailbox_linked_with_filters ($mailbox, $imap_server_id, $module) {
$imap_servers = $module->user_config->get('imap_servers');
$imap_account = $imap_servers[$imap_server_id];
if (isset($imap_account['sieve_config_host'])) {
$linked_mailboxes = get_sieve_linked_mailbox($imap_account, $module);
return in_array($mailbox, $linked_mailboxes);
}
return false;
}
}