rcpt_to.routes

Recipient Routes does recipient validation and MX routing.

[![Build Status][ci-img]][ci-url]
[![Code Climate][clim-img]][clim-url]

Recipient Validation

Recipients can be listed in the [routes] section of the config file
config/rcpt_to.routes.ini or in Redis. If Redis is enabled and available, it is checked
first. Then the config file is checked.

Entries can be email addresses or domains. If both are present, email
addresses are favored.

If no route is discovered, recipient processing continues, allowing other
recipient plugins to vouch for the recipient. If none does, the recipient is
rejected.

$3

1. Redis email
2. Redis domain
3. File email
4. File domain

MX Routing

NOTE: MX routing by default routes _only_ based on domains. To route for email
addresses, you must set the preference always_split=true in
'config/outbound.ini'.

Each entry in the [routes] section of config/rcpt_to.routes.ini or in Redis
must specify a MX record. The MX record is the same format as _outbound.js_.
Examples:

* hostname
* hostname:port
* ipaddress
* ipaddress:port
* { priority: 0, exchange: hostname, port: 25 }

Configuration

The following options can be specified in config/rcpt_to.routes.ini:

$3

The [redis] section has optional settings (defaults shown):

[redis]
host=127.0.0.1
port=6379
db=0
enabled=true

$3

The [routes] section can include routes for domains and email addresses:

[routes]
example.com=mail.example.com:225
matt@example.com=some.where.com
spam@example.com=honeybucket.where.com:26

You may also use URI format to specify SMTP vs LMTP:

[routes]
aaron@example.com=lmtp://mail.example.com:2525
matt@example.com=smtp://127.0.0.1:4242

Performance

File based

Routes from the config file are loaded into an object at server startup. If
the config file changes, the routes automatically update. Key lookups in the
object are extremely fast. In 2014, the author measured 450,000 qps against
a 92,000 key object on a Xeon E5-2620 @ 2.10GHz.

Redis

The benchmarks published by the author(s) of the Node 'redis' module are
about 30,000 qps.

Author

Matt Simerson.

Underwritten and graciously donated to the Haraka community
by Serious Mumbo, Inc.

[ci-img]: https://github.com/haraka/haraka-plugin-recipient-routes/actions/workflows/ci.yml/badge.svg
[ci-url]: https://github.com/haraka/haraka-plugin-recipient-routes/actions/workflows/ci.yml
[clim-img]: https://codeclimate.com/github/haraka/haraka-plugin-recipient-routes/badges/gpa.svg
[clim-url]: https://codeclimate.com/github/haraka/haraka-plugin-recipient-routes