[ENH] add functionality to send later scheduled sending

cypht-org · Jun 19, 2024 · 0aef136 · 0aef136
1 parent a053782
commit 0aef136
Show file tree

Hide file tree

Showing 31 changed files with 446 additions and 205 deletions.
diff --git a/language/az.php b/language/az.php
@@ -630,4 +630,5 @@
     'IMAP and JMAP Servers' => false,
     'Junk' => false,
     'Trash' => false,
+    'You have %d scheduled messages that won\'t be executed if you quit' => false,
 );
diff --git a/language/de.php b/language/de.php
@@ -627,4 +627,5 @@
     'IMAP and JMAP Servers' => false,
     'Junk' => false,
     'Trash' => false,
+    'You have %d scheduled messages that won\'t be executed if you quit' => false,
 );
diff --git a/language/en.php b/language/en.php
@@ -645,4 +645,5 @@
     'IMAP and JMAP Servers' => false,
     'Junk' => false,
     'Trash' => false,
+    'You have %d scheduled messages that won\'t be executed if you quit' => false,
 );
diff --git a/language/es.php b/language/es.php
@@ -627,4 +627,5 @@
     'IMAP and JMAP Servers' => false,
     'Junk' => false,
     'Trash' => false,
+    'You have %d scheduled messages that won\'t be executed if you quit' => false,
 );
diff --git a/language/et.php b/language/et.php
@@ -635,4 +635,5 @@
     'IMAP and JMAP Servers' => false,
     'Junk' => false,
     'Trash' => false,
+    'You have %d scheduled messages that won\'t be executed if you quit' => false,
 );
diff --git a/language/fa.php b/language/fa.php
@@ -679,4 +679,5 @@
     'IMAP and JMAP Servers' => false,
     'Junk' => false,
     'Trash' => false,
+    'You have %d scheduled messages that won\'t be executed if you quit' => false,
 );
diff --git a/language/fr.php b/language/fr.php
@@ -626,4 +626,5 @@
     'IMAP and JMAP Servers' => false,
     'Junk' => false,
     'Trash' => false,
+    'You have %d scheduled messages that won\'t be executed if you quit' => false,
 );
diff --git a/language/hu.php b/language/hu.php
@@ -627,4 +627,5 @@
     'IMAP and JMAP Servers' => false,
     'Junk' => false,
     'Trash' => false,
+    'You have %d scheduled messages that won\'t be executed if you quit' => false,
 );
diff --git a/language/id.php b/language/id.php
@@ -634,4 +634,5 @@
     'IMAP and JMAP Servers' => false,
     'Junk' => false,
     'Trash' => false,
+    'You have %d scheduled messages that won\'t be executed if you quit' => false,
 );
diff --git a/language/it.php b/language/it.php
@@ -627,4 +627,5 @@
     'IMAP and JMAP Servers' => false,
     'Junk' => false,
     'Trash' => false,
+    'You have %d scheduled messages that won\'t be executed if you quit' => false,
 );
diff --git a/language/ja.php b/language/ja.php
@@ -627,4 +627,5 @@
     'IMAP and JMAP Servers' => false,
     'Junk' => false,
     'Trash' => false,
+    'You have %d scheduled messages that won\'t be executed if you quit' => false,
 );
diff --git a/language/nl.php b/language/nl.php
@@ -627,4 +627,5 @@
     'IMAP and JMAP Servers' => false,
     'Junk' => false,
     'Trash' => false,
+    'You have %d scheduled messages that won\'t be executed if you quit' => false,
 );
diff --git a/language/pt-BR.php b/language/pt-BR.php
@@ -626,4 +626,5 @@
     'IMAP and JMAP Servers' => false,
     'Junk' => false,
     'Trash' => false,
+    'You have %d scheduled messages that won\'t be executed if you quit' => false,
 );
diff --git a/language/ro.php b/language/ro.php
@@ -626,4 +626,5 @@
     'IMAP and JMAP Servers' => false,
     'Junk' => false,
     'Trash' => false,
+    'You have %d scheduled messages that won\'t be executed if you quit' => false,
 );
diff --git a/language/ru.php b/language/ru.php
@@ -628,4 +628,5 @@
     'IMAP and JMAP Servers' => false,
     'Junk' => false,
     'Trash' => false,
+    'You have %d scheduled messages that won\'t be executed if you quit' => false,
 );
