To create your own plugin, see:
- the plugin template that includes all the boilerplate
- the Write a Plugin tutorial
- the Plugins section of the manual
NPM packaged plugins can be installed in the npm 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.
A mostly comprehensive list of plugins known to be working and maintained. Create a PR adding yours to this list.
| Plugin | Description |
|---|---|
| access | ACLs based on IPs, domains, email addrs, etc. |
| accounting_files | Retrieve, Store and Archive custom information of outbound traffic |
| aliases | Email aliases |
| attachment | Restrict attachment types |
| auth/flat_file | Auth against user/pass in a file |
| auth/auth_bridge | Auth against remote MTA |
| auth/auth_ldap | Auth against LDAP |
| auth/auth_proxy | Auth against remote MTA |
| auth/auth_vpopmaild | Auth against vpopmaild |
| avg | AVG antivirus scanner |
| backscatterer | Check remote IP against ips.backscatterer.org |
| block_me | Populate block list via forwarded emails |
| bounce | Many options for bounce processing |
| clamd | Anti-Virus scanning with ClamAV |
| fcrdns | Forward Confirmed reverse DNS |
| connect.p0f | TCP Fingerprinting |
| data.headers | Inspect and verify various email headers |
| data.signatures | Block emails whose bodies match signatures |
| data.uribl | Block based on URI blacklists |
| dcc | Distributed Checksum Clearinghouse |
| delay_deny | Delays all pre-DATA 'deny' results |
| dkim_sign | DKIM sign outbound messages |
| dkim_verify | Verify DKIM signatures on incoming messages |
| dnsbl | Check remote MTAs against DNS blacklists |
| dnswl | Check remote MTAs against DNS whitelists |
| early_talker | Reject remotes that talk early |
| esets | Virus scanning with ESET Mail Security |
| greylist | Greylisting |
| helo.checks | Validaty checks of the HELO string |
| log.elasticsearch | Store message metadata in Elasticsearch |
| syslog | Log to syslog |
| mail_from.is_resolvable | Verifies the MAIL FROM domain resolves to a MX |
| messagesniffer | Anti-spam via MessageSniffer |
| mongodb | Queue emails to MongoDB |
| prevent_credential_leaks | Prevent users from emailing their credentials |
| process_title | Populate ps output with activity counters |
| queue/discard | queues messages to /dev/null |
| queue/lmtp | deliver queued messages via LMTP |
| queue/qmail-queue | queue to qmail |
| queue/quarantine | queue to a quarantine directory |
| queue/rabbitmq | queue to RabbitMQ |
| queue/rabbitmq_amqplib | queue to RabbitMQ using amqplib |
| queue/smtp_bridge | Bridge SMTP sessions to another MTA |
| queue/smtp_forward | Forward emails to another MTA |
| queue/smtp_proxy | Proxy SMTP connections to another MTA |
| rcpt_to.in_host_list | Define local email domains in a file |
| rcpt_to.ldap | Validate recipients against LDAP |
| rcpt_to.qmail_deliverable | Validate recipients against Qmail-Deliverable |
| rcpt_to.routes | Route emails based on their recipient(s) |
| record_envelope_addresses | Adds message headers with ENV recips |
| relay | Manage relay permissions |
| reseed_rng | Reseed the RNG |
| rspamd | Scan emails with rspamd |
| spamassassin | Scan emails with SpamAssassin |
| spf | Perform SPF checks |
| tarpit | Slow down connections |
| tls | Implements TLS |
| toobusy | Defers connections when too busy |
| vmta | Virtual MTA management |
| xclient | Implements XCLIENT |