Haraka 3.0.4 → 3.1.0

package/CONTRIBUTORS.md

@@ -2,10 +2,11 @@
 
 This handcrafted artisinal software is brought to you by:
 
-| <img height="80" src="https://avatars.githubusercontent.com/u/261635?v=4"><br><a href="https://github.com/msimerson">msimerson</a> (<a href="https://github.com/haraka/Haraka/commits?author=msimerson">1619</a>)| <img height="80" src="https://avatars.githubusercontent.com/u/662371?v=4"><br><a href="https://github.com/baudehlo">baudehlo</a> (<a href="https://github.com/haraka/Haraka/commits?author=baudehlo">969</a>)| <img height="80" src="https://avatars.githubusercontent.com/u/550490?v=4"><br><a href="https://github.com/smfreegard">smfreegard</a> (<a href="https://github.com/haraka/Haraka/commits?author=smfreegard">794</a>)| <img height="80" src="https://avatars.githubusercontent.com/u/959600?v=4"><br><a href="https://github.com/godsflaw">godsflaw</a> (<a href="https://github.com/haraka/Haraka/commits?author=godsflaw">171</a>)| <img height="80" src="https://avatars.githubusercontent.com/u/934254?v=4"><br><a href="https://github.com/analogic">analogic</a> (<a href="https://github.com/haraka/Haraka/commits?author=analogic">42</a>)| <img height="80" src="https://avatars.githubusercontent.com/u/1674289?v=4"><br><a href="https://github.com/Dexus">Dexus</a> (<a href="https://github.com/haraka/Haraka/commits?author=Dexus">42</a>)| <img height="80" src="https://avatars.githubusercontent.com/u/82041?v=4"><br><a href="https://github.com/gramakri">gramakri</a> (<a href="https://github.com/haraka/Haraka/commits?author=gramakri">37</a>)|
+| <img height="80" src="https://avatars.githubusercontent.com/u/261635?v=4"><br><a href="https://github.com/msimerson">msimerson</a> (<a href="https://github.com/haraka/Haraka/commits?author=msimerson">1633</a>)| <img height="80" src="https://avatars.githubusercontent.com/u/662371?v=4"><br><a href="https://github.com/baudehlo">baudehlo</a> (<a href="https://github.com/haraka/Haraka/commits?author=baudehlo">969</a>)| <img height="80" src="https://avatars.githubusercontent.com/u/550490?v=4"><br><a href="https://github.com/smfreegard">smfreegard</a> (<a href="https://github.com/haraka/Haraka/commits?author=smfreegard">794</a>)| <img height="80" src="https://avatars.githubusercontent.com/u/959600?v=4"><br><a href="https://github.com/godsflaw">godsflaw</a> (<a href="https://github.com/haraka/Haraka/commits?author=godsflaw">171</a>)| <img height="80" src="https://avatars.githubusercontent.com/u/934254?v=4"><br><a href="https://github.com/analogic">analogic</a> (<a href="https://github.com/haraka/Haraka/commits?author=analogic">42</a>)| <img height="80" src="https://avatars.githubusercontent.com/u/1674289?v=4"><br><a href="https://github.com/Dexus">Dexus</a> (<a href="https://github.com/haraka/Haraka/commits?author=Dexus">42</a>)| <img height="80" src="https://avatars.githubusercontent.com/u/82041?v=4"><br><a href="https://github.com/gramakri">gramakri</a> (<a href="https://github.com/haraka/Haraka/commits?author=gramakri">37</a>)|
 | :---: | :---: | :---: | :---: | :---: | :---: | :---: |
