summaryrefslogtreecommitdiff
path: root/man/srsforward.1
diff options
context:
space:
mode:
Diffstat (limited to 'man/srsforward.1')
-rw-r--r--man/srsforward.196
1 files changed, 96 insertions, 0 deletions
diff --git a/man/srsforward.1 b/man/srsforward.1
new file mode 100644
index 0000000..930c3df
--- /dev/null
+++ b/man/srsforward.1
@@ -0,0 +1,96 @@
+.TH s/qmail: srsforward 1
+.SH NAME
+srsforward \- forward mail to one or more addresses including a SRS extension
+.SH SYNOPSIS
+in
+.BR .qmail :
+.B |srsforward
+.I address ...
+.SH DESCRIPTION
+.B srsforward
+forwards mails for dedicated recipient
+.I srsdomains
+to the specified list of addresses
+while extending the SMTP 'RCPT TO:' envelope address with
+SRS (Sender Rewriting Scheme) information.
+It is a simple wrapper around
+.B qmail-queue
+rewriting the SMTP recipient address. The forwarded email
+ought to be acceptable for SPF enabled recipient MTAs.
+Additionally, it mitigates the forgery of addresses for bounces.
+.SH "CONTROL FILE"
+.B srsforward
+reads the control file
+.IR srsdomains .
+Here, you can specify
+
+.I srsdomain:SRS_secret1 SRS_secret2 ...|[+,-,=]|[srsaddress(.)]
+
+.I srsdomain
+is
+.B s/qmail's
+recipient domain; typically
+.I defaultdomain
+or any domain given in
+.IR rcpthosts .
+.I srsdomain
+can be simply expressed as '*', thus the
+following informations are
+applicable for all
+.B srsfoward
+domains as default values, while
+particular
+.I srsdomain
+settings have precedence.
+Reversely, recipient
+domains can be disable for SRS fowarding:
+.IR !nosrsfoward.example.com: .
+
+.B srsforward
+accepts several 'secrets' for each
+.I srsdomain
+separated by empty spaces.
+
+.BR srsfoward 's
+.I delimiter
+is a character chosen out of the set
+.I +,-,=
+with default
+.I =
+and thus is optional.
+
+.B srsforward
+may include
+.I srsaddress
+to construct the domain part of the RCPT TO:
+envelope address for SRS fowarded mails. If
+.I srsaddress
+ends with a dot '.',
+this name is used to prepend the original
+host name and typically is chosen as
+.IR srs. .
+Otherwise, the original host name is
+used as default
+.I srsaddress
+for forwarding and also relevant for
+potential bounces being subject of
+.BR srsreverse .
+.SH "ENVIRONMENT VARIABLES"
+.B srsforward
+reads the environment variables
+.IR HOST ,
+which is used to determine the
+.IR srsdomain ,
+.IR DTLINE ,
+and
+.IR NEWSENDER .
+.SH REFERENCE
+.B srsforward
+uses srs2.c from
+.IR libsrs2 .
+.SH "SEE ALSO"
+srsreverse(1),
+dot-qmail(5),
+qmail-command(8),
+qmail-queue(8),
+qmail-send(8).