Permalink
Browse files

Fix all underscores (to be escaped).

  • Loading branch information...
1 parent d2c7362 commit d765edfe7598e012d29888a7f2545063e05e4163 Matt Sergeant committed Jan 21, 2014
Showing with 238 additions and 239 deletions.
  1. +1 −1 README.md
  2. +1 −1 docs/Config.md
  3. +8 −8 docs/Connection.md
  4. +16 −16 docs/CoreConfig.md
  5. +2 −2 docs/Header.md
  6. +1 −1 docs/Net_Utils.md
  7. +6 −6 docs/Outbound.md
  8. +16 −16 docs/Plugins.md
  9. +13 −13 docs/Transaction.md
  10. +1 −1 docs/plugins/aliases.md
  11. +1 −1 docs/plugins/auth/auth_ldap.md
  12. +1 −1 docs/plugins/auth/auth_proxy.md
  13. +1 −1 docs/plugins/auth/auth_vpopmaild.js
  14. +1 −1 docs/plugins/auth/flat_file.md
  15. +2 −2 docs/plugins/avg.md
  16. +1 −1 docs/plugins/block_me.md
  17. +5 −5 docs/plugins/clamd.md
  18. +11 −11 docs/plugins/connect.rdns_access.md
  19. +3 −3 docs/plugins/daemonize.md
  20. +1 −1 docs/plugins/data.rfc5322_header_checks.md
  21. +4 −4 docs/plugins/data.uribl.md
  22. +5 −5 docs/plugins/dkim_sign.md
  23. +4 −4 docs/plugins/dnsbl.md
  24. +5 −5 docs/plugins/dnswl.md
  25. +3 −3 docs/plugins/early_talker.md
  26. +4 −4 docs/plugins/graph.md
  27. +7 −7 docs/plugins/helo.checks.md
  28. +1 −1 docs/plugins/log.syslog.md
  29. +13 −13 docs/plugins/lookup_rdns.strict.md
  30. +11 −11 docs/plugins/mail_from.access.md
  31. +4 −4 docs/plugins/mail_from.blocklist.md
  32. +3 −3 docs/plugins/mail_from.is_resolvable.md
  33. +1 −1 docs/plugins/mail_from.nobounces.md
  34. +3 −3 docs/plugins/max_unrecognized_commands.md
  35. +6 −6 docs/plugins/messagesniffer.md
  36. +1 −1 docs/plugins/process_title.md
  37. +1 −1 docs/plugins/queue/quarantine.md
  38. +5 −5 docs/plugins/queue/smtp_forward.md
  39. +5 −5 docs/plugins/queue/smtp_proxy.md
  40. +9 −9 docs/plugins/rate_limit.md
  41. +13 −13 docs/plugins/rcpt_to.access.md
  42. +4 −4 docs/plugins/rcpt_to.blocklist.md
  43. +3 −3 docs/plugins/rcpt_to.in_host_list.md
  44. +2 −2 docs/plugins/rcpt_to.max_count.md
  45. +2 −3 docs/plugins/rcpt_to.qmail_deliverable.md
  46. +4 −4 docs/plugins/rdns.regexp.md
  47. +3 −3 docs/plugins/relay_acl.md
  48. +1 −1 docs/plugins/relay_all.md
  49. +4 −4 docs/plugins/relay_force_routing.md
  50. +2 −2 docs/plugins/reseed_rng.md
  51. +8 −8 docs/plugins/spf.md
  52. +1 −1 docs/plugins/toobusy.md
  53. +2 −2 docs/tutorials/Migrating_from_v1_to_v2.md
  54. +2 −2 docs/tutorials/SettingUpOutbound.md
