Plugins.md
Rama master · réplica de lectura del repositorio original.
# Haraka Plugins
To create your own plugin, see [Write a Plugin][write-plugin].
## Installing NPM packaged plugins
Plugins can be installed in the directory where Haraka was installed (where depends on your OS platform and whether you specified `-g`) or the Haraka install directory (haraka -i this_path). This example installs _my-great-plugin_ in the Haraka install directory:
```
cd /etc/haraka
npm install haraka-plugin-my-great-plugin
```
NPM then installs the plugin and its dependencies in a `node_modules` directory within the Haraka install directory.
## Plugin Registry
A comprehensive list of known plugins. Create a PR to add yours to these lists.
### Auth Plugins
| Name | Description | Published |
| -------------------------------- | ------------------------------------------------- | --------- |
| [auth-enc-file][url-authencflat] | Auth against user/pass in an encrypted file | 2018 |
| [flat_file][url-authflat] | Auth against user/pass in a file | 2026 |
| [auth_bridge][url-authbridge] | Auth against remote MTA | 2026 |
| [auth-imap][url-auth-imap] | Auth against IMAP server | 2022 |
| [auth_ldap][url-auth-ldap] | Auth against LDAP | 2023 |
| [auth_proxy][url-authproxy] | Auth against remote MTA | 2026 |
| [auth_vpopmaild][url-authvpop] | Auth against vpopmaild | 2026 |
| [dkim][url-dkim] | DKIM sign & verify | 2026 |
| [dovecot][url-dovecot] | SMTP AUTH & recipient validation against dovecot | 2025 |
| [LDAP][url-ldap] | Aliases, Auth, and Recipient validation from LDAP | 2024 |
| [mailauth][url-mailauth] | Email Auth (SPF, DKIM, DMARC, ARC, & BIMI) | 2024 |
| [opendkim][url-opendkim] | DKIM sign and verify email messages | 2018 |
| [spf][url-spf] | Perform SPF checks | 2026 |
### Enrichment Plugins
| Name | Description | Published |
| ------------------------------------------ | --------------------------------------------- | --------- |
| [ASN][url-asn] | Get ASN info for remote senders | 2026 |
| [fcrdns][url-fcrdns] | Forward Confirmed reverse DNS | 2025 |
| [geoip][url-geoip] | get geographic information about mail senders | 2026 |
| [p0f][url-p0f] | TCP Fingerprinting | 2025 |
| [karma][url-karma] | Dynamic scoring of incoming connections | 2026 |
| [known-senders][url-known-senders] | Reward emails from those you send mail to | 2025 |
| [record_envelope_addresses][url-recordenv] | Adds message headers with ENV recips | 2026 |
### Filtering Plugins
| Name | Description | Published |
| ------------------------------------ | ---------------------------------------------- | --------- |
| [attachment][url-attach] | Restrict attachment types | 2026 |
| [block_me][url-blockme] | Populate block list via forwarded emails | 2026 |
| [avg][url-avg] | AVG antivirus scanner | 2024 |
| [clamd][url-clamd] | Anti-Virus scanning with ClamAV | 2025 |
| [data.signatures][url-sigs] | Block emails whose bodies match signatures | 2026 |
| [dcc][url-dcc] | Distributed Checksum Clearinghouse | 2025 |
| [dns-list][url-dns-list] | Check against DNS and reputation lists | 2025 |
| [early_talker][url-early] | Reject remotes that talk early | 2026 |
| [esets][url-esets] | Virus scanning with ESET Mail Security | 2025 |
| [greylist][url-greylist] | Greylisting | 2026 |
| [helo.checks][url-helo] | Validity checks of the HELO string | 2026 |
| [mail_from.is_resolvable][url-mfres] | Verifies the MAIL FROM domain resolves to a MX | 2026 |
| [messagesniffer][url-msgsniff] | Anti-spam via [MessageSniffer][url-ms] | 2025 |
| [milter][url-milter] | milter support | 2017 |
| [rspamd][url-rspamd] | Scan emails with rspamd | 2026 |
| [spamassassin][url-spamass] | Scan emails with SpamAssassin | 2026 |
| [uribl][url-uribl] | Block based on URI blacklists | 2025 |
### Logging & Telemetry
| Name | Description | Published |
| -------------------------------------------- | ---------------------------------------------------------------------------- | --------- |
| [accounting_files][url-acc-files] | Retrieve, Store and Archive custom information of outbound traffic | 2017 |
| [elasticsearch][url-elastic] | Store message metadata in Elasticsearch | 2026 |
| [log reader][url-logreader] | extract log entries from the haraka log file | 2026 |
| [outbound-logger][url-outbound-logger] | JSON logging of outbound email. Logs metadata about delivered/bounced emails | — |
| [process_title][url-proctitle] | Populate `ps` output with activity counters | 2026 |
| [syslog][url-syslog] | Log to syslog | 2026 |
| [watch][url-watch] | Watch live SMTP traffic in a web interface | 2026 |
### Queue Plugins
| Name | Description | Published |
| ---------------------------------- | ---------------------------------------------------------------------------- | --------- |
| [discard][url-qdisc] | queues messages to /dev/null | 2026 |
| [kafka][url-kafka] | Queue inbound mail to a Kafka topic | 2023 |
| [lmtp][url-qlmtp] | deliver queued messages via LMTP | 2026 |
| [mailkite][url-mailkite] | Deliver mail to a MailKite backend (self-hosted or Cloud) as signed webhooks | 2026 |
| [mongodb][mongo-url] | Queue emails to MongoDB | 2024 |
| [qmail-queue][url-qmail] | queue to qmail | 2026 |
| [quarantine][url-qquart] | queue to a quarantine directory | 2026 |
| [rabbitmq][url-qrabbit] | queue to RabbitMQ | 2026 |
| [rabbitmq_amqplib][url-qrabbita] | queue to RabbitMQ using amqplib | — |
| [rails][url-qrails] | queue messages to a Rails app using [Action Mailbox][url-action-mailbox] | — |
| [smtp_bridge][url-qbridge] | Bridge SMTP sessions to another MTA | 2026 |
| [smtp_forward][url-qforward] | Forward emails to another MTA | 2026 |
| [smtp_proxy][url-qproxy] | Proxy SMTP connections to another MTA | 2026 |
| [wildduck][url-wildduck] | queue messages to Wild Duck | 2026 |
### Recipient Validation
| Name | Description | Published |
| ---------------------------------- | ----------------------------------------------------- | --------- |
| [dovecot][url-dovecot] | Recipient validation & SMTP AUTH against dovecot | 2025 |
| [LDAP][url-ldap] | Aliases, Auth, and Recipient validation from LDAP | 2024 |
| [recipient-routes][url-rroutes] | Route emails based on their recipient(s) | 2025 |
| [rcpt_to.in_host_list][url-rhost] | Define local email domains in a file | 2026 |
| [rcpt_to.ldap][url-rcpt-ldap] | Validate recipients against LDAP | 2023 |
| [rcpt-postgresql][url-postgres] | validate recipients against PostgreSQL | 2016 |
| [qmail-deliverable][url-rqmd] | Validate recipients against Qmail-Deliverable | 2026 |
| [vmta][url-vmta] | Virtual MTA management | 2017 |
| [wildduck][url-wildduck] | provides recipient checks against Wild Duck | 2026 |
### Every other Plugin
| Name | Description | Published |
| ------------------------------------------ | --------------------------------------------------------------- | --------- |
| [access][url-access] | ACLs based on IPs, domains, email addrs, etc. | 2026 |
| [aliases][url-aliases] | Email aliases | 2026 |
| [bounce][url-bounce] | Many options for bounce processing | 2026 |
| [delay_deny][url-delay] | Delays all pre-DATA 'deny' results | 2026 |
| [dovecot][url-dovecot] | Recipient validation & SMTP AUTH against dovecot | 2025 |
| [headers][url-headers] | Inspect and verify various email headers | 2026 |
| [Limit][url-limit] | Apply many types of limits to SMTP connections | 2025 |
| [prevent_credential_leaks][url-creds] | Prevent users from emailing their credentials | 2026 |
| [redis][url-redis] | multi-purpose Redis db connection(s) | 2025 |
| [relay][url-relay] | Manage relay permissions | 2026 |
| [reseed_rng][url-rng] | Reseed the RNG | 2026 |
| [batv-srs][url-batv] | BATV & SRS | 2020 |
| [srs][url-srs] | Sender Rewriting Scheme | — |
| [tarpit][url-tarpit] | Slow down connections | 2026 |
| [tls][url-tls] | Implements TLS | 2026 |
| [toobusy][url-toobusy] | Defers connections when too busy | 2026 |
| [xclient][url-xclient] | Implements XCLIENT | 2026 |
| [save-sent][url-save-sent] | Save sent emails on the serverside to a mailbox of the sender | — |
| [dropbox][url-dropbox] | Forward incoming emails to configured Dropbox webhook URLs. | — |
<!-- URLs tucked safely out of the way -->
[write-plugin]: https://github.com/haraka/Haraka/wiki/Write-a-Plugin
[plugins-doc]: https://haraka.github.io/core/Plugins
[url-access]: https://github.com/haraka/haraka-plugin-access
[url-acc-files]: https://github.com/acharkizakaria/haraka-plugin-accounting-files/blob/master/README.md
[url-action-mailbox]: https://guides.rubyonrails.org/action_mailbox_basics.html
[url-aliases]: https://github.com/haraka/Haraka/blob/master/docs/plugins/aliases.md
[url-asn]: https://github.com/haraka/haraka-plugin-asn
[url-attach]: https://github.com/haraka/haraka-plugin-attachment
[url-authencflat]: https://github.com/AuspeXeu/haraka-plugin-auth-enc-file
[url-authflat]: https://github.com/haraka/Haraka/blob/master/docs/plugins/auth/flat_file.md
[url-authbridge]: https://github.com/haraka/Haraka/blob/master/docs/plugins/auth/auth_bridge.md
[url-auth-imap]: https://github.com/haraka/haraka-plugin-auth-imap
[url-auth-ldap]: https://github.com/haraka/haraka-plugin-auth-ldap
[url-authproxy]: https://github.com/haraka/Haraka/blob/master/docs/plugins/auth/auth_proxy.md
[url-authvpop]: https://github.com/haraka/Haraka/blob/master/docs/plugins/auth/auth_vpopmaild.md
[url-avg]: https://github.com/haraka/haraka-plugin-avg
[url-batv]: https://www.npmjs.com/package/haraka-plugin-batv
[url-scatter]: https://github.com/haraka/Haraka/blob/master/docs/plugins/backscatterer.md
[url-blockme]: https://github.com/haraka/Haraka/blob/master/docs/plugins/block_me.md
[url-bounce]: https://www.npmjs.com/package/haraka-plugin-bounce
[url-clamd]: https://github.com/haraka/haraka-plugin-clamd
[url-dovecot]: https://github.com/haraka/haraka-plugin-dovecot
[url-fcrdns]: https://github.com/haraka/haraka-plugin-fcrdns
[url-p0f]: https://github.com/haraka/haraka-plugin-p0f
[url-headers]: https://github.com/haraka/haraka-plugin-headers
[url-sigs]: https://github.com/haraka/Haraka/blob/master/docs/plugins/data.signatures.md
[url-uribl]: https://github.com/haraka/haraka-plugin-uribl
[url-dcc]: https://github.com/haraka/haraka-plugin-dcc
[url-delay]: https://github.com/haraka/Haraka/blob/master/docs/plugins/delay_deny.md
[url-dkim]: https://github.com/haraka/haraka-plugin-dkim
[url-opendkim]: https://www.npmjs.com/package/haraka-plugin-opendkim
[url-dns-list]: https://github.com/haraka/haraka-plugin-dns-list
[url-early]: https://github.com/haraka/Haraka/blob/master/docs/plugins/early_talker.md
[url-esets]: https://github.com/haraka/haraka-plugin-esets
[url-geoip]: https://github.com/haraka/haraka-plugin-geoip
[url-graph]: https://github.com/haraka/haraka-plugin-graph
[url-greylist]: https://github.com/haraka/haraka-plugin-greylist
[url-helo]: https://github.com/haraka/haraka-plugin-helo.checks
[url-karma]: https://github.com/haraka/haraka-plugin-karma
[url-known-senders]: https://github.com/haraka/haraka-plugin-known-senders
[url-elastic]: https://github.com/haraka/haraka-plugin-elasticsearch/
[url-syslog]: https://github.com/haraka/haraka-plugin-syslog
[url-ldap]: https://github.com/haraka/haraka-plugin-ldap
[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-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
[url-postgres]: https://github.com/haraka/haraka-plugin-rcpt-postgresql
[url-proctitle]: https://github.com/haraka/Haraka/blob/master/docs/plugins/process_title.md
[url-qdisc]: https://github.com/haraka/Haraka/blob/master/docs/plugins/queue/discard.md
[url-qlmtp]: https://github.com/haraka/Haraka/blob/master/docs/plugins/queue/lmtp.md
[url-qmail]: https://github.com/haraka/Haraka/blob/master/docs/plugins/queue/qmail-queue.md
[url-qquart]: https://github.com/haraka/Haraka/blob/master/docs/plugins/queue/quarantine.md
[url-qrabbit]: https://github.com/haraka/haraka-plugin-queue-rabbitmq
[url-qbridge]: https://github.com/haraka/Haraka/blob/master/docs/plugins/queue/smtp_bridge.md
[url-qforward]: https://github.com/haraka/Haraka/blob/master/docs/plugins/queue/smtp_forward.md
[url-qproxy]: https://github.com/haraka/Haraka/blob/master/docs/plugins/queue/smtp_proxy.md
[url-qrails]: https://github.com/mailprotector/haraka-plugin-queue-rails
[url-redis]: https://github.com/haraka/haraka-plugin-redis
[url-rhost]: https://github.com/haraka/Haraka/blob/master/docs/plugins/rcpt_to.in_host_list.md
[url-rcpt-ldap]: https://github.com/haraka/haraka-plugin-rcpt-ldap
[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-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
[url-spf]: https://github.com/haraka/haraka-plugin-spf
[url-srs]: https://github.com/swerter/haraka-plugins/blob/master/plugins/srs.js
[url-tarpit]: https://github.com/haraka/Haraka/blob/master/docs/plugins/tarpit.md
[url-tls]: https://github.com/haraka/Haraka/blob/master/docs/plugins/tls.md
[url-toobusy]: https://github.com/haraka/Haraka/blob/master/docs/plugins/toobusy.md
[url-vmta]: https://github.com/haraka/haraka-plugin-vmta/blob/master/README.md
[url-watch]: https://github.com/haraka/haraka-plugin-watch
[url-wildduck]: https://github.com/nodemailer/haraka-plugin-wildduck
[url-xclient]: https://github.com/haraka/Haraka/blob/master/docs/plugins/xclient.md
[mongo-url]: https://github.com/Helpmonks/haraka-plugin-mongodb
[url-outbound-logger]: https://github.com/mr-karan/haraka-plugin-outbound-logger
[url-kafka]: https://github.com/benjamonnguyen/haraka-plugin-queue-kafka
[url-mailauth]: https://www.npmjs.com/package/haraka-plugin-mailauth
[url-save-sent]: https://github.com/AprilGrimoire/haraka-plugin-save-sent
[url-dropbox]: https://github.com/dspangenberg/haraka-plugin-dropbox
[url-mailkite]: https://github.com/mailkite/server/tree/main/packages/haraka-plugin-mailkite