Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
An event driven SMTP server
JavaScript Other

Merge pull request #1100 from msimerson/karma-skip-outbound

karma: skip deny on outbound hooks
latest commit 5004e92d95
@msimerson msimerson authored
Failed to load latest commit information.
bin Allow for missing smtp.ini if smtp.yaml or smtp.json are present
cfreader add 'value' type to flat.empty
config karma: skip deny on outbound hooks
contrib added *BSD startup file for p0f
docs Fixed link to Results.md
http add HTTP support
plugins karma: skip deny on outbound hooks
tests does this solve the early_talker issue?
.gitignore load plugins from install directory's node_modules
.gitmodules working on packaging change.
.jshintrc replace infile jshint with .jshintrc
.travis.yml allow test failures against iojs-latest (curr 2.0)
Changes bring Changes back up-to-date
Dockerfile Switch to Phusion baseimage instead of stock Ubuntu
Gruntfile.js add Gruntfile.js
LICENSE LICENSE and TODO files
README.md added missing ] in AppVeyor badge
TODO add HTTP support
UPGRADE add deprecated notice within legacy plugins
address.js allow domains with underscore
appveyor.yml * add Windows build status badge
attachment_stream.js Store attachment headers on stream
chunkemitter.js Support node v0.6 by adding in Buffer.concat
config.js Fix JSON/YAML overrides
configfile.js Fix .ini file booleans on overriden values
connection.js Merge pull request #1075 from msimerson/early_talker
constants.js Improve logging of plugins and common plugin errors
dkim.js Fix timeout issue in dkim_verify
dsn.js DSN: Add new create() and RFC4954 support
fsync_writestream.js Address v0.10 compatibility
haraka.js Fix JSON/YAML overrides
haraka.sh Switch to Phusion baseimage instead of stock Ubuntu
line_socket.js smtp_forward.md: reference issue #573
logger.js Merge with upstream
mailbody.js Don't capture multi-part body text
mailheader.js Prevent plugins adding empty headers
messagestream.js Add missing return to allow pipe()'s to be chained together per #791
net_utils.js rename net_utils.is_rfc1918 -> is_private_ip
outbound.js Remove UUID from queued message
package.json Bumped version of node-syslog to fix build error on node v0.12
plugins.js Merge pull request #1081 from smfreegard/fix_plugin_ordering
result_store.js Tidy-up some ResultStore logging
rfc1869.js Finally fix RCPT parsing
run_tests cfreader/binary, flat, ini, json, yaml
server.js http: only run init_http hooks if http enabled
smtp_client.js Fix SMTP AUTH in smtp_forward/proxy and add docs
spf.js Node 0.11.x compatibility fixes
timer_queue.js Major fixes to all aspects of outbound
tls_socket.js Changing createCredentials to tls.createSecureContext
transaction.js Move data_post hook timer into transaction object
utils.js Move wildcard_to_regexp to utils

README.md

Haraka - a Node.js Mail Server

Build Status Coverage Status Windows Status

Haraka is a highly scalable node.js email server with a modular plugin architecture. Haraka can serve thousands of concurrent connections and deliver thousands of messages per second. Haraka and plugins are written in asyncronous JS and are very fast.

Haraka has very good spam protection (see plugins) and works well as a filtering MTA. It also works well as a MSA running on port 587 with auth and dkim_sign plugins enabled.

Haraka makes no attempt to be a mail store (like Exchange or Postix/Exim/Qmail), a LDA, nor an IMAP server (like Dovecot or Courier). Haraka is typically used with such systems.

Haraka has a scalable outbound mail delivery engine built in. Mail marked as relaying (such as via an auth plugin) is automatically queued for outbound delivery.

Getting Help

Screencast

Getting started with Haraka

Why Use Haraka?

Haraka's plugin architecure provides an easily extensible MTA that complements traditional MTAs that excel at managing mail stores but do not have sufficient filtering.

The plugin system makes it easy to code new features. A typical example is providing qmail-like extended addresses to an Exchange system, whereby you could receive mail as user-anyword@domain.com, and yet still have it correctly routed to user@domain.com. This is a few lines of code in Haraka.

Plugins are provided for running mail through SpamAssassin, validating HELO names, checking DNS Blocklists, and many others.

Installing Haraka

Haraka requires node.js to run. Install Haraka with npm:

npm install -g Haraka

After installion, use the haraka binary to set up the service.

Running Haraka

First, create the service:

haraka -i /path/to/haraka_test

That creates the directory haraka_test with config and plugin directories within. It also sets the host name used by Haraka to the output of hostname.

If hostname is not correct, edit config/host_list. For example, to receive mail addressed to user@domain.com, add domain.com to the config/host_list file.

Finally, start Haraka using root permissions:

haraka -c /path/to/haraka_test

And it will run.

Configure Haraka

To choose which plugins run, edit config/plugins. Plugins control the overall behaviour of Haraka. By default, only messages to domains listed in config/host_list will be accepted and then delivered via the smtp-forward plugin. Configure the destination in config/smtp_forward.ini.

Read the Fine Manual

haraka -h plugins/$name

The docs detail how each plugin is configured. After editing config/plugins, restart Haraka and enjoy!

Running from git

If you are unable to use npm to install Haraka, you can run from git by following these steps:

First clone the repository:

$ git clone https://github.com/baudehlo/Haraka.git
$ cd Haraka

Edit config/plugins and config/smtp.ini to specify the plugins and config you want.

Finally run Haraka:

$ node haraka.js

License and Author

Haraka is MIT licensed - see the LICENSE file for details.

Haraka is a project started by Matt Sergeant, a 10 year veteran of the email and anti-spam world. Previous projects have been the project leader for SpamAssassin and a hacker on Qpsmtpd.

Something went wrong with that request. Please try again.