-| <img height="80" src="https://avatars.githubusercontent.com/u/203240?v=4"><br><a href="https://github.com/lnedry">lnedry</a> (<a href="https://github.com/haraka/Haraka/commits?author=lnedry">23</a>)| <img height="80" src="https://avatars.githubusercontent.com/u/748075?v=4"><br><a href="https://github.com/celesteking">celesteking</a> (<a href="https://github.com/haraka/Haraka/commits?author=celesteking">21</a>)| <img height="80" src="https://avatars.githubusercontent.com/u/791972?v=4"><br><a href="https://github.com/lpatters">lpatters</a> (<a href="https://github.com/haraka/Haraka/commits?author=lpatters">20</a>)| <img height="80" src="https://avatars.githubusercontent.com/u/366268?v=4"><br><a href="https://github.com/chazomaticus">chazomaticus</a> (<a href="https://github.com/haraka/Haraka/commits?author=chazomaticus">19</a>)| <img height="80" src="https://avatars.githubusercontent.com/u/271024?v=4"><br><a href="https://github.com/hayesgm">hayesgm</a> (<a href="https://github.com/haraka/Haraka/commits?author=hayesgm">16</a>)| <img height="80" src="https://avatars.githubusercontent.com/u/123708?v=4"><br><a href="https://github.com/arlolra">arlolra</a> (<a href="https://github.com/haraka/Haraka/commits?author=arlolra">16</a>)| <img height="80" src="https://avatars.githubusercontent.com/u/1573133?v=4"><br><a href="https://github.com/gauravaror">gauravaror</a> (<a href="https://github.com/haraka/Haraka/commits?author=gauravaror">14</a>)|
-| <img height="80" src="https://avatars.githubusercontent.com/u/260607?v=4"><br><a href="https://github.com/typingArtist">typingArtist</a> (<a href="https://github.com/haraka/Haraka/commits?author=typingArtist">14</a>)| <img height="80" src="https://avatars.githubusercontent.com/u/158380?v=4"><br><a href="https://github.com/darkpixel">darkpixel</a> (<a href="https://github.com/haraka/Haraka/commits?author=darkpixel">12</a>)| <img height="80" src="https://avatars.githubusercontent.com/u/11343494?v=4"><br><a href="https://github.com/superman20">superman20</a> (<a href="https://github.com/haraka/Haraka/commits?author=superman20">12</a>)| <img height="80" src="https://avatars.githubusercontent.com/u/9887966?v=4"><br><a href="https://github.com/KingNoosh">KingNoosh</a> (<a href="https://github.com/haraka/Haraka/commits?author=KingNoosh">11</a>)| <img height="80" src="https://avatars.githubusercontent.com/u/5229495?v=4"><br><a href="https://github.com/tstonis">tstonis</a> (<a href="https://github.com/haraka/Haraka/commits?author=tstonis">10</a>)| <img height="80" src="https://avatars.githubusercontent.com/u/1746394?v=4"><br><a href="https://github.com/wltsmrz">wltsmrz</a> (<a href="https://github.com/haraka/Haraka/commits?author=wltsmrz">9</a>)| <img height="80" src="https://avatars.githubusercontent.com/u/2176651?v=4"><br><a href="https://github.com/fatalbanana">fatalbanana</a> (<a href="https://github.com/haraka/Haraka/commits?author=fatalbanana">8</a>)|
-| <img height="80" src="https://avatars.githubusercontent.com/u/231081?v=4"><br><a href="https://github.com/EyePulp">EyePulp</a> (<a href="https://github.com/haraka/Haraka/commits?author=EyePulp">8</a>)| <img height="80" src="https://avatars.githubusercontent.com/u/81561?v=4"><br><a href="https://github.com/Synchro">Synchro</a> (<a href="https://github.com/haraka/Haraka/commits?author=Synchro">8</a>)| <img height="80" src="https://avatars.githubusercontent.com/u/3957811?v=4"><br><a href="https://github.com/gene-hightower">gene-hightower</a> (<a href="https://github.com/haraka/Haraka/commits?author=gene-hightower">7</a>)| <img height="80" src="https://avatars.githubusercontent.com/u/103802?v=4"><br><a href="https://github.com/joshuathayer">joshuathayer</a> (<a href="https://github.com/haraka/Haraka/commits?author=joshuathayer">6</a>)| <img height="80" src="https://avatars.githubusercontent.com/u/8224508?v=4"><br><a href="https://github.com/DarkSorrow">DarkSorrow</a> (<a href="https://github.com/haraka/Haraka/commits?author=DarkSorrow">6</a>)| <img height="80" src="https://avatars.githubusercontent.com/u/1521113?v=4"><br><a href="https://github.com/hontas">hontas</a> (<a href="https://github.com/haraka/Haraka/commits?author=hontas">5</a>)| <img height="80" src="https://avatars.githubusercontent.com/u/1263856?v=4"><br><a href="https://github.com/ricardopolo">ricardopolo</a> (<a href="https://github.com/haraka/Haraka/commits?author=ricardopolo">5</a>)|
+| <img height="80" src="https://avatars.githubusercontent.com/u/203240?v=4"><br><a href="https://github.com/lnedry">lnedry</a> (<a href="https://github.com/haraka/Haraka/commits?author=lnedry">26</a>)| <img height="80" src="https://avatars.githubusercontent.com/u/748075?v=4"><br><a href="https://github.com/celesteking">celesteking</a> (<a href="https://github.com/haraka/Haraka/commits?author=celesteking">21</a>)| <img height="80" src="https://avatars.githubusercontent.com/u/791972?v=4"><br><a href="https://github.com/lpatters">lpatters</a> (<a href="https://github.com/haraka/Haraka/commits?author=lpatters">20</a>)| <img height="80" src="https://avatars.githubusercontent.com/u/366268?v=4"><br><a href="https://github.com/chazomaticus">chazomaticus</a> (<a href="https://github.com/haraka/Haraka/commits?author=chazomaticus">19</a>)| <img height="80" src="https://avatars.githubusercontent.com/u/271024?v=4"><br><a href="https://github.com/hayesgm">hayesgm</a> (<a href="https://github.com/haraka/Haraka/commits?author=hayesgm">16</a>)| <img height="80" src="https://avatars.githubusercontent.com/u/123708?v=4"><br><a href="https://github.com/arlolra">arlolra</a> (<a href="https://github.com/haraka/Haraka/commits?author=arlolra">16</a>)| <img height="80" src="https://avatars.githubusercontent.com/u/1573133?v=4"><br><a href="https://github.com/gauravaror">gauravaror</a> (<a href="https://github.com/haraka/Haraka/commits?author=gauravaror">14</a>)|
+| <img height="80" src="https://avatars.githubusercontent.com/u/260607?v=4"><br><a href="https://github.com/typingArtist">typingArtist</a> (<a href="https://github.com/haraka/Haraka/commits?author=typingArtist">14</a>)| <img height="80" src="https://avatars.githubusercontent.com/u/158380?v=4"><br><a href="https://github.com/darkpixel">darkpixel</a> (<a href="https://github.com/haraka/Haraka/commits?author=darkpixel">12</a>)| <img height="80" src="https://avatars.githubusercontent.com/u/11343494?v=4"><br><a href="https://github.com/superman20">superman20</a> (<a href="https://github.com/haraka/Haraka/commits?author=superman20">12</a>)| <img height="80" src="https://avatars.githubusercontent.com/u/9887966?v=4"><br><a href="https://github.com/KingNoosh">KingNoosh</a> (<a href="https://github.com/haraka/Haraka/commits?author=KingNoosh">11</a>)| <img height="80" src="https://avatars.githubusercontent.com/u/5229495?v=4"><br><a href="https://github.com/tstonis">tstonis</a> (<a href="https://github.com/haraka/Haraka/commits?author=tstonis">10</a>)| <img height="80" src="https://avatars.githubusercontent.com/u/1746394?v=4"><br><a href="https://github.com/wltsmrz">wltsmrz</a> (<a href="https://github.com/haraka/Haraka/commits?author=wltsmrz">9</a>)| <img height="80" src="https://avatars.githubusercontent.com/u/81561?v=4"><br><a href="https://github.com/Synchro">Synchro</a> (<a href="https://github.com/haraka/Haraka/commits?author=Synchro">8</a>)|
+| <img height="80" src="https://avatars.githubusercontent.com/u/2176651?v=4"><br><a href="https://github.com/fatalbanana">fatalbanana</a> (<a href="https://github.com/haraka/Haraka/commits?author=fatalbanana">8</a>)| <img height="80" src="https://avatars.githubusercontent.com/u/231081?v=4"><br><a href="https://github.com/EyePulp">EyePulp</a> (<a href="https://github.com/haraka/Haraka/commits?author=EyePulp">8</a>)| <img height="80" src="https://avatars.githubusercontent.com/u/3957811?v=4"><br><a href="https://github.com/gene-hightower">gene-hightower</a> (<a href="https://github.com/haraka/Haraka/commits?author=gene-hightower">7</a>)| <img height="80" src="https://avatars.githubusercontent.com/u/8224508?v=4"><br><a href="https://github.com/DarkSorrow">DarkSorrow</a> (<a href="https://github.com/haraka/Haraka/commits?author=DarkSorrow">6</a>)| <img height="80" src="https://avatars.githubusercontent.com/u/103802?v=4"><br><a href="https://github.com/joshuathayer">joshuathayer</a> (<a href="https://github.com/haraka/Haraka/commits?author=joshuathayer">6</a>)| <img height="80" src="https://avatars.githubusercontent.com/u/1521113?v=4"><br><a href="https://github.com/hontas">hontas</a> (<a href="https://github.com/haraka/Haraka/commits?author=hontas">5</a>)| <img height="80" src="https://avatars.githubusercontent.com/u/1263856?v=4"><br><a href="https://github.com/ricardopolo">ricardopolo</a> (<a href="https://github.com/haraka/Haraka/commits?author=ricardopolo">5</a>)|
 
