Haraka 3.1.1 → 3.1.2

package/docs/plugins/queue/qmail-queue.md

@@ -1,19 +1,17 @@
-queue/qmail-queue
-=================
+# queue/qmail-queue
 
 This plugin delivers the mail to the `qmail-queue` program, which can be used
 for both inbound and outbound delivery.
 
-Configuration
--------------
+## Configuration
 
-* qmail-queue.path
+- qmail-queue.path
 
   The path to the `qmail-queue` binary. Default: `/var/qmail/bin/qmail-queue`
 
-* qmail-queue.ini
+- qmail-queue.ini
 
-    * enable_outbound=true
+  - enable_outbound=true
 
-      Deliver outbound email to qmail. Set to false to use Haraka's
-      separate Outbound mail routing (MX based delivery)).
+    Deliver outbound email to qmail. Set to false to use Haraka's
+    separate Outbound mail routing (MX based delivery)).

package/docs/plugins/queue/quarantine.md

@@ -1,5 +1,4 @@
-quarantine
-==========
+# quarantine
 
 This plugin will save a message (in message/rfc822 format) to a specified
 directory, which will be created automatically if it does not already exist,
@@ -10,7 +9,7 @@ It is designed to be used by other plugins which request the message be
 quarantined by setting a connection or transaction note that this plugin
 checks.
 
-NOTE: this plugin simply saves a copy of the message.  It does not reject or
+NOTE: this plugin simply saves a copy of the message. It does not reject or
 discard the message and relies on another plugin to perform this function.
 
 It uses the 'queue' hook, so that it runs after all the 'data_post' plugins
@@ -27,37 +26,33 @@ The temporary directory is 'quarantine_path/tmp' which defaults to:
 Upon start-up, any files present in the temporary directory are deleted
 syncronously prior to any messages being accepted.
 
-
-Configuration
--------------
+## Configuration
 
 This plugin looks for 'quarantine.ini' in the config directory.
 
-* quarantine\_path                   (default: /var/spool/haraka/quarantine)
+- quarantine_path (default: /var/spool/haraka/quarantine)
 
-  The default base path to save the quarantine files to.  It will be created
+  The default base path to save the quarantine files to. It will be created
   if it does not already exist.
 
-
-Usage
------
+## Usage
 
 If you wish to keep a copy of the message in your plugin, simply either:
 
 ```javascript
-connection.notes.quarantine = [ 1 | true | 'sub/directory/path' ];
+connection.notes.quarantine = [1 | true | 'sub/directory/path']
 ```
 
 or
 
 ```javascript
-connection.transaction.notes.quarantine = [ 1 | true | 'sub/directory/path' ];
+connection.transaction.notes.quarantine = [1 | true | 'sub/directory/path']
 ```
 
 e.g.
 
 ```javascript
-connection.notes.quarantine = 1;
+connection.notes.quarantine = 1
 ```
 
 would save the message to '/var/spool/quarantine/haraka/YYYYMMDD/UUID' where
@@ -66,27 +61,27 @@ YYYMMDD and UUID are expanded to current date and transaction UUID.
 and
 
 ```javascript
-connection.notes.quarantine = 'corpus';
+connection.notes.quarantine = 'corpus'
 ```
 
 would save the message to '/var/spool/quarantine/haraka/corpus/YYYYMMDD/UUID'.
 
 Note: you can specify 'corpus/foo' or 'corpus/foo/bar' and the directories will
-be automatically created.  Do not add any leading or trailing slashes.
+be automatically created. Do not add any leading or trailing slashes.
 
 By default - after the message is quarantined, the plugin will tell Haraka to
-continue to the next plugin.  You can specify a different action like DENY or
+continue to the next plugin. You can specify a different action like DENY or
 OK and supply an optional message using the following notes:
 
 ```javascript
-connection.notes.quarantine_action = [ OK, 'Message quarantined' ];
-connection.transaction.notes.quarantine_action = [ DENY, 'Message rejected' ];
+connection.notes.quarantine_action = [OK, 'Message quarantined']
+connection.transaction.notes.quarantine_action = [DENY, 'Message rejected']
 ```
 
 If you don't want to supply a specific message back to the client you can
 also just specify a return code:
 
 ```javascript
-connection.notes.quarantine_action = OK;
-connection.transaction.notes.quarantine_action = DENY;
+connection.notes.quarantine_action = OK
+connection.transaction.notes.quarantine_action = DENY
 ```

