Content-type: text/html Manpage of EMAILRELAY

EMAILRELAY

Section: User Commands (1)
Updated: local
Index Return to Main Contents
 

NAME

emailrelay - e-mail transfer agent and proxy  

SYNOPSIS

emailrelay [OPTIONS]

emailrelay --as-server

emailrelay --as-client server-address

emailrelay --as-proxy server-address  

DESCRIPTION

emailrelay is a simple SMTP proxy and store-and-forward message transfer agent. It does store-and-forward mail relay to a fixed next-hop server, without any routing.

It runs in two main modes: a storage daemon (--as-server) and a forwarding agent (--as-client). The storage daemon is an SMTP server which stores e-mail messages in a local spool directory. The forwarding agent acts as an SMTP client sending the spooled e-mail messages on to the next SMTP server in the chain.

It can also run in a third mode, as a proxy server (--as-proxy). In this mode all messages are forwarded immediately to the next-hop server. Messages are only fully accepted from the sender once they have been successfully delivered to the next-hop server.  

OPTIONS

-a,--admin admin-port
Enables the administration interface and specifies its listening port number.
-Q,--admin-terminate
Enables the terminate command on the admin interface.
-A,--anonymous
Disables the smtp vrfy command and sends less verbose smtp responses.
-q,--as-client host:port
Runs as a client, forwarding spooled mail to <host>: equivalent to --log --no-syslog --no-daemon --dont-serve --forward --forward-to.
-y,--as-proxy host:port
Runs as a proxy: equivalent to --log --close-stderr --immediate --forward-to.
-d,--as-server
Runs as a server: equivalent to --log --close-stderr --postmaster.
-C,--client-auth file
Enables smtp authentication with remote server, using the given secrets file.
-Y,--client-filter program
Specifies an external program to process messages when they are forwarded.
-e,--close-stderr
Closes the standard error stream after start-up.
-U,--connection-timeout time
Sets the timeout (in seconds) when connecting to a remote server (default is 40).
-g,--debug
Generates debug-level logging if compiled-in.
-D,--domain fqdn
Sets an override for the host's fully qualified domain name.
-x,--dont-serve
Disables acting as a server on any port (part of --as-client and usually used with --forward).
-z,--filter program
Specifies an external program to process messages as they are stored.
-f,--forward
Forwards stored mail on startup (requires --forward-to).
-o,--forward-to host:port
Specifies the remote smtp server (required by --forward, --poll, --immediate and --admin).
-h,--help
Displays help text and exits.
-m,--immediate
Enables immediating forwarding of messages as soon as they are received (requires --forward-to).
-I,--interface ip-address
Defines the listening interface for new connections.
-l,--log
Writes log information on standard error and syslog.
-L,--log-time
Adds a timestamp to the logging output.
-t,--no-daemon
Does not detach from the terminal.
-X,--no-smtp
Disables listening for smtp connections (usually used with --admin or --pop).
-n,--no-syslog
Disables syslog output.
-i,--pid-file pid-file
Defines a file for storing the daemon process-id.
-O,--poll period
Enables polling with the specified period (requires --forward-to).
-B,--pop
Enables the pop server if compiled-in.
-F,--pop-auth file
Defines the pop server secrets file (default is /etc/emailrelay.auth).
-J,--pop-by-name
Modifies the pop spool directory according to the user name (requires --pop).
-G,--pop-no-delete
Disables message deletion via pop (requires --pop).
-E,--pop-port port
Specifies the pop listening port number (requires --pop).
-p,--port port
Specifies the smtp listening port number.
-P,--postmaster
Allows delivery to the postmaster but rejects all other local mailbox addresses.
-r,--remote-clients
Allows remote clients to connect.
-T,--response-timeout time
Sets the response timeout (in seconds) when talking to a remote server (default is 1800).
-R,--scanner host:port
Specifies an external network server to process messages when they are stored.
-S,--server-auth file
Enables authentication of remote clients, using the given secrets file.
-s,--spool-dir dir
Specifies the spool directory (default is /var/spool/emailrelay).
-u,--user username
Names the effective user to switch to when started as root (default is daemon).
-v,--verbose
Generates more verbose output (works with --help and --log).
-Z,--verifier program
Specifies an external program for address verification.
-V,--version
Displays version information and exits.
 

FILES