View
@@ -49,7 +49,7 @@ code in Haraka, or maybe someone has already written this plugin.
Plugins are already provided for running mail through SpamAssassin, checking
for known bad HELO patterns, checking DNS Blocklists, and watching for
-violators of the SMTP protocol via the "early_talker" plugin.
+violators of the SMTP protocol via the "early\_talker" plugin.
Furthermore Haraka comes with a simple plugin called "graph" which shows you
real-time charts of which plugins rejected the most mail, allowing you to
View
@@ -112,7 +112,7 @@ var configfile = require('./configfile');
var cfg = configfile.read_config('/path/to/file', type);
```
-read_config() handles the caching for you and will return cached values
+`read_config()` handles the caching for you and will return cached values
if there have been no updates since the file was read.
You can also optionally pass in a callback that is run if the file is
View
@@ -10,19 +10,19 @@ API
A unique UUID for this connection.
-* connection.remote_ip
+* connection.remote\_ip
The remote IP address
-* connection.remote_host
+* connection.remote\_host
The rDNS of the remote IP
-* connection.local_ip
+* connection.local\_ip
The bound IP address of the server as reported by the OS
-* connection.local_port
+* connection.local\_port
The bound port number of the server which is handling the connection.
If you have specified multiple listen= ports this variable is useful
@@ -33,7 +33,7 @@ port
Either 'EHLO' or 'HELO' whichever the remote end used
-* connection.hello_host
+* connection.hello\_host
The hostname given to HELO or EHLO
@@ -53,15 +53,15 @@ A boolean flag to say whether this connection is allowed to relay mails (i.e.
deliver mails outbound). This is normally set by SMTP AUTH, or sometimes via
an IP address check.
-* connection.current_line
+* connection.current\_line
For low level use. Contains the current line sent from the remote end,
verbatim as it was sent. Can be useful in certain botnet detection techniques.
-* connection.last_response
+* connection.last\_response
Contains the last SMTP response sent to the client.
-* connection.remote_close
+* connection.remote\_close
For low level use. This value is set when the remote host drops the connection.
View
@@ -28,14 +28,14 @@ different levels available.
children as there are CPUs (default: 0, which disables cluster mode)
* user - optionally a user to drop privileges to. Can be a string or UID.
* group - optionally a group to drop privileges to. Can be a string or GID.
- * ignore_bad_plugins - If a plugin fails to compile by default Haraka will stop at load time.
+ * ignore\_bad\_plugins - If a plugin fails to compile by default Haraka will stop at load time.
If, however, you wish to continue on without that plugin's facilities, then
set this config option
* daemonize - enable this to cause Haraka to fork into the background on start-up (default: 0)
- * daemon_log_file - (default: /var/log/haraka.log) where to redirect stdout/stderr when daemonized
- * daemon_pid_file - (default: /var/run/haraka.pid) where to write a PID file to
- * spool_dir - (default: none) directory to create temporary spool files in
- * spool_after - (default: -1) if message exceeds this size in bytes, then spool the message to disk
+ * daemon\_log\_file - (default: /var/log/haraka.log) where to redirect stdout/stderr when daemonized
+ * daemon\_pid\_file - (default: /var/run/haraka.pid) where to write a PID file to
+ * spool\_dir - (default: none) directory to create temporary spool files in
+ * spool\_after - (default: -1) if message exceeds this size in bytes, then spool the message to disk
specify -1 to disable spooling completely or 0 to force all messages to be spooled to disk.
[1]: http://learnboost.github.com/cluster/ or node version >= 0.8
@@ -45,7 +45,7 @@ different levels available.
A name to use for this server. Used in received lines and elsewhere. Setup
by default to be your hostname.
-* deny_includes_uuid
+* deny\_includes\_uuid
Each connection and mail in Haraka includes a UUID which is also in most log
messages. If you put a `1` in this file then every denied mail (either via
@@ -57,7 +57,7 @@ different levels available.
file, it will be truncated to that length. We recommend a 6 as a good
balance of finding in the logs and not making lines too long.
-* banner_include_uuid
+* banner\_include\_uuid
This will add the full UUID to the first line of the SMTP greeting banner.
@@ -94,19 +94,19 @@ different levels available.
if required (this may cause some connecting machines to fail - though
usually only spam-bots).
-* max_received_count
+* max\_received\_count
The maximum number of "Received" headers allowed in an email. This is a
simple protection against mail loops. Defaults to 100.
-* max_line_length
+* max\_line\_length
The maximum length of lines in SMTP session commands (e.g. RCPT, HELO etc).
Defaults to 512 (bytes) which is mandated by RFC 5321 §4.5.3.1.4. Clients
exceeding this limit will be immediately disconnected with a "521 Command
line too long" error.
-* max_data_line_length
+* max\_data\_line\_length
The maximum length of lines in the DATA section of emails. Defaults to 992
(bytes) which is the limit set by Sendmail. When this limit is exceeded the
@@ -116,7 +116,7 @@ different levels available.
as Sendmail. Also when the data line length limit is exceeded
`transaction.notes.data_line_length_exceeded` is set to `true`.
-* outbound.concurrency_max
+* outbound.concurrency\_max
Maximum concurrency to use when delivering mails outbound. Defaults to 100.
@@ -125,23 +125,23 @@ different levels available.
Put a `1` in this file to temporarily disable outbound delivery. Useful to
do while you're figuring out network issues, or just testing things.
-* outbound.bounce_message
+* outbound.bounce\_message
The bounce message should delivery of the mail fail. See the source of. The
default is normally fine. Bounce messages contain a number of template
replacement values which are best discovered by looking at the source code.
-* haproxy_hosts
+* haproxy\_hosts
A list of HAProxy hosts that Haraka should enable the PROXY protocol from.
See HAProxy.md
-* strict_rfc1869
+* strict\_rfc1869
When enabled, this setting requires senders to conform to RFC 1869 and
RFC 821 when sending the MAIL FROM and RCPT TO commands. In particular,
the inclusion of spurious spaces or missing angle brackets will be rejected.
- to enable: echo '1' > /path/to/haraka/config/strict_rfc1869
- to disable: echo '0' > /path/to/haraka/config/strict_rfc1869
+ to enable: `echo 1 > /path/to/haraka/config/strict_rfc1869`
+ to disable: `echo 0 > /path/to/haraka/config/strict_rfc1869`
View
@@ -14,12 +14,12 @@ Returns the header with the name `key`. If there are multiple headers with
the given name (as is usually the case with "Received" for example) they will
be concatenated together with "\n".
-* header.get_all(key)
+* header.get\_all(key)
Returns the headers with the name `key` as an array. Multi-valued headers
will have multiple entries in the array.
-* header.get_decoded(key)
+* header.get\_decoded(key)
Works like `get(key)`, only it gives you headers decoded from any MIME encoding
they may have used.
View
@@ -1,4 +1,4 @@
-Net_Utils
+Net\_Utils
=========
This module provides network utility functions.
View
@@ -20,13 +20,13 @@ process with the SIGHUP signal (via the `kill` command line tool).
Outbound Configuration Files
----------------------------
-### outbound.concurrency_max
+### outbound.concurrency\_max
Default: 100. Specifies the maximum concurrent connections to make. Note that
if using cluster (multiple CPUs) then this will be multiplied by the number
of CPUs that you have.
-### outbound.enable_tls
+### outbound.enable\_tls
Default: 0. Put a "1" in this file to enable TLS for outbound mail when the
remote end is capable of receiving TLS connections.
@@ -35,7 +35,7 @@ This uses the same `tls_key.pem` and `tls_cert.pem` files that the `tls`
plugin uses. See the plugin documentation for information on generating those
files.
-### outbound.bounce_message
+### outbound.bounce\_message
See "Bounce Messages" below for details.
@@ -48,7 +48,7 @@ how Haraka watches for config file changes.
Outbound Mail Hooks
-------------------
-### The queue_outbound hook
+### The queue\_outbound hook
The first hook that is called prior to queueing an outbound mail is the
`queue_outbound` hook. Only if all these hooks return `CONT` (or if there are
@@ -57,7 +57,7 @@ indicate that the mail has been queued in some custom manner for outbound
delivery. Any of the `DENY` return codes will cause the message to be
appropriately rejected.
-### The get_mx hook
+### The get\_mx hook
Upon starting delivery the `get_mx` hook is called, with the parameter set to
the domain in question (for example a mail to `user@example.com` will call the
@@ -86,7 +86,7 @@ parameter is the error message received from the remote end. If you do not wish
to have a bounce message sent to the originating sender of the email then you
can return `OK` from this hook to stop it from sending a bounce message.
-The variable hmail.bounce_extra can be accessed from this hook. This is an
+The variable `hmail.bounce_extra` can be accessed from this hook. This is an
Object which contains each recipient as the key and the value is the code
and response received from the upstream server for that recipient.
View
@@ -123,10 +123,10 @@ on the deny hook will override the result to CONT.
Once a plugin calls next(OK) no further plugins on the same hook will
run after it.
-* HOOK_NEXT
+* HOOK\_NEXT
This is a special return value that is currently only available on the
-unrecognized_command hook. It instructs Haraka to run a different plugin
+`unrecognized_command` hook. It instructs Haraka to run a different plugin
hook instead of responding normally. The `msg` argument is required and
must be set to the name of the hook that is to be run.
@@ -136,12 +136,12 @@ Available Hooks
These are just the name of the hook, with any parameter sent to it:
-* init_master - called when the main (master) process is started
-* init_child - called whenever a child process is started when using multiple "nodes"
-* lookup_rdns - called to look up the rDNS - return the rDNS via `next(OK, rdns)`
+* init\_master - called when the main (master) process is started
+* init\_child - called whenever a child process is started when using multiple "nodes"
+* lookup\_rdns - called to look up the rDNS - return the rDNS via `next(OK, rdns)`
* connect - called after we got rDNS
* capabilities - called to get the ESMTP capabilities (such as STARTTLS)
-* unrecognized_command - called when the remote end sends a command we don't recognise
+* unrecognized\_command - called when the remote end sends a command we don't recognise
* disconnect - called upon disconnect
* helo (hostname)
* ehlo (hostname)
@@ -151,20 +151,20 @@ These are just the name of the hook, with any parameter sent to it:
* rset
* mail ([from, esmtp\_params])
* rcpt ([to, esmtp\_params])
-* rcpt_ok (to)
+* rcpt\_ok (to)
* data - called at the DATA command
-* data_post - called at the end-of-data marker
-* max_data_exceeded - called if the message is bigger than connection.max_bytes
+* data\_post - called at the end-of-data marker
+* max\_data\_exceeded - called if the message is bigger than connection.max\_bytes
* queue - called to queue the mail
-* queue_outbound - called to queue the mail when connection.relaying is set
-* queue_ok - called when a mail has been queued successfully
-* reset_transaction - called before the transaction is reset (via RSET, or MAIL)
+* queue\_outbound - called to queue the mail when connection.relaying is set
+* queue\_ok - called when a mail has been queued successfully
+* reset\_transaction - called before the transaction is reset (via RSET, or MAIL)
* deny - called if a plugin returns one of DENY, DENYSOFT or DENYDISCONNECT
-* get_mx (hmail, domain) - called when sending outbound mail to lookup the MX record
+* get\_mx (hmail, domain) - called when sending outbound mail to lookup the MX record
* bounce (hmail, err) - called when sending outbound mail if the mail would bounce
* delivered (hmail, [host, ip, response, delay]) - callen when outbound mail is
delivered to the destination
-* send_email (hmail) - called when outbound is about to be sent
+* send\_email (hmail) - called when outbound is about to be sent
The `rcpt` hook is slightly special. If we have a plugin (prior to rcpt) that
sets the `connection.relaying = true` flag, then we do not need any rcpt
@@ -176,7 +176,7 @@ obvious choice for this activity is the `rcpt_to.in_host_list` plugin, which
lists the domains for which you wish to receive email.
If a rcpt plugin DOES call `next(OK)` then the `rcpt_ok` hook is run. This
-is primarily used by the queue/smtp_proxy plugin which needs to run after
+is primarily used by the `queue/smtp_proxy` plugin which needs to run after
all rcpt hooks.
Sharing State
@@ -204,7 +204,7 @@ plugins. This is done using `notes` - there are three types available:
* connection.transaction.notes
Available on any hook that passes 'connection' as a function parameter
- between hook_mail and hook_data_post.
+ between hook\_mail and hook\_data\_post.
This is shared amongst all plugins for this transaction (e.g. MAIL FROM
through until a message is received or the connection is reset).
Typical uses for notes at this level would be to store information
View
@@ -19,7 +19,7 @@ The value of the MAIL FROM command as an `Address` object.
An Array of `Address` objects of recipients from the RCPT TO command.
-* transaction.message_stream
+* transaction.message\_stream
A node.js Readable Stream object for the message.
@@ -48,7 +48,7 @@ e.g.
The number of bytes in the email after DATA.
-* transaction.add_data(line)
+* transaction.add\_data(line)
Adds a line of data to the email. Note this is RAW email - it isn't useful
for adding banners to the email.
@@ -57,33 +57,33 @@ for adding banners to the email.
A safe place to store transaction specific values.
-* transaction.add_leading_header(key, value)
+* transaction.add\_leading\_header(key, value)
Adds a header to the top of the header list. This should only be used in
-very specific cases. Most people will want to use add_header() instead.
+very specific cases. Most people will want to use `add_header()` instead.
-* transaction.add_header(key, value)
+* transaction.add\_header(key, value)
Adds a header to the email.
-* transaction.remove_header(key)
+* transaction.remove\_header(key)
Deletes a header from the email.
* transaction.header
The header of the email. See `Header Object`.
-* transaction.parse_body = true|false [default: false]
+* transaction.parse\_body = true|false [default: false]
Set to `true` to enable parsing of the mail body. Make sure you set this in
-hook_data or before.
+hook\_data or before.
* transaction.body
The body of the email if you set `parse_body` above. See `Body Object`.
-* transaction.attachment_hooks(start)
+* transaction.attachment\_hooks(start)
Sets a callback for when we see an attachment if `parse_body` has been set.
@@ -132,15 +132,15 @@ the `tmp` library from npm and tells us the size of the file:
});
}
-* transaction.discard_data = true|false [default: false]
+* transaction.discard\_data = true|false [default: false]
Set this flag to true to discard all data as it arrives and not store in
-memory or on disk (in the message_stream property). You can still access
-the attachments and body if you set parse_body to true. This is useful
+memory or on disk (in the message\_stream property). You can still access
+the attachments and body if you set parse\_body to true. This is useful
for systems which do not need the full email, just the attachments or
mail text.
-* transaction.set_banner(text, html)
+* transaction.set\_banner(text, html)
Sets a banner to be added to the end of the email. If the html part is not
given (optional) then the text part will have each line ending replaced with
Oops, something went wrong.

0 comments on commit d765edf

Please sign in to comment.