diff --git a/language/zh-Hans.php b/language/zh-Hans.php
@@ -648,4 +648,5 @@
     'IMAP and JMAP Servers' => 'IMAP 服务器及 JMAP 服务器',
     'Junk' => '垃圾',
     'Trash' => '已删除',
+    'You have %d scheduled messages that won\'t be executed if you quit' => false,
 ); 
diff --git a/modules/core/functions.php b/modules/core/functions.php
@@ -607,3 +607,72 @@ function get_special_folders($mod, $id) {
     }
     return array();
 }
+
+/**
+ * @subpackage core/functions
+ */
+if (!hm_exists('get_nexter_date')) {
+function get_nexter_date($format, $only_label = false) {
+    if ($format == 'later_in_day') {
+        $date_string = 'today 18:00';
+        $label = 'Later in the day';
+    } elseif ($format == 'tomorrow') {
+        $date_string = '+1 day 08:00';
+        $label = 'Tomorrow';
+    } elseif ($format == 'next_weekend') {
+        $date_string = 'next Saturday 08:00';
+        $label = 'Next weekend';
+    } elseif ($format == 'next_week') {
+        $date_string = 'next week 08:00';
+        $label = 'Next week';
+    } elseif ($format == 'next_month') {
+        $date_string = 'next month 08:00';
+        $label = 'Next month';
+    } else {
+        $date_string = $format;
+        $label = 'Certain date';
+    }
+    $time = strtotime($date_string);
+    if ($only_label) {
+        return [$label, date('D, H:i', $time)];
+    }
+    return date('D, d M Y H:i', $time);
+}}
+
+/**
+ * @subpackage imap/functions
+ */
+if (!hm_exists('nexter_formats')) {
+function nexter_formats() {
+    $values = array(
+        'tomorrow',
+        'next_weekend',
+        'next_week',
+        'next_month'
+    );
+    if (date('H') <= 16) {
+        array_push($values, 'later_in_day');
+    }
+    return $values;
+}}
+
+/**
+ * @subpackage imap/functions
+ */
+if (!hm_exists('parse_nexter_header')) {
+    function parse_nexter_header($header, $name)
+    {
+        $header = str_replace("$name: ", '', $header);
+        $result = [];
+        foreach (explode(';', $header) as $kv)
+        {
+            $kv = trim($kv);
+            $spacePos = strpos($kv, ' ');
+            if ($spacePos > 0) {
+                $result[rtrim(substr($kv, 0, $spacePos), ':')] = trim(substr($kv, $spacePos+1));
+            } else {
+                $result[$kv] = true;
+            }
+        }
+        return $result;
+    }}
diff --git a/modules/core/site.js b/modules/core/site.js
@@ -1943,6 +1943,18 @@ var imap_smtp_edit_action = function(event) {
     }
 };
 
+var sprintf = function(format, ...args) {
+    let i = 0;
+    return format.replace(/%([sd])/g, (match, type) => {
+        let arg = args[i++];
+        switch (type) {
+            case 's': return String(arg);
+            case 'd': return Number(arg);
+            default: return match;
+        }
+    });
+}
+
 /* create a default message list object */
 var Hm_Message_List = new Message_List();
 
@@ -2693,3 +2705,29 @@ const observeMessageTextMutationAndHandleExternalResources = (inline) => {
         });
     }
 };
