feat(spam): add 'Report Spam' functionality to message controls and implement AJAX handler

Author: Grandi0z

modules/core/message_list_functions.php

@@ -419,6 +419,7 @@ function message_controls($output_mod) {
                     '<li><a class="dropdown-item msg_delete core_msg_control btn btn-sm btn-light text-black-50" href="#" data-action="delete">'.$output_mod->trans('Delete').'</a></li>'.
                     '<li><a class="dropdown-item msg_archive core_msg_control btn btn-sm btn-light text-black-50" href="#" data-action="archive">'.$output_mod->trans('Archive').'</a></li>'.
                     '<li><a class="dropdown-item msg_junk core_msg_control btn btn-sm btn-light text-black-50" href="#" data-action="junk">'.$output_mod->trans('Junk').'</a></li>'.
+                    '<li><a class="dropdown-item msg_report_spam core_msg_control btn btn-sm btn-light text-black-50" href="#" data-action="report_spam">'.$output_mod->trans('Report Spam').'</a></li>'.
                 '</ul>'.
             '</div>'.
             '<a class="msg_read core_msg_control btn btn-sm btn-light no_mobile border text-black-50" href="#" data-action="read">'.$output_mod->trans('Read').'</a>'.
@@ -427,7 +428,8 @@ function message_controls($output_mod) {
             '<a class="msg_unflag core_msg_control btn btn-sm btn-light no_mobile border text-black-50" href="#" data-action="unflag">'.$output_mod->trans('Unflag').'</a>'.
             '<a class="msg_delete core_msg_control btn btn-sm btn-light no_mobile border text-black-50" href="#" data-action="delete">'.$output_mod->trans('Delete').'</a>'.
             '<a class="msg_archive core_msg_control btn btn-sm btn-light no_mobile border text-black-50" href="#" data-action="archive">'.$output_mod->trans('Archive').'</a>'. 
-            '<a class="msg_junk core_msg_control btn btn-sm btn-light no_mobile border text-black-50" href="#" data-action="junk">'.$output_mod->trans('Junk').'</a>';
+            '<a class="msg_junk core_msg_control btn btn-sm btn-light no_mobile border text-black-50" href="#" data-action="junk">'.$output_mod->trans('Junk').'</a>'.
+            '<a class="msg_report_spam core_msg_control btn btn-sm btn-light no_mobile border text-black-50" href="#" data-action="report_spam">'.$output_mod->trans('Report Spam').'</a>';
 
     if ($output_mod->get('msg_controls_extra')) {
         $res .= $output_mod->get('msg_controls_extra');

modules/imap/handler_modules.php

@@ -2079,3 +2079,88 @@ function process_ceo_amount_limit_callback($val) { return $val; }
         process_site_setting('ceo_rate_limit', $this, 'process_ceo_amount_limit_callback');
     }
 }
+
+/**
+ * Report a message as spam
+ * @subpackage imap/handler
+ */
+class Hm_Handler_imap_report_spam extends Hm_Handler_Module {
+    /**
+     * Use IMAP to move the selected message to the junk folder
+     */
+    public function process() {
+        Hm_Debug::add('Report Spam handler starting');
+        list($success, $form) = $this->process_form(array('imap_msg_uid', 'imap_server_id', 'folder'));
+        Hm_Debug::add('Form processing result:', array('success' => $success, 'form' => $form));
+
+        if (!$success) {
+            Hm_Debug::add('Form processing failed');
+            return;
+        }
+
+        $junk_folder = false;
+        $form_folder = hex2bin($form['folder']);
+        $errors = 0;
+        $status = null;
+
+        $specials = get_special_folders($this, $form['imap_server_id']);
+        Hm_Debug::add('Special folders:', $specials);
+        
+        if (array_key_exists('junk', $specials) && $specials['junk']) {
+            $junk_folder = $specials['junk'];
+            Hm_Debug::add('Found junk folder:', $junk_folder);
+        }
+
+        $mailbox = Hm_IMAP_List::get_connected_mailbox($form['imap_server_id'], $this->cache);
+        Hm_Debug::add('Mailbox connection:', array(
+            'connected' => ($mailbox !== false),
+            'authed' => ($mailbox && $mailbox->authed()),
+            'is_imap' => ($mailbox && $mailbox->is_imap())
+        ));
+
+        if ($mailbox && !$mailbox->is_imap() && empty($junk_folder)) {
+            Hm_Debug::add('Using EWS JUNK action');
+            // EWS supports moving to junk folder directly
+            $status = $mailbox->message_action($form_folder, 'JUNK', array($form['imap_msg_uid']))['status'];
+            Hm_Debug::add('EWS JUNK action result:', $status);
+        } else {
+            if (!$junk_folder) {
+                Hm_Debug::add('No junk folder configured');
+                Hm_Msgs::add('No junk folder configured for this IMAP server', 'warning');
+                $errors++;
+            }
+
+            if (!$errors && $mailbox && $mailbox->authed()) {
+                $junk_exists = count($mailbox->get_folder_status($junk_folder));
+                Hm_Debug::add('Junk folder status:', array(
+                    'folder' => $junk_folder,
+                    'exists' => $junk_exists
+                ));
+                
+                if (!$junk_exists) {
+                    Hm_Debug::add('Junk folder does not exist');
+                    Hm_Msgs::add('Configured junk folder for this IMAP server does not exist', 'warning');
+                    $errors++;
+                }
+
+                /* try to move the message */
+                if (!$errors) {
+                    Hm_Debug::add('Attempting to move message to junk folder');
+                    $status = $mailbox->message_action($form_folder, 'MOVE', array($form['imap_msg_uid']), $junk_folder)['status'];
+                    Hm_Debug::add('Move action result:', $status);
+                }
+            }
+        }
+
+        if ($status) {
+            Hm_Debug::add('Message successfully reported as spam');
+            Hm_Msgs::add("Message reported as spam");
+        } else {
+            Hm_Debug::add('Failed to report message as spam');
+            Hm_Msgs::add('An error occurred reporting the message as spam', 'danger');
+        }
+
+        $this->out('imap_report_spam_error', !$status);
+        $this->save_hm_msgs();
+    }
+}

modules/imap/output_modules.php

@@ -388,9 +388,7 @@ protected function output() {
             $txt .= ' | <a class="hlink" id="copy_message" href="#">'.$this->trans('Copy').'</a>';
             $txt .= ' | <a class="hlink" id="move_message" href="#">'.$this->trans('Move').'</a>';
             $txt .= ' | <a class="archive_link hlink" id="archive_message" href="#">'.$this->trans('Archive').'</a>';
-            if($this->get('tags')){
-                $txt .= ' | '. tags_dropdown($this, $headers);
-            }
+            $txt .= ' | <a class="msg_report_spam core_msg_control btn btn-sm btn-light text-black-50" href="#" data-action="report_spam">'.$this->trans('Report Spam').'</a>';
             if (isset($headers['X-Schedule'])) {
                 $txt .= ' | ' . schedule_dropdown($this, true);
             }

modules/imap/setup.php

@@ -217,6 +217,14 @@
 add_handler('ajax_imap_archive_message', 'close_session_early',  true, 'core');
 add_handler('ajax_imap_archive_message', 'imap_archive_message',  true);
 
+/* report spam message callback */
+setup_base_ajax_page('ajax_imap_report_spam', 'core');
+add_handler('ajax_imap_report_spam', 'message_list_type', true, 'core');
+add_handler('ajax_imap_report_spam', 'imap_message_list_type', true);
+add_handler('ajax_imap_report_spam', 'load_imap_servers_from_config',  true);
+add_handler('ajax_imap_report_spam', 'imap_oauth2_token_check', true);
+add_handler('ajax_imap_report_spam', 'close_session_early',  true, 'core');
+add_handler('ajax_imap_report_spam', 'imap_report_spam',  true);
 
 /* ajax message action callback */
 add_handler('ajax_message_action', 'load_imap_servers_from_config',  true, 'imap', 'load_user_data', 'after');
@@ -300,6 +308,7 @@
         'ajax_imap_message_action',
         'ajax_imap_delete_message',
         'ajax_imap_archive_message',
+        'ajax_imap_report_spam',
         'ajax_imap_flag_message',
         'ajax_imap_update_combined_source',
         'ajax_imap_mark_as_read',

modules/imap/site.js

@@ -1264,8 +1264,15 @@ $(function() {
         }
     }
     setTimeout(prefetch_imap_folders, 2);
-});
 