package/docs/plugins/queue/rabbitmq.md

@@ -1,17 +1,14 @@
-queue/rabbitmq
-========
+# queue/rabbitmq
 
 This plugin delivers mails to rabbitmq queue for further processing.
 
-Configuration
--------------
+## Configuration
 
-* `config/rabbitmq.ini`
-    This config file provides server address and port of rabbitmq server to deliver with other configs of queues and exchange.
-    
-    Example:
+- `config/rabbitmq.ini`
+  This config file provides server address and port of rabbitmq server to deliver with other configs of queues and exchange.
+
+  Example:
 
-    
         [rabbitmq]
         ; This is name of exchange.
         exchangeName  = emailMessages
@@ -33,5 +30,5 @@ Configuration
         autoDelete = false
         ; type of the exchange
         exchangeType = direct
-    
- More information about rabbitmq can be found at https://www.rabbitmq.com/
+
+More information about rabbitmq can be found at https://www.rabbitmq.com/

package/docs/plugins/queue/rabbitmq_amqplib.md

@@ -1,47 +1,51 @@
-queue/rabbitmq_amqplib
-======================
+# queue/rabbitmq_amqplib
 
 This plugin delivers emails to RabbitMQ queue for further processing. Based on `queue/rabbitmq` but using `amqplib`.
 
-Dependency
-----------
-* `amqplib` - https://github.com/squaremo/amqp.node
+## Dependency
 
-Configuration
--------------
+- `amqplib` - https://github.com/squaremo/amqp.node
 
-* `config/rabbitmq.ini` - Connection, exchange and queue settings
-    
-    Example:
+## Configuration
+
+- `config/rabbitmq.ini` - Connection, exchange and queue settings
+
+  Example:
 
-    
         [rabbitmq]
         ; Connection
-		; Protocol. Either "amqp" or "amqps"
-		protocol = amqp
-		host = localhost
-		port = 5672
-		;Virtual Host. Start with "/". Leave blank or not use if you don't want to use virtual hosts.
-		vhost = /haraka
-		;Credentials
-		user = guest
-		password = guest
-		; Exchange
-		exchangeName  = email_messages
-		exchangeType = direct
-		; Queue
-		queueName = emails
-		deliveryMode = 2
-		confirm = true
-		durable = true
-		autoDelete = false
-
-        ; Optional queue arguments
-		; More information about x-arguments can be found at https://www.rabbitmq.com/queues.html#optional-arguments
-        [queue_args]
-        x-dead-letter-exchange =
-        x-dead-letter-routing-key = emails_dlq
-        x-overflow = reject-publish
-        x-queue-type = quorum
-    
- More information about RabbitMQ can be found at https://www.rabbitmq.com/
+      ; Protocol. Either "amqp" or "amqps"
+      protocol = amqp
+      host = localhost
+      port = 5672
+      ;Virtual Host. Start with "/". Leave blank or not use if you don't want to use virtual hosts.
+      vhost = /haraka
+      ;Credentials
+      user = guest
+      password = guest
+      ; Exchange
+      exchangeName  = email_messages
+      exchangeType = direct
+      ; Queue
+      queueName = emails
+      confirm = true
+      durable = true
+      autoDelete = false
+      ; Message
+      deliveryMode = 2
+      priority = 1
+
+      ; Optional exchange arguments
+      ; More information about exchange x-arguments can be found at https://www.rabbitmq.com/docs/exchanges#optional-arguments
+      [exchange_args]
+      alternate-exchange =
+
+      ; Optional queue arguments
+      ; More information about queue x-arguments can be found at https://www.rabbitmq.com/queues.html#optional-arguments
+      [queue_args]
+      x-dead-letter-exchange =
+      x-dead-letter-routing-key = emails_dlq
+      x-overflow = reject-publish
+      x-queue-type = quorum
+
+More information about RabbitMQ can be found at https://www.rabbitmq.com/

