fix(frontend/backend): some servers do not support delivery status notification, so show a notice to users so they don't expect any delivery receipt

Author: mercihabam

modules/smtp/hm-smtp.php

@@ -89,6 +89,7 @@ class Hm_SMTP {
     private $scramAuthenticator;
     private $supports_tls;
     private $supports_auth;
+    private $supports_dsn;
     private $max_message_size;
 
     function __construct($conf) {
@@ -250,6 +251,9 @@ function capabilities($ehlo_response) {
                     $auth_mecs = array_slice($line[1], 1);
                     $this->supports_auth = array_map(function($v) { return mb_strtolower($v); }, $auth_mecs);
                     break;
+                case 'dsn': // supports delivery status notifications
+                    $this->supports_dsn = true;
+                    break;
                 case 'size': // advisary maximum message size
                     if(isset($line[1][1]) && is_numeric($line[1][1])) {
                         $this->max_message_size = $line[1][1];
@@ -634,6 +638,10 @@ function send_message($from, $recipients, $message, $from_params = '', $recipien
         return $result;
     }
 
+    function supports_dsn() {
+        return $this->supports_dsn;
+    }
+
     function puke() {
         return
             print_r($this->debug, true).

modules/smtp/js_modules/route_handlers.js

@@ -217,11 +217,25 @@ function applySmtpComposePageHandlers() {
             $('textarea[name="compose_body"]').focus();
         }
     }
+
+    const getSmtpProfileCallback = (res) => {
+        const deliveryReceiptCheckBox = $('#compose_delivery_receipt');
+        if (! res.dsn_supported) {
+            deliveryReceiptCheckBox.prop('checked', false);
+            deliveryReceiptCheckBox.prop('disabled', true);
+            deliveryReceiptCheckBox.next('label').after('<span class="badge bg-warning text-dark ms-2">Not supported by the selected SMTP server</span>');
+        } else {
+            deliveryReceiptCheckBox.prop('disabled', false);
+            deliveryReceiptCheckBox.prop('checked', true);
+            deliveryReceiptCheckBox.next('label').next('span.badge').remove();
+        }
+    };
+
     if ($('.sys_messages').text() != 'Message Sent') {
-        get_smtp_profile($('.compose_server').val());
+        get_smtp_profile($('.compose_server').val(), getSmtpProfileCallback);
     }
     $('.compose_server').on('change', function() {
-        get_smtp_profile($('.compose_server').val());
+        get_smtp_profile($('.compose_server').val(), getSmtpProfileCallback);
     });
     if($('.compose_attach_button').attr('disabled') == 'disabled'){
         check_attachment_dir_access();

modules/smtp/modules.php

@@ -564,6 +564,27 @@ public function process() {
     }
 }
 
+class Hm_Handler_smtp_supports_dsn extends Hm_Handler_Module {
+    public function process() {
+        if (! $this->user_config->get('enable_compose_delivery_receipt_setting')) {
+            return;
+        }
+
+        Hm_SMTP_List::init($this->user_config, $this->session);
+
+        $smtp_id = server_from_compose_smtp_id($this->request->post['compose_smtp_id']);
+        $smtp_details = Hm_SMTP_List::dump($smtp_id, true);
+        $mailbox = Hm_SMTP_List::connect($smtp_id, false, $smtp_details['user'], $smtp_details['pass']);
+        if (! $mailbox || ! $mailbox->authed()) {
+            Hm_Msgs::add("Failed to determine Delivery Status Notification. The server refused connection. user is: ".$smtp_details['user'], "danger");
+            $this->out('dsn_supported', false);
+            return;
+        }
+
+        $this->out('dsn_supported', $mailbox->get_connection()->supports_dsn());
+    }
+}
+
 if (!hm_exists('get_mime_type')) {
     function get_mime_type($filename)
     {
@@ -1193,7 +1214,7 @@ protected function output() {
                     (!$html ? '<label for="compose_body">'.$this->trans('Message').'</label>': '').
                 '</div>';
                 if($this->get('enable_compose_delivery_receipt_setting')) {
-                    $res .= '<div class="form-check mb-3"><input value="1" name="compose_delivery_receipt" id="compose_delivery_receipt" type="checkbox" class="form-check-input" checked/><label for="compose_delivery_receipt" class="form-check-label">'.$this->trans('Request a delivery receipt').'</label></div>';
+                    $res .= '<div class="form-check mb-3"><input value="1" name="compose_delivery_receipt" disabled id="compose_delivery_receipt" type="checkbox" class="form-check-input" checked/><label for="compose_delivery_receipt" class="form-check-label">'.$this->trans('Request a delivery receipt').'</label></div>';
                 }
         if ($html == 2) {
             $res .= '<link href="'.WEB_ROOT.'modules/smtp/assets/markdown/editor.css" rel="stylesheet" />'.

modules/smtp/setup.php

@@ -96,6 +96,7 @@
 setup_base_ajax_page('ajax_profiles_status', 'core');
 add_handler('ajax_profiles_status', 'load_imap_servers_from_config', true, 'imap', 'load_user_data', 'after');
 add_handler('ajax_profiles_status', 'profile_status', true, 'smtp', 'load_imap_servers_from_config', 'after');
+add_handler('ajax_profiles_status', 'smtp_supports_dsn', true, 'smtp', 'profile_status', 'after');
 
 /* resumable clear chunks */
 add_handler('ajax_clear_attachment_chunks', 'login', false, 'core');
@@ -164,6 +165,7 @@
         'sent_msg_id' => array(FILTER_VALIDATE_BOOLEAN, false),
         'enable_attachment_reminder' => array(FILTER_VALIDATE_BOOLEAN, false),
         'scheduled_msg_count' => array(FILTER_VALIDATE_INT, false),
+        'dsn_supported' => array(FILTER_VALIDATE_BOOLEAN, false),
     ),
     'allowed_post' => array(
         'post_archive' => FILTER_VALIDATE_INT,

modules/smtp/site.js

@@ -1,14 +1,16 @@
 'use strict';
 
-var get_smtp_profile = function(profile_value) {
+var get_smtp_profile = function(profile_value, callback) {
     if (typeof profile_value === "undefined" || profile_value == "0" || profile_value == "") {
         Hm_Notices.show('Please create a profile for saving sent messages option', 'warning');
     }
     else {
         Hm_Ajax.request(
             [{'name': 'hm_ajax_hook', 'value': 'ajax_profiles_status'},
-            {'name': 'profile_value', 'value': profile_value}],
+            {'name': 'profile_value', 'value': profile_value},
+            {'name': 'compose_smtp_id', 'value': profile_value}],
             function(res) {
+                callback(res);
             }
         );
     }