-<sub>this file is maintained by [.release](https://github.com/msimerson/.release)</sub>
+<sub>this file is generated by [.release](https://github.com/msimerson/.release).
+Contribute to this project to get your GitHub profile included here.</sub>

package/Changes.md

@@ -1,5 +1,90 @@
+# Changelog
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/).
+
 ### Unreleased
 
+### [3.1.0] - 2025-01-30
+
+#### Changes
+
+##### BREAKING CHANGE
+
+`connection.ini` replaces the following config files:
+
+| old file | connection.ini setting |
+| ------ | ------ |
+| haproxy_hosts | [haproxy] hosts |
+| smtpgreeting | [message] greeting |
+| ehlo_hello_message | [message] helo |
+| connection_close_message | [message] close |
+| banner_includes_uuid | [uuid] banner_chars |
+| deny_includes_uuid | [uuid] deny_chars |
+| databytes | [max] bytes |
+| max_mime_parts | [max] mime_parts |
+| max_line_length | [max] line_length |
+| max_data_line_length | [max] data_line_length |
+
+AND 
+
+- moves the following settings from smtp.ini to connection.ini:
+  - headers.*
+  - main.smtp_utf8
+  - main.strict_rfc1869
+- early_talker.pause, removed support, use earlytalker.ini
+
+To upgrade, apply any localized settings from the old config files to
+the new `connection.ini` file. For tidiness, delete the deprecated
+config files.
+
+- feat(queue/test): Append UUID to E-Mails (avoid overwrite) #3449
+- repackage p/early_talker as plugin #3443
+- repackage p/mail_from.is_resolvable as plugin #3439
+- repackage p/relay as haraka-plugin-relay #3432
+- ci(cov): update codecov to v5
+- deps(eslint): update to v9 #3433
+- doc(plugins/\*.md): use \# to indicate heading levels
+- deps(various): bump to latest versions
+- doc(CoreConfig): removed incorrect early_talker.delay reference (hasn't worked in years).
+- doc(LICENSE) fix copyright year #3424
+- doc(access, backscatterer, & data.headers): deprecated plugin docs
+
+#### Fixes
+
+- fix(conn): always add connection.notes.tls properties #3450
+- fix(conn): cumulative greeting message for custom greetings #3446
+- fix(mail_from.is_resolvable): use correct config var path #3416
+- fix(bin/haraka): fix for finding path to config/docs/Plugins.md #3414
+- fix(outbound): in outbound, when mx.exchange contains an IP, use mx.from_dns #3413
+
+### [3.0.5] - 2024-09-27
+
+#### Fixed
+
+- fix(q/lmtp): revert a refactoring error #3407
+- fix: install Plugins.md when haraka -i #3406
+- fix(haraka -h): add missing return for plugin list #3405
+- fix `no_tls_hosts` related docs & tests #3404
+- fix: install docs/Plugins.md when haraka -i installed
+- fix(changes): spelling correction #3397
+
+#### Changed
+
+- lint: remove deprecated semi-style rule
+- removed dependency on ldap plugins #3399
+- doc(tls.md): add note for no_tls_hosts for outbound
+- test(tls): add tests for no_tls_hosts for inbound & outbound
+- dep version bumps:
+  - haraka-email-message: 1.2.4, #3408
+  - nodemailer: 6.9.15
+  - nopt: 8.0.0
+  - tld: 1.2.2
+  - plugin-dkim: 1.0.7
+  - plugin-dns-list: 1.2.1
+  - plugin-elastisearch: 8.0.3
+  - test-fixtures: 1.3.8
+
+
 ### [3.0.4] - 2024-08-21
 
 #### Added
@@ -46,7 +131,7 @@
   - client_pool.get_client & release_client: arity of 5 -> 2
   - mx_lookup: make it async/await
   - mx_lookup: deleted. Logic moved into net_utils #3322
-  - use net_utils.HarkaMx for get_mx parsing #3344
+  - use net_utils.HarakaMx for get_mx parsing #3344
   - emit log message when ignoring local MX #3285
   - pass in config when initiating txn #3315
   - minor es6 updates #3315, #3322
@@ -615,7 +700,7 @@
   - plugins/auth/auth_ldap -> haraka-plugin-auth-ldap #2144
   - plugins/graph -> haraka-plugin-graph #2185
 - config: replace ./config.js with haraka-config #2119
-- Replace concatenated strings with template literals (#2129) in:
+- Replace concatenated strings with template literals #2129 in:
   - attachment #2260
   - bin/spf #2129
   - bin/dkimverify #2278
@@ -651,7 +736,7 @@
   - plugins/spf #2266
   - plugins/toobusy #2186
   - plugins/xclient #2159
-  - rfc1869 #2159
+  - rfc1869 #2160
   - smtp_client #2129, #2208
   - tests/host_pool #2159
 - use es6 destructuring (#2075) in:
@@ -990,11 +1075,11 @@
 
 - The delay_deny plugin now has a whitelist mode (vs blacklist). #1564
 - Don't show the private key in logs for dkim_sign. #1565
-- update geoip for compat with newer ES (#1622)
-- drop node 0.10 testing / official support (#1621)
-- watch plugin displays UUIDs as URL (#1624)
+- update geoip for compat with newer ES #1622
+- drop node 0.10 testing / official support #1621
+- watch plugin displays UUIDs as URL #1624
 - Catch errors on header decode in rfc2231 #1599
-- Attachment plugin updates (#1606)
+- Attachment plugin updates #1606
 - add outbound.ini pool_timeout example setting #1584
 
 #### Fixes
@@ -1006,14 +1091,14 @@
 - outbound issues #1615, #1603
 - Fixed adding/removing headers in rspamd plugin. #1562
 - Fixed process_title not shutting down. #1560
-- fix a spurious error emitted by p0f (#1623)
-- fix header version hiding (#1617)
-- messagestream returns destination (#1610)
-- plugins.getdenyfn now passed 3rd params arg (#1591)
-- Fix scope of spf logdebug (#1598)
-- fix rabbitmq deliveryMode bug (#1594)
-- fix dkim_sign TypeError with null mail_from.host (#1592)
-- fix dkim_sign attempting to lower an undefined (#1587)
+- fix a spurious error emitted by p0f #1623
+- fix header version hiding #1617
+- messagestream returns destination #1610
+- plugins.getdenyfn now passed 3rd params arg #1591
+- Fix scope of spf logdebug #1598
+- fix rabbitmq deliveryMode bug #1594
+- fix dkim_sign TypeError with null mail_from.host #1592
+- fix dkim_sign attempting to lower an undefined #1587
 
 ### 2.8.8 - Jul 20, 2016
 
@@ -1044,18 +1129,16 @@
 #### Improvements
 
 - Allow alias plugin to explode to a list of aliases
-- Support IPv6 literals in HELO tests (#1507 thanks @gramakri)
-- Make ldap plugin use the modified address if a rcpt hook
-  changes it (#1501 thanks @darkpixel)
+- Support IPv6 literals in HELO tests #1507
+- Make ldap plugin use the modified address if a rcpt hook changes it #1501
 
 #### Fixes
 
-- Fix loading plugins as npm modules (#1513)
-- More DKIM fixes (#1506 thanks @zllovesuki)
-- Fix the long failing host-pool-timer test (#1508)
-- Fix clean shutdown of redis with new shutdown code
-  (#1504 and #1502 thanks @darkpixel)
-- More fixes to clean shutdown (#1503)
+- Fix loading plugins as npm modules #1513
+- More DKIM fixes #1506
+- Fix the long failing host-pool-timer test #1508
+- Fix clean shutdown of redis with new shutdown code, #1504 and #1502
+- More fixes to clean shutdown #1503
 
 ### 2.8.6 - Jun 06, 2016
 
@@ -1081,9 +1164,9 @@
 
 #### Fixes
 
-- Bind maxmind version to ignore API change (#1492)
-- Fix encodings when banners are used (#1477)
-- Various DKIM fixes (#1495)
+- Bind maxmind version to ignore API change #1492
+- Fix encodings when banners are used #1477
+- Various DKIM fixes #1495
 
 ### 2.8.4 - May 24, 2016
 
@@ -1545,10 +1628,105 @@
 - Throw exception with set_banner as it is now non-functional. Will be returned in a future version.
 - Small fixes to data.uribl
 
-### 1.4.0 -
 
 [3.0.0]: https://github.com/haraka/Haraka/releases/tag/3.0.0
 [3.0.1]: https://github.com/haraka/Haraka/releases/tag/v3.0.1
 [3.0.2]: https://github.com/haraka/Haraka/releases/tag/v3.0.2
 [3.0.3]: https://github.com/haraka/Haraka/releases/tag/v3.0.3
 [3.0.4]: https://github.com/haraka/Haraka/releases/tag/3.0.4
+[3.0.5]: https://github.com/haraka/Haraka/releases/tag/v3.0.5
+[3.0.6]: https://github.com/haraka/Haraka/releases/tag/v3.0.6
+
+[2.8.0]: https://github.com/haraka/Haraka/releases/tag/v2.8.0
+[2.8.1]: https://github.com/haraka/Haraka/releases/tag/v2.8.1
+[2.8.3]: https://github.com/haraka/Haraka/releases/tag/v2.8.3
+[2.8.4]: https://github.com/haraka/Haraka/releases/tag/v2.8.4
+[2.8.5]: https://github.com/haraka/Haraka/releases/tag/v2.8.5
+[2.8.6]: https://github.com/haraka/Haraka/releases/tag/v2.8.6
+[2.8.7]: https://github.com/haraka/Haraka/releases/tag/v2.8.7
+[2.8.8]: https://github.com/haraka/Haraka/releases/tag/v2.8.8
+[2.8.9]: https://github.com/haraka/Haraka/releases/tag/v2.8.9
+[2.8.10]: https://github.com/haraka/Haraka/releases/tag/2.8.10
+[2.8.11]: https://github.com/haraka/Haraka/releases/tag/2.8.11
+[2.8.12]: https://github.com/haraka/Haraka/releases/tag/2.8.12
+[2.8.13]: https://github.com/haraka/Haraka/releases/tag/2.8.13
+[2.8.14]: https://github.com/haraka/Haraka/releases/tag/v2.8.14
+[2.8.15]: https://github.com/haraka/Haraka/releases/tag/2.8.15
+[2.8.16]: https://github.com/haraka/Haraka/releases/tag/2.8.16
+[2.8.17]: https://github.com/haraka/Haraka/releases/tag/2.8.17
+[2.8.18]: https://github.com/haraka/Haraka/releases/tag/2.8.18
+[2.8.19]: https://github.com/haraka/Haraka/releases/tag/v2.8.19
+[2.8.20]: https://github.com/haraka/Haraka/releases/tag/2.8.20
+[release-2.8.21]: https://github.com/haraka/Haraka/releases/tag/release-2.8.21
+[2.8.22]: https://github.com/haraka/Haraka/releases/tag/2.8.22
+[2.8.24]: https://github.com/haraka/Haraka/releases/tag/2.8.24
+[2.8.25]: https://github.com/haraka/Haraka/releases/tag/2.8.25
+[2.8.26]: https://github.com/haraka/Haraka/releases/tag/2.8.26
+[2.8.27]: https://github.com/haraka/Haraka/releases/tag/2.8.27
+[2.8.28]: https://github.com/haraka/Haraka/releases/tag/2.8.28
+
+[2.7.3]: https://github.com/haraka/Haraka/releases/tag/v2.7.3
+[2.7.2]: https://github.com/haraka/Haraka/releases/tag/v2.7.2
+[2.7.1]: https://github.com/haraka/Haraka/releases/tag/v2.7.1
+[2.7.0]: https://github.com/haraka/Haraka/releases/tag/v2.7.0
+
+[2.6.0]: https://github.com/haraka/Haraka/releases/tag/v2.6.0
+[2.6.1]: https://github.com/haraka/Haraka/releases/tag/v2.6.1
+[2.5.0]: https://github.com/haraka/Haraka/releases/tag/v2.5.0
+[2.4.0]: https://github.com/haraka/Haraka/releases/tag/v2.4.0
+[2.3.1]: https://github.com/haraka/Haraka/releases/tag/v2.3.1
+[2.3.0]: https://github.com/haraka/Haraka/releases/tag/v2.3.0
+[2.2.0]: https://github.com/haraka/Haraka/releases/tag/v2.2.0
+[2.2.1]: https://github.com/haraka/Haraka/releases/tag/v2.2.1
+[2.2.2]: https://github.com/haraka/Haraka/releases/tag/v2.2.2
+[2.2.3]: https://github.com/haraka/Haraka/releases/tag/v2.2.3
+[2.2.4]: https://github.com/haraka/Haraka/releases/tag/v2.2.4
+[2.2.5]: https://github.com/haraka/Haraka/releases/tag/v2.2.5
+[2.2.6]: https://github.com/haraka/Haraka/releases/tag/v2.2.6
+[2.2.7]: https://github.com/haraka/Haraka/releases/tag/v2.2.7
+[2.2.8]: https://github.com/haraka/Haraka/releases/tag/v2.2.8
+[2.1.0]: https://github.com/haraka/Haraka/releases/tag/v2.1.0
+[2.1.1]: https://github.com/haraka/Haraka/releases/tag/v2.1.1
+[2.1.2]: https://github.com/haraka/Haraka/releases/tag/v2.1.2
+[2.1.3]: https://github.com/haraka/Haraka/releases/tag/v2.1.3
+[2.1.4]: https://github.com/haraka/Haraka/releases/tag/v2.1.4
+[2.1.5]: https://github.com/haraka/Haraka/releases/tag/v2.1.5
+[2.1.6]: https://github.com/haraka/Haraka/releases/tag/v2.1.6
+
+[2.0.0]: https://github.com/haraka/Haraka/releases/tag/v2.0.0
+[2.0.3]: https://github.com/haraka/Haraka/releases/tag/v2.0.3
+[2.0.4]: https://github.com/haraka/Haraka/releases/tag/v2.0.4
+[2.0.5]: https://github.com/haraka/Haraka/releases/tag/v2.0.5
+
+[1.0.1]: https://github.com/haraka/Haraka/releases/tag/v1.0.1
+[1.0.2]: https://github.com/haraka/Haraka/releases/tag/v1.0.2
+[1.1.0]: https://github.com/haraka/Haraka/releases/tag/v1.1.0
+[1.2.0]: https://github.com/haraka/Haraka/releases/tag/v1.2.0
+[1.2.1]: https://github.com/haraka/Haraka/releases/tag/v1.2.1
+[1.3.0]: https://github.com/haraka/Haraka/releases/tag/v1.3.0
+[1.3.1]: https://github.com/haraka/Haraka/releases/tag/v1.3.1
+[1.3.2]: https://github.com/haraka/Haraka/releases/tag/v1.3.2
+[1.3.3]: https://github.com/haraka/Haraka/releases/tag/v1.3.3
+[1.4.0]: https://github.com/haraka/Haraka/releases/tag/v1.4.0
+
+[0.9.0]: https://github.com/haraka/Haraka/releases/tag/v0.9.0
+[0.8.0]: https://github.com/haraka/Haraka/releases/tag/v0.8.0
+[0.7.2]: https://github.com/haraka/Haraka/releases/tag/v0.7.2
+[0.7.1]: https://github.com/haraka/Haraka/releases/tag/v0.7.1
+[0.7.0]: https://github.com/haraka/Haraka/releases/tag/v0.7.0
+[0.6.1]: https://github.com/haraka/Haraka/releases/tag/v0.6.1
+[0.6.0]: https://github.com/haraka/Haraka/releases/tag/v0.6.0
+[0.5.11]: https://github.com/haraka/Haraka/releases/tag/v0.5.11
+[0.5.10]: https://github.com/haraka/Haraka/releases/tag/v0.5.10
+[0.5.9]: https://github.com/haraka/Haraka/releases/tag/v0.5.9
+[0.5.8]: https://github.com/haraka/Haraka/releases/tag/v0.5.8
+[0.5.7]: https://github.com/haraka/Haraka/releases/tag/v0.5.7
+[0.5.6]: https://github.com/haraka/Haraka/releases/tag/v0.5.6
+[0.5.5]: https://github.com/haraka/Haraka/releases/tag/v0.5.5
+[0.5.4]: https://github.com/haraka/Haraka/releases/tag/v0.5.4
+[0.5.3]: https://github.com/haraka/Haraka/releases/tag/v0.5.3
+[0.5.2]: https://github.com/haraka/Haraka/releases/tag/v0.5.2
+[0.5]: https://github.com/haraka/Haraka/releases/tag/v0.5
+[0.4]: https://github.com/haraka/Haraka/releases/tag/v0.4
+[0.3]: https://github.com/haraka/Haraka/releases/tag/v0.3
+[0.2]: https://github.com/haraka/Haraka/releases/tag/v0.2

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2011 - 2018 Matt Sergeant
+Copyright (c) 2011 - 2025 Matt Sergeant
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/Plugins.md

@@ -92,7 +92,7 @@ A comprehensive list of known plugins. Create a PR to add yours to these lists.
 | [known-senders][url-known-senders]         | Reward emails from those you send mail to                                                   |
 | [LDAP][url-ldap]                           | Aliases, Auth, and Recipient validation from LDAP                                           |
 | [Limit][url-limit]                         | Apply many types of limits to SMTP connections                                              |
-| [log.elasticsearch][url-elastic]           | Store message metadata in Elasticsearch                                                     |
+| [elasticsearch][url-elastic]               | Store message metadata in Elasticsearch                                                     |
 | [log reader][url-logreader]                | extract log entries from the haraka log file                                                |
 | [syslog][url-syslog]                       | Log to syslog                                                                               |
 | [mail_from.is_resolvable][url-mfres]       | Verifies the MAIL FROM domain resolves to a MX                                              |
@@ -167,7 +167,7 @@ A comprehensive list of known plugins. Create a PR to add yours to these lists.
 [url-limit]: https://github.com/haraka/haraka-plugin-limit
 [url-logreader]: https://github.com/haraka/haraka-plugin-log-reader
 [url-milter]: https://github.com/haraka/haraka-plugin-milter
-[url-mfres]: https://github.com/haraka/Haraka/blob/master/docs/plugins/mail_from.is_resolvable.md
+[url-mfres]: https://github.com/haraka/haraka-plugin-mail_from.is_resolvable
 [url-msgsniff]: https://github.com/haraka/haraka-plugin-messagesniffer
 [url-ms]: http://www.armresearch.com/Products/
 [url-creds]: https://github.com/haraka/Haraka/blob/master/docs/plugins/prevent_credential_leaks.md
@@ -189,7 +189,7 @@ A comprehensive list of known plugins. Create a PR to add yours to these lists.
 [url-rqmd]: https://github.com/haraka/haraka-plugin-qmail-deliverable
 [url-rroutes]: https://github.com/haraka/haraka-plugin-recipient-routes
 [url-recordenv]: https://github.com/haraka/Haraka/blob/master/docs/plugins/record_envelope_addresses.md
-[url-relay]: https://github.com/haraka/Haraka/blob/master/docs/plugins/relay.md
+[url-relay]: https://github.com/haraka/haraka-plugin-relay
 [url-rng]: https://github.com/haraka/Haraka/blob/master/docs/plugins/reseed_rng.md
 [url-rspamd]: https://github.com/haraka/haraka-plugin-rspamd
 [url-spamass]: https://github.com/haraka/haraka-plugin-spamassassin

package/bin/haraka

@@ -228,7 +228,8 @@ const plugin_doc = [
 
 
 function getHooks () {   // see haraka/Haraka#3306
-    fs.readFileSync('docs/Plugins.md').toString()
+    const pi_path = path.resolve(parsed.configs, 'docs', 'Plugins.md')
+    return fs.readFileSync(pi_path).toString()
         .split('## Available Hooks')[1]    // discard everything before this string
         .split('### rcpt')[0]              // discard everything after this string
         .match(/\*\s(\S+)/gm)              // grab the first word of lines starting with '* '
@@ -554,6 +555,7 @@ else if (parsed.install) {
     for (const d of ['plugins', 'docs', 'config']) {
         utils.mkDir(path.join(pa, d));
     }
+    utils.copyFile(path.join(base, 'docs', 'Plugins.md'), path.join(pa, 'docs', 'Plugins.md'));
     utils.createFile(path.join(pa, 'README'), readme, {}, parsed.force);
     utils.createFile(path.join(pa, 'package.json'), packageJson, {}, parsed.force);
     const bytes = require('crypto').randomBytes(32);

package/config/connection.ini

@@ -0,0 +1,63 @@
+; 
+[main]
+
+; Require senders to conform to RFC 1869 and RFC 821 when sending the MAIL FROM and RCPT TO commands. In particular, the inclusion of spurious spaces or missing angle brackets will be rejected.
+; strict_rfc1869 = false
+
+; Advertise support for SMTPUTF8 (RFC-6531)
+; smtputf8=true
+
+
+[haproxy]
+; Array: hosts or CIDRs that Haraka should enable the PROXY protocol from. See docs/HAProxy for format
+hosts[] =
+; hosts[] = 192.0.2.4
+; hosts[] = 192.0.2.5
+; hosts[] = [2001:db8::1]
+; hosts[] = [2001:db8::2]
+
+
+[headers]
+; add_received=true
+; clean_auth_results=true
+
+; show_version=true
+
+max_lines=1000
+
+max_received=100
+
+
+[max]
+; Integer. The maximum SIZE of an email
+bytes=26214400
+
+; Integer. Limit a potential denial of service in potentially hostile emails.
+mime_parts=1000
+
+; Integer. The maximum length of lines in SMTP session commands (e.g. RCPT, HELO etc). Defaults to 512 (bytes) as mandated by RFC 5321 §4.5.3.1.4. Clients exceeding this limit will be immediately disconnected with a "521 Command line too long" error.
+line_length=512
+
+; Integer. The maximum length of lines in the DATA section of emails. Defaults to 992 (bytes), the limit set by Sendmail. When this limit is exceeded the three bytes "\r\n " (0x0d 0x0a 0x20) are inserted into the stream to "fix" it. This has the potential to "break" some email, but makes it more likely to be accepted by upstream/downstream services, and is the same behaviour as Sendmail. Also when the data line length limit is exceeded `transaction.notes.data_line_length_exceeded` is set to `true`.
+data_line_length=992
+
+
+[message]
+; Array. The greeting used when a client connects.
+; greeting[]=My Custom
+; greeting[]=Greeting Message
+
+helo=Haraka is at your service.
+
+; String. Override the default connection close message.
+close=closing connection. Have a jolly good day.
+
+
+[uuid]
+; integer, how many UUID chars to show.
+; 0 = none, 6 is enough to be unique per day, 40 will include the
+;     full connection and transaction UUID
+banner_chars=6
+
+; include N characters of the uuid (in brackets) at the start of each line of the deny message
+deny_chars=0

package/config/plugins

@@ -38,7 +38,6 @@
 # ----------
 # auth/flat_file
 # auth/auth_proxy
-# auth/auth_ldap
 
 # MAIL FROM
 # ----------
@@ -50,7 +49,6 @@ mail_from.is_resolvable
 # At least one rcpt_to plugin is REQUIRED for inbound email.
 rcpt_to.in_host_list
 # qmail-deliverable
-# rcpt_to.ldap
 # rcpt_to.routes
 
 # DATA

package/config/smtp.ini

@@ -22,6 +22,7 @@
 ;ignore_bad_plugins=0
 
 ; Run using cluster to fork multiple backend processes
+; Ref: https://github.com/haraka/Haraka/wiki/Performance-Tuning
 ;nodes=cpus
 
 ; Daemonize
@@ -43,21 +44,3 @@
 ;   after this time it will hard close. 30s is usually long enough to
 ;   wait for outbound connections to finish.
 ;force_shutdown_timeout=30
-
-; SMTP service extensions: https://tools.ietf.org/html/rfc1869
-; strict_rfc1869 = false
-
-; Advertise support for SMTPUTF8 (RFC-6531)
-;smtputf8=true
-
-[headers]
-;add_received=true
-;clean_auth_results=true
-
-;show_version=true
-
-; replace max_header_lines
-max_lines=1000
-
-; replace max_received_count
-max_received=100

package/config/tls.ini

@@ -77,5 +77,7 @@
 ; key=tls_key.pem
 ; cert=tls_cert.pem
 ; dhparam=dhparams.pem
+; no_tls_hosts[]=127.0.0.1
+; no_tls_hosts[]=192.168.1.1
 
 ; and other options from [main] section above