+    $('#report_spam_message').on("click", function(e) { return imap_report_spam_message(); });
+    $(document).on('click', '.msg_report_spam', function(e) { 
+        e.preventDefault();
+        var uid = getMessageUidParam();
+        var detail = Hm_Utils.parse_folder_path(getListPathParam(), 'imap');
+        return imap_report_spam_message(false, uid, detail); 
+    });
+});
 
 var imap_archive_message = function(state, supplied_uid, supplied_detail) {
     var uid = getMessageUidParam();
@@ -1306,6 +1313,62 @@ var imap_archive_message = function(state, supplied_uid, supplied_detail) {
     return false;
 };
 
+var imap_report_spam_message = function(state, supplied_uid, supplied_detail) {
+    console.log('Report Spam clicked - Starting process');
+    var uid = getMessageUidParam();
+    var detail = Hm_Utils.parse_folder_path(getListPathParam(), 'imap');
+    console.log('Message details:', {uid: uid, detail: detail});
+    
+    if (supplied_uid) {
+        uid = supplied_uid;
+    }
+    if (supplied_detail) {
+        detail = supplied_detail;
+    }
+    if (detail && uid) {
+        console.log('Making AJAX request to report spam with params:', {
+            hook: 'ajax_imap_report_spam',
+            uid: uid,
+            server_id: detail.server_id,
+            folder: detail.folder
+        });
+        Hm_Ajax.request(
+            [{'name': 'hm_ajax_hook', 'value': 'ajax_imap_report_spam'},
+            {'name': 'imap_msg_uid', 'value': uid},
+            {'name': 'imap_server_id', 'value': detail.server_id},
+            {'name': 'folder', 'value': detail.folder}],
+            function(res) {
+                console.log('Report spam AJAX response:', res);
+                if (!res.imap_report_spam_error) {
+                    if (Hm_Utils.get_from_global('msg_uid', false)) {
+                        console.log('Message UID in global, returning');
+                        return;
+                    }
+                    var nlink = $('.nlink');
+                    if (nlink.length && Hm_Utils.get_from_global('auto_advance_email_enabled')) {
+                        console.log('Auto-advance enabled, redirecting to next message');
+                        Hm_Utils.redirect(nlink.attr('href'));
+                    }
+                    else {
+                        console.log('Redirecting to message list');
+                        if (!hm_list_parent()) {
+                            Hm_Utils.redirect("?page=message_list&list_path="+getListPathParam());
+                        }
+                        else {
+                            Hm_Utils.redirect("?page=message_list&list_path="+hm_list_parent());
+                        }
+                    }
+                } else {
+                    console.error('Error in report spam response:', res.imap_report_spam_error);
+                }
+            }
+        );
+    } else {
+        console.error('Missing required details:', {detail: detail, uid: uid});
+    }
+    return false;
+};
+
 var imap_show_add_contact_popup = function() {
     var popup = document.getElementById("contact_popup");
     popup.classList.toggle("show");