haraka · msimerson · Sep 12, 2021 · Sep 9, 2021 · Sep 9, 2021 · Sep 9, 2021
diff --git a/Changes.md b/Changes.md
@@ -17,6 +17,7 @@
 - tls: require secure and verified sockets for configured hosts/domains
 - tls: add `no_starttls_ports` - an array of incoming ports where STARTTLS is not advertised
 - outbound: add local_mx_ok config #2952
+- skip plugins at runtime by pushing name into transaction.skip_plugins #2966
 
 ### Fixes
 

diff --git a/docs/Plugins.md b/docs/Plugins.md
@@ -267,6 +267,10 @@ Check the order that the plugins will run on each hook by running:
 
 `haraka -o -c /path/to/config`
 
+## Skipping Plugins
+
+Plugins can be skipped at runtime by pushing the name of the plugin into the `skip_plugins` array in `transaction.notes`.  This array is reset for every transaction and once a plugin is added to the list, it will not run any hooks in that plugin for the remainder of the transaction.  For example, one could create a whitelist plugin that skipped `spamassassin` if the sender was in a whitelist.
+
 ## Logging
 
 Plugins inherit all the logging methods of `logger.js`, which are:

diff --git a/plugins.js b/plugins.js
@@ -529,6 +529,11 @@ plugins.run_next_hook = (hook, object, params) => {
         object.logdebug(`running ${hook} hook in ${item[0].name} plugin`);
     }
 
+    if (object.transaction && object.transaction.notes.skip_plugins.includes(item[0].name)) {
+        object.logdebug(`skipping ${item[0].name}_${hook} by request in notes`);
+        return callback();
+    }
+
     try {
         object.current_hook = item;
         object.hook = hook;

diff --git a/transaction.js b/transaction.js
@@ -30,6 +30,7 @@ class Transaction {
         this.body = null;
         this.parse_body = false;
         this.notes = new Notes();
+        this.notes.skip_plugins = [];
         this.header = new Header();
         this.message_stream = new MessageStream(this.cfg, this.uuid, this.header.header_list);
         this.discard_data = false;