GNU style...
/usr/local/etc/emailrelay.conf
/usr/local/etc/emailrelay.conf.template
/usr/local/libexec/emailrelay
/usr/local/libexec/emailrelay-deliver.sh
/usr/local/libexec/emailrelay-notify.sh
/usr/local/libexec/emailrelay-poke
/usr/local/libexec/emailrelay-process.sh
/usr/local/libexec/emailrelay-resubmit.js
/usr/local/libexec/emailrelay-resubmit.sh
/usr/local/libexec/emailrelay-runperl.js
/usr/local/libexec/emailrelay-submit.sh
/usr/local/man/man1/emailrelay.1.gz
/usr/local/man/man1/emailrelay-passwd.1.gz
/usr/local/man/man1/emailrelay-poke.1.gz
/usr/local/man/man1/emailrelay-submit.1.gz
/usr/local/sbin/emailrelay
/usr/local/sbin/emailrelay-passwd
/usr/local/sbin/emailrelay-submit
/usr/local/share/emailrelay/doc/changelog.gz
/usr/local/share/emailrelay/doc/changelog.html
/usr/local/share/emailrelay/doc/developer.html
/usr/local/share/emailrelay/doc/developer.txt
/usr/local/share/emailrelay/doc/emailrelay.css
/usr/local/share/emailrelay/doc/emailrelay-man.html
/usr/local/share/emailrelay/doc/index.html
/usr/local/share/emailrelay/doc/NEWS
/usr/local/share/emailrelay/doc/*.png
/usr/local/share/emailrelay/doc/README
/usr/local/share/emailrelay/doc/readme.html
/usr/local/share/emailrelay/doc/reference.html
/usr/local/share/emailrelay/doc/reference.txt
/usr/local/share/emailrelay/doc/userguide.html
/usr/local/share/emailrelay/doc/userguide.txt
/usr/local/share/emailrelay/doc/windows.html
/usr/local/share/emailrelay/doc/windows.txt
/usr/local/var/spool/emailrelay/emailrelay.*.content
/usr/local/var/spool/emailrelay/emailrelay.*.envelope

FHS style...
/etc/emailrelay.conf
/etc/emailrelay.conf.template
/etc/init.d/emailrelay
/usr/lib/emailrelay-poke
/usr/sbin/emailrelay
/usr/sbin/emailrelay-passwd
/usr/sbin/emailrelay-submit
/usr/share/doc/emailrelay/changelog.gz
/usr/share/doc/emailrelay/changelog.html
/usr/share/doc/emailrelay/developer.html
/usr/share/doc/emailrelay/developer.txt
/usr/share/doc/emailrelay/emailrelay.css
/usr/share/doc/emailrelay/emailrelay-man.html
/usr/share/doc/emailrelay/examples/emailrelay-deliver.sh
/usr/share/doc/emailrelay/examples/emailrelay-notify.sh
/usr/share/doc/emailrelay/examples/emailrelay-process.sh
/usr/share/doc/emailrelay/examples/emailrelay-resubmit.sh
/usr/share/doc/emailrelay/examples/emailrelay-submit.sh
/usr/share/doc/emailrelay/index.html
/usr/share/doc/emailrelay/NEWS
/usr/share/doc/emailrelay/*.png
/usr/share/doc/emailrelay/README
/usr/share/doc/emailrelay/readme.html
/usr/share/doc/emailrelay/reference.html
/usr/share/doc/emailrelay/reference.txt
/usr/share/doc/emailrelay/userguide.html
/usr/share/doc/emailrelay/userguide.txt
/usr/share/doc/emailrelay/windows.html
/usr/share/doc/emailrelay/windows.txt
/usr/share/man/man1/emailrelay.1.gz
/usr/share/man/man1/emailrelay-passwd.1.gz
/usr/share/man/man1/emailrelay-poke.1.gz
/usr/share/man/man1/emailrelay-submit.1.gz
/var/spool/emailrelay/emailrelay.*.content
/var/spool/emailrelay/emailrelay.*.envelope  

SEE ALSO

E-MailRelay user guide, (http://emailrelay.sourceforge.net/user.html).
E-MailRelay reference, (http://emailrelay.sourceforge.net/reference.html).
emailrelay-submit(1), emailrelay-poke(1), emailrelay-passwd(1), syslog(3), pppd(8), init.d(7)  

AUTHOR

Graeme Walker, mailto:graeme_walker@users.sourceforge.net

 

Index

NAME
SYNOPSIS
DESCRIPTION
OPTIONS
FILES
SEE ALSO
AUTHOR
This document was created by man2html, using the manual pages.
Time: 23:24:49 GMT, January 08, 2006