package/docs/plugins/queue/smtp_bridge.md

@@ -1,5 +1,4 @@
-queue/smtp\_bridge
-===============
+# queue/smtp_bridge
 
 This plugin delivers to another SMTP server, bridging the authentication
 details and post data from the initial connection.
@@ -11,8 +10,7 @@ it doesn't use the AUTH details from a configuration file. This plugins
 simply post the data from the original connection to the remote SMTP server
 using the original AUTH details.
 
-Configuration
--------------
+## Configuration
 
 Configuration is stored in `config/smtp_bridge.ini` and uses the INI
 style formatting.
@@ -24,12 +22,11 @@ The configuration of this plugin is simple:
     #auth_type=
     #priority=10
 
-* host: the host where you will be authenticating and posting,
-for example `smtp.host.tld`. This is the only setting required.
+- host: the host where you will be authenticating and posting,
+  for example `smtp.host.tld`. This is the only setting required.
 
 If needed you can also set
 
-* port: default to empty and Haraka will use 25.
-* auth_type: default to empty and Haraka will try to pick an appropriate method.
-* priority: default to 10.
-
+- port: default to empty and Haraka will use 25.
+- auth_type: default to empty and Haraka will try to pick an appropriate method.
+- priority: default to 10.

package/docs/plugins/queue/smtp_forward.md

@@ -1,4 +1,5 @@
-# queue/smtp\_forward
+# queue/smtp_forward
+
 ==================
 
 This plugin delivers to another mail server. This is a common setup when you want to have a mail server with a solid pedigree of outbound delivery to other hosts, and inbound delivery to users.
@@ -6,66 +7,67 @@ This plugin delivers to another mail server. This is a common setup when you wan
 In comparison to `queue/smtp_proxy`, this plugin waits until queue time to attempt the ongoing connection. This can be a benefit in reducing connections to your inbound mail server when you have content filtering (such as spamassassin) enabled. A possible downside is that it also delays recipient validation that the ongoing mail server may provide until queue time.
 
 ## Configuration
--------------
 
-Configuration is stored in smtp\_forward.ini in the following keys:
+---
+
+Configuration is stored in smtp_forward.ini in the following keys:
 
-  * enable\_outbound=[true]
+- enable_outbound=[true]
 