+
+var setup_nexter_date = function(callback) {
+    $(document).on('click', '.nexter_date_picker', function(e) {
+        document.querySelector('.nexter_input_date').showPicker();
+    });
+    $(document).on('click', '.nexter_date_helper', function(e) {
+        e.preventDefault();
+        $('.nexter_input').val($(this).attr('data-value')).trigger('change');
+    });
+    $(document).on('input', '.nexter_input_date', function(e) {
+        var now = new Date();
+        now.setMinutes(now.getMinutes() + 1);
+        $(this).attr('min', now.toJSON().slice(0, 16));
+        if (new Date($(this).val()).getTime() <= now.getTime()) {
+            $('.nexter_date_picker').css('border', '1px solid red');
+        } else {
+            $('.nexter_date_picker').css({'border': 'unset', 'border-top': '1px solid #ddd'});
+        }
+    });
+    $(document).on('change', '.nexter_input_date', function(e) {
+        if ($(this).val() && new Date().getTime() < new Date($(this).val()).getTime()) {
+            $('.nexter_input').val($(this).val()).trigger('change');
+        }
+    });
+    $(document).on('change', '.nexter_input', callback);
+}
diff --git a/modules/imap/functions.php b/modules/imap/functions.php
@@ -226,7 +226,7 @@ function format_imap_message_list($msg_list, $output_module, $parent_list=false,
         }
         $is_snoozed = !empty($msg['x_snoozed']) && hex2bin($msg['folder']) == 'Snoozed';
         if ($is_snoozed) {
-            $snooze_header = parse_snooze_header('X-Snoozed: '.$msg['x_snoozed']);
+            $snooze_header = parse_nexter_header('X-Snoozed: '.$msg['x_snoozed'], 'X-Snoozed');
             $date = $snooze_header['until'];
             $timestamp = strtotime($date);
         } else {
@@ -1276,7 +1276,7 @@ function snooze_message($imap, $msg_id, $folder, $snooze_tag) {
     preg_match("/^X-Snoozed:.*(\r?\n[ \t]+.*)*\r?\n?/im", $msg, $matches);
     if (count($matches)) {
         $msg = str_replace($matches[0], '', $msg);
-        $old_folder = parse_snooze_header($matches[0])['from'];
+        $old_folder = parse_nexter_header($matches[0], 'X-Snoozed')['from'];
     }
     if ($snooze_tag) {
         $from = $old_folder ?? $folder;
@@ -1302,7 +1302,7 @@ function snooze_message($imap, $msg_id, $folder, $snooze_tag) {
             }
         }
     } else {
-        $snooze_headers = parse_snooze_header($matches[0]);
+        $snooze_headers = parse_nexter_header($matches[0], 'X-Snoozed');
         $original_folder = $snooze_headers['from'];
         if ($imap->select_mailbox($original_folder) && $imap->append_start($original_folder, strlen($msg))) {
             $imap->append_feed($msg."\r\n");
@@ -1317,95 +1317,26 @@ function snooze_message($imap, $msg_id, $folder, $snooze_tag) {
     return $res;
 }}
 
-/**
- * @subpackage imap/functions
- */
-if (!hm_exists('parse_snooze_header')) {
-function parse_snooze_header($snooze_header)
-{
-    $snooze_header = str_replace('X-Snoozed: ', '', $snooze_header);
-    $result = [];
-    foreach (explode(';', $snooze_header) as $kv)
-    {
-        $kv = trim($kv);
-        $spacePos = strpos($kv, ' ');
-        if ($spacePos > 0) {
-            $result[rtrim(substr($kv, 0, $spacePos), ':')] = trim(substr($kv, $spacePos+1));
-        } else {
-            $result[$kv] = true;
-        }
-    }
-    return $result;
-}}
-
-/**
- * @subpackage imap/functions
- */
-if (!hm_exists('get_snooze_date')) {
-function get_snooze_date($format, $only_label = false) {
-    if ($format == 'later_in_day') {
-        $date_string = 'today 18:00';
-        $label = 'Later in the day';
-    } elseif ($format == 'tomorrow') {
-        $date_string = '+1 day 08:00';
-        $label = 'Tomorrow';
-    } elseif ($format == 'next_weekend') {
-        $date_string = 'next Saturday 08:00';
-        $label = 'Next weekend';
-    } elseif ($format == 'next_week') {
-        $date_string = 'next week 08:00';
-        $label = 'Next week';
-    } elseif ($format == 'next_month') {
-        $date_string = 'next month 08:00';
-        $label = 'Next month';
-    } else {
-        $date_string = $format;
-        $label = 'Certain date';
-    }
-    $time = strtotime($date_string);
-    if ($only_label) {
-        return [$label, date('D, H:i', $time)];
-    }
-    return date('D, d M Y H:i', $time);
-}}
-
-/**
- * @subpackage imap/functions
- */
-if (!hm_exists('snooze_formats')) {
-function snooze_formats() {
-    $values = array(
-        'tomorrow',
-        'next_weekend',
-        'next_week',
-        'next_month'
-    );
-    if (date('H') <= 16) {
-        array_push($values, 'later_in_day');
-    }
-    return $values;
-}}
-
 /**
  * @subpackage imap/functions
  */
 if (!hm_exists('snooze_dropdown')) {
 function snooze_dropdown($output, $unsnooze = false) {
-    $values = snooze_formats();
+    $values = nexter_formats();
 
     $txt = '<div class="dropdown d-inline-block">
-                <button type="button" class="btn btn-outline-success btn-sm dropdown-toggle" id="dropdownMenuSnooze" data-bs-toggle="dropdown" aria-haspopup="true" aria-expanded="true">'.$output->trans('Snooze').'</button>
-                <ul class="dropdown-menu" aria-labelledby="dropdownMenuSnooze">';
+                <button type="button" class="btn btn-outline-success btn-sm dropdown-toggle" id="dropdownMenuNexterDate" data-bs-toggle="dropdown" aria-haspopup="true" aria-expanded="true">'.$output->trans('Snooze').'</button>
+                <ul class="dropdown-menu" aria-labelledby="dropdownMenuNexterDate">';
     foreach ($values as $format) {
-        $labels = get_snooze_date($format, true);
-        $txt .= '<li><a href="#" class="snooze_helper dropdown-item d-flex justify-content-between gap-5" data-value="'.$format.'"><span>'.$output->trans($labels[0]).'</span> <span class="text-end">'.$labels[1].'</span></a></li>';
+        $labels = get_nexter_date($format, true);
+        $txt .= '<li><a href="#" class="nexter_date_helper dropdown-item d-flex justify-content-between gap-5" data-value="'.$format.'"><span>'.$output->trans($labels[0]).'</span> <span class="text-end">'.$labels[1].'</span></a></li>';
     }
     $txt .= '<li><hr class="dropdown-divider"></li>';
-    $txt .= '<li><label for="snooze_input_date" class="snooze_date_picker dropdown-item cursor-pointer">'.$output->trans('Pick a date').'</label>';
-    $txt .= '<input id="snooze_input_date" type="datetime-local" min="'.date('Y-m-d\Th:m').'" class="snooze_input_date" style="visibility: hidden; position: absolute; height: 0;">';
-    $txt .= '<input class="snooze_input" style="display:none;"></li>';
+    $txt .= '<li><label for="nexter_input_date" class="nexter_date_picker dropdown-item cursor-pointer">'.$output->trans('Pick a date').'</label>';
+    $txt .= '<input id="nexter_input_date" type="datetime-local" min="'.date('Y-m-d\Th:m').'" class="nexter_input_date" style="visibility: hidden; position: absolute; height: 0;">';
+    $txt .= '<input class="nexter_input" style="display:none;"></li>';
     if ($unsnooze) {
-        $txt .= '<a href="#" data-value="unsnooze" class="unsnooze snooze_helper dropdown-item"">'.$output->trans('Unsnooze').'</a>';
+        $txt .= '<a href="#" data-value="unsnooze" class="unsnooze nexter_date_helper dropdown-item"">'.$output->trans('Unsnooze').'</a>';
     }
     $txt .= '</ul></div>';
 
@@ -1496,3 +1427,42 @@ function connect_to_imap_server($address, $name, $port, $user, $pass, $tls, $ima
         }
     }
 }
+
+if (!hm_exists('save_sent_msg')) {
+function save_sent_msg($handler, $imap_id, $imap, $imap_details, $msg, $msg_id, $show_errors = true) {
+    $specials = get_special_folders($handler, $imap_id);
+    if (array_key_exists('sent', $specials) && $specials['sent']) {
+        $sent_folder = $specials['sent'];
+    }
+
+    if (!$sent_folder) {
+        $auto_sent = $imap->get_special_use_mailboxes('sent');
+        if (!array_key_exists('sent', $auto_sent)) {
+            return;
+        }
+        $sent_folder = $auto_sent['sent'];
+    }
+    if (!$sent_folder) {
+        Hm_Debug::add(sprintf("Unable to save sent message, no sent folder for IMAP %s", $imap_details['server']));
+    }
+    $uid = null;
+    if ($sent_folder) {
+        Hm_Debug::add(sprintf("Attempting to save sent message for IMAP server %s in folder %s", $imap_details['server'], $sent_folder));
+        if ($imap->append_start($sent_folder, strlen($msg), true)) {
+            $imap->append_feed($msg."\r\n");
+            if (!$imap->append_end() && $show_errors) {
+                Hm_Msgs::add('ERRAn error occurred saving the sent message');
+            }
+        }
+
+        $mailbox_page = $imap->get_mailbox_page($sent_folder, 'ARRIVAL', true, 'ALL', 0, 10);
+        foreach ($mailbox_page[1] as $mail) {
+            $msg_header = $imap->get_message_headers($mail['uid']);
+            if ($msg_header['Message-Id'] === $msg_id) {
+                $uid = $mail['uid'];
+                break;
+            }
+        }
+    }
+    return $uid;
+}}