-    SMTP forward outbound messages (set to false to enable Haraka's separate Outbound mail routing (MX based delivery)).
+  SMTP forward outbound messages (set to false to enable Haraka's separate Outbound mail routing (MX based delivery)).
 
-  * host=HOST
+- host=HOST
 
-    The host to connect to.
+  The host to connect to.
 
-  * port=PORT
+- port=PORT
 
-    The port to connect to. Default: 25
+  The port to connect to. Default: 25
 
-  * connect\_timeout=SECONDS
+- connect_timeout=SECONDS
 
-    The maximum amount of time to wait when creating a new connection to the host.  Default: 30 seconds.
+  The maximum amount of time to wait when creating a new connection to the host. Default: 30 seconds.
 
-  * timeout=SECONDS
+- timeout=SECONDS
 
-    The amount of seconds to let a backend connection live idle in the connection pool.  This should always be less than the global plugin timeout, which should in turn be less than the connection timeout.
+  The amount of seconds to let a backend connection live idle in the connection pool. This should always be less than the global plugin timeout, which should in turn be less than the connection timeout.
 
-  * max\_connections=NUMBER
+- max_connections=NUMBER
 
-    Maximum number of connections at any given time. Default: 1000
+  Maximum number of connections at any given time. Default: 1000
 
-  * enable\_tls=[true]
+- enable_tls=[true]
 
-    Enable TLS with the forward host (if supported). TLS uses options from the tls plugin. If key and cert are provided in the the outbound section of the tls plugin, that certificate will be used as a TLS Client Certificate.
+  Enable TLS with the forward host (if supported). TLS uses options from the tls plugin. If key and cert are provided in the the outbound section of the tls plugin, that certificate will be used as a TLS Client Certificate.
 
-    This option controls the use of TLS via `STARTTLS`. This plugin does not work with SMTP over TLS.
+  This option controls the use of TLS via `STARTTLS`. This plugin does not work with SMTP over TLS.
 
-  * auth\_type=[plain\|login]
+- auth_type=[plain\|login]
 
-    Enable PLAIN or LOGIN SMTP AUTH.  This is required to enable AUTH.
+  Enable PLAIN or LOGIN SMTP AUTH. This is required to enable AUTH.
 
-  * auth\_user=USERNAME
+- auth_user=USERNAME
 
-    SMTP AUTH username to use.
+  SMTP AUTH username to use.
 
-  * auth\_pass=PASSWORD
+- auth_pass=PASSWORD
 
-    SMTP AUTH password to use.
+  SMTP AUTH password to use.
 
-  * queue
+- queue
 
-    Which queue plugin to use. Default: undefined. The default bahavior is to use smtp_forward for inbound connections and outbound for relaying connections. This option is used for complex mail routes.
+  Which queue plugin to use. Default: undefined. The default bahavior is to use smtp_forward for inbound connections and outbound for relaying connections. This option is used for complex mail routes.
 
-  * check_sender=false
+- check_sender=false
 
-    Requires that sender domains defined in smtp_forward.ini (see Per-Domain below) have relaying privileges. This is a form of spoof prevention and assumes that any mail clients have relaying or AUTH privileges. This is usually the case.
+  Requires that sender domains defined in smtp_forward.ini (see Per-Domain below) have relaying privileges. This is a form of spoof prevention and assumes that any mail clients have relaying or AUTH privileges. This is usually the case.
 
-  * check_recipient=false
+- check_recipient=false
 
-    By default, Haraka accepts no emails until a recipient plugin has been configured to accept mails for a domain. The simplest common case is the in_host_list plugin with a list of domains in config/host_list. An alternative is to set `check_recipient=true` and list each domain in a definition block in smtp_forward.ini (see Per-Domain Configuration). An example for two domains:
+  By default, Haraka accepts no emails until a recipient plugin has been configured to accept mails for a domain. The simplest common case is the in_host_list plugin with a list of domains in config/host_list. An alternative is to set `check_recipient=true` and list each domain in a definition block in smtp_forward.ini (see Per-Domain Configuration). An example for two domains:
 
-    [example.com]
-    [example.net]
+  [example.com]
+  [example.net]
 
 # Per-Domain Configuration
 
@@ -73,9 +75,9 @@ More specific forward routes for domains can be defined. The domain is chosen ba
 
 When `domain_selector` is set to `rcpt_to` (the default), more specific routes are only honored for SMTP connections with a single recipient or SMTP connections where every recipient host is identical.
 
-When `domain_selector` is set to `mail_from`, the domain of the MAIL FROM address is used.
+When `domain_selector` is set to `mail_from`, it first searches for configuration using the complete email address, falls back to the domain if not found, then to main configuration.
 
-enable\_outbound can be set or unset on a per-domain level to enable or disable forwarding for specific domains.
+enable_outbound can be set or unset on a per-domain level to enable or disable forwarding for specific domains.
 
     # default SMTP host
     host=1.2.3.4
@@ -89,6 +91,12 @@ enable\_outbound can be set or unset on a per-domain level to enable or disable
     # auth_user=user
     # auth_pass=pass
 
+    [email@example1.com]
+    host=1.2.3.5
+    # auth_type=plain
+    # auth_user=user
+    # auth_pass=pass
+
     [example2.com]
     host=1.2.3.5
 

package/docs/plugins/queue/smtp_proxy.md

@@ -1,4 +1,5 @@
-# queue/smtp\_proxy
+# queue/smtp_proxy
+
 ================
 
 This plugin delivers to another mail server. This is a common setup when you want to have a mail server with a solid pedigree of outbound delivery to other hosts, and inbound delivery to users.
@@ -8,52 +9,52 @@ In comparison to `queue/smtp_forward`, this plugin makes a connection at MAIL FR
 Be aware that other than connect and HELO-time filtering, you will have as many connections to your ongoing SMTP server as you have to Haraka.
 
 ## Configuration
--------------
 
-Configuration is stored in smtp\_proxy.ini in the following keys:
+---
+
+Configuration is stored in smtp_proxy.ini in the following keys:
 
-  * enable\_outbound=[true]
+- enable_outbound=[true]
 
-    SMTP proxy outbound messages (set to false to enable Haraka's
-    separate Outbound mail routing (MX based delivery)).
+  SMTP proxy outbound messages (set to false to enable Haraka's
+  separate Outbound mail routing (MX based delivery)).
 
-  * host=HOST
-    
-    The host to connect to.
+- host=HOST
 
-  * port=PORT
+  The host to connect to.
 
-    The port to connect to.
+- port=PORT
 
-  * connect\_timeout=SECONDS
+  The port to connect to.
 
-    The maximum amount of time to wait when creating a new connection
-    to the host.  Default if unspecified is 30 seconds.
+- connect_timeout=SECONDS
 
-  * timeout=SECONDS
+  The maximum amount of time to wait when creating a new connection
+  to the host. Default if unspecified is 30 seconds.
 
-    The amount of seconds to let a backend connection live idle in the
-    proxy pool.  This should always be less than the global plugin timeout,
-    which should in turn be less than the connection timeout.
+- timeout=SECONDS
 
-  * max\_connections=NUMBER
+  The amount of seconds to let a backend connection live idle in the
+  proxy pool. This should always be less than the global plugin timeout,
+  which should in turn be less than the connection timeout.
 
-    Maximum number of connections to create at any given time.
+- max_connections=NUMBER
 
-  * enable\_tls=[true|yes|1]
+  Maximum number of connections to create at any given time.
 
-    Enable TLS with the forward host (if supported). TLS uses options from
-    the tls plugin.
+- enable_tls=[true|yes|1]
 
-  * auth\_type=[plain|login]
+  Enable TLS with the forward host (if supported). TLS uses options from
+  the tls plugin.
 
-    Enable PLAIN or LOGIN SMTP AUTH.  This is required to enable AUTH.
+- auth_type=[plain|login]
 
-  * auth\_user=USERNAME
+  Enable PLAIN or LOGIN SMTP AUTH. This is required to enable AUTH.
 
-    SMTP AUTH username to use.
+- auth_user=USERNAME
 
-  * auth\_pass=PASSWORD
+  SMTP AUTH username to use.
 
-    SMTP AUTH password to use.
+- auth_pass=PASSWORD
 
+  SMTP AUTH password to use.

package/docs/plugins/queue/test.md

@@ -1,9 +1,7 @@
-queue/test
-==========
+# queue/test
 
 This plugin saves incoming E-Mail to your temporary directory, as `mail_{message_id}.eml`, where message_id is a UUID.
 
 This plugin can be useful to quickly test if you're able to receive incoming E-Mail and just dump them to disk.
 
 The temporary directory is determined using Node's [`os.tmpdir()`](https://nodejs.org/api/os.html#ostmpdir), which respects standard platform configurations.
-

package/docs/plugins/rcpt_to.in_host_list.md

@@ -1,4 +1,4 @@
-# rcpt\_to.in\_host\_list
+# rcpt_to.in_host_list
 
 This plugin is the mainstay of an inbound Haraka server. It should list the
 domains that are local to the host. Mails that have RCPT TO not matching
@@ -7,20 +7,20 @@ hook accepts the connection, it will be rejected.
 
 ## Configuration
 
-* host\_list
+- host_list
 
   Specifies the list of hosts that are local to this server.
 
-* host\_list\_regex
+- host_list_regex
 
-  Specifies the list of regexes that are local to this server.  Note
+  Specifies the list of regexes that are local to this server. Note
   all these regexes are anchored with ^regex$. One can choose not to
   anchor with .\*. There is the potential for bad regexes to be
   too permissive if we don't anchor.
 
-* host\_list.anti\_spoof
+- host_list.anti_spoof
 
-  When enabled, this will cause Haraka to reject any MAIL FROM where 
+  When enabled, this will cause Haraka to reject any MAIL FROM where
   the host appears within the host list but the connected host is not
   a relay, e.g. connection.relaying is not set either by SMTP AUTH or
   another plugin like 'relay'.

package/docs/plugins/rcpt_to.max_count.md

@@ -1,3 +1,3 @@
-# rcpt\_to.max\_count
+# rcpt_to.max_count
 
 The functionality of this plugin was integrated in to [haraka-plugin-limit](https://github.com/haraka/haraka-plugin-limit).

package/docs/plugins/record_envelope_addresses.md

@@ -1,9 +1,9 @@
-# record\_envelope\_addresses
+# record_envelope_addresses
 
 This plugin adds two new header lines.
 
-* X-Envelope-To: the envelope RCPT TO address
-* X-Envelope-From: the envelope MAIL FROM address
+- X-Envelope-To: the envelope RCPT TO address
+- X-Envelope-From: the envelope MAIL FROM address
 
 It is useful if you need to know the exact addresses used to send an email, e.g. when
 the email was sent to you as BCC or if it is a newsletter. In both cases the recipient

package/docs/plugins/reseed_rng.md

@@ -1,18 +1,18 @@
-# reseed\_rng
+# reseed_rng
 
 The V8 that ships with node 0.4.x uses an unsophisticated method of
 seeding its random number generator- it simply uses the current time
-in ms.  Worse, that version of V8 (at least) doesn't provide a way
+in ms. Worse, that version of V8 (at least) doesn't provide a way
 to explicitly reseed the RNG.
 
 In situations where multiple processes can spawn in the same
-ms, processes can be seeded with the same value, leading to bad 
+ms, processes can be seeded with the same value, leading to bad
 problems like UUID collisions. When using the 'cluster' module, it's
-quite easy to observe this behavior. 
+quite easy to observe this behavior.
 
 This plugin uses David Bao's reseed.js (see http://davidbau.com/archives/2010/01/30/random_seeds_coded_hints_and_quintillions.html)
-to provide a reseedable Math.random(), and hooks the init\_child event
+to provide a reseedable Math.random(), and hooks the init_child event
 to reseed the RNG with a sligtly better seed at spawned-process startup
-time. 
+time.
 
 All users of the 'cluster' module should consider using this plugin.

package/docs/plugins/status.md

@@ -1,13 +1,14 @@
 # Status
 
-This plugin allows to get internal status of queues and pools with SMTP commands sent from localhost.  
+This plugin allows to get internal status of queues and pools with SMTP commands sent from localhost.
 
 ## Communication
 
 - **Request** &rarr; `STATUS <CMD> [param1] [param2]....`
-- **Response** &larr; *&lt;SMTP code 211 or 500>&lt;space>&lt;json encoded response>\r\n*
+- **Response** &larr; _&lt;SMTP code 211 or 500>&lt;space>&lt;json encoded response>\r\n_
 
 ### Example
+
 ```
 < 220 example.com ESMTP Haraka ready
 > STATUS QUEUE LIST
@@ -16,9 +17,9 @@ This plugin allows to get internal status of queues and pools with SMTP commands
 
 ## Available commands list
 
-* `STATUS POOL LIST` - list of active pools
-* `STATUS QUEUE STATS` - queue statistics in format "<in_progress>/<delivery_queue length>/<temp_fail_queue length>" 
-* `STATUS QUEUE LIST` - list of parsed queue files with *uuid, domain, mail_from, rcpt_to* attributes
-* `STATUS QUEUE INSPECT` - returns content of *outbound.delivery_queue* and *outbound.temp_fail_queue*
-* `STATUS QUEUE DISCARD file` - stop delivering email file
-* `STATUS QUEUE PUSH file` - try to re-deliver email immediately 
+- `STATUS POOL LIST` - list of active pools
+- `STATUS QUEUE STATS` - queue statistics in format "<in_progress>/<delivery_queue length>/<temp_fail_queue length>"
+- `STATUS QUEUE LIST` - list of parsed queue files with _uuid, domain, mail_from, rcpt_to_ attributes
+- `STATUS QUEUE INSPECT` - returns content of _outbound.delivery_queue_ and _outbound.temp_fail_queue_
+- `STATUS QUEUE DISCARD file` - stop delivering email file
+- `STATUS QUEUE PUSH file` - try to re-deliver email immediately