Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
EMAILRELAY(1)		    General Commands Manual		 EMAILRELAY(1)

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	trans-
       fer 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 for-
       warding 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 re-
	      sponses.

       -q, --as-client _host:port_
	      Runs as a	client,	forwarding all spooled mail to <host>: equiva-
	      lent  to	--log  --no-syslog  --no-daemon	--dont-serve --forward
	      --forward-to.

       -y, --as-proxy _host:port_
	      Runs as a	proxy server,  forwarding  each	 mail  immediately  to
	      <host>:  equivalent  to --log --close-stderr --poll=0 --forward-
	      to.

       -d, --as-server
	      Runs as a	server,	storing	mail in	the spool  directory:  equiva-
	      lent to --log --close-stderr.

       -C, --client-auth _file_
	      Enables  smtp  authentication  with the remote server, using the
	      given secrets file.

       -Y, --client-filter _program_
	      Specifies	an external program to process messages	when they  are
	      forwarded.

       -j, --client-tls
	      Enables  negotiated  tls/ssl  for	 smtp client (if openssl built
	      in).

       -b, --client-tls-connection
	      Enables smtp over	tls/ssl	for smtp client	(if openssl built in).

       -e, --close-stderr
	      Closes the standard error	stream soon 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 built 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.

       -W, --filter-timeout _time_
	      Sets the timeout (in seconds) for	running	the --filter processor
	      (default is 300).

       -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 immediate	forwarding of messages as soon as they are re-
	      ceived (requires --forward-to).

       -I, --interface _ip-list_
	      Defines the  listening  interface(s)  for	 incoming  connections
	      (comma-separated	list  with  optional  smtp=,pop=,admin=	quali-
	      fiers).

       -l, --log
	      Writes log information on	standard error	and  syslog  (but  see
	      --close-stderr and --no-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 --ad-
	      min or --pop).

       -n, --no-syslog
	      Disables syslog output (always overridden	by --syslog).

       -i, --pid-file _pid-file_
	      Defines a	file for storing the daemon process-id.

       -O, --poll _period_
	      Enables polling of the spool directory for messages to  be  for-
	      warded  with  the	specified period (zero means on	client discon-
	      nection) (requires --forward-to).

       -B, --pop
	      Enables the pop server.

       -F, --pop-auth _file_
	      Defines the pop server secrets file  (default  is	 /etc/emailre-
	      lay.auth).

       -J, --pop-by-name
	      Modifies	the pop	spool directory	according to the pop 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 (default	is  110)  (re-
	      quires --pop).

       -p, --port _port_
	      Specifies	the smtp listening port	number (default	is 25).

       -w, --prompt-timeout _time_
	      Sets the timeout (in seconds) for	getting	an initial prompt from
	      the server (default is 20).

       -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).

       -S, --server-auth _file_
	      Enables  authentication  of  remote clients, using the given se-
	      crets file.

       -K, --server-tls	_pem-file_
	      Enables negotiated tls/ssl  for  smtp  server  using  the	 given
	      openssl certificate file (which must be in the directory trusted
	      by openssl).

       -M, --size _bytes_
	      Limits the size of submitted messages.

       -s, --spool-dir _dir_
	      Specifies	the spool directory  (default  is  /var/spool/emailre-
	      lay).

       -k, --syslog
	      Forces  syslog output if logging is enabled (overrides --no-sys-
	      log).

       -0, --tls-config	_flags_
	      Sets tls configuration flags (eg.	2 for SSLv2 support).

       -u, --user _username_
	      Names the	effective user to switch to if started	as  root  (de-
	      fault 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/etc/pam.d/emailrelay
       /usr/local/libexec/emailrelay/emailrelay-filter-copy
       /usr/local/libexec/emailrelay/emailrelay-poke
       /usr/local/libexec/emailrelay/examples/*
       /usr/local/libexec/emailrelay/init/emailrelay
       /usr/local/man/man1/emailrelay*.1.gz
       /usr/local/sbin/emailrelay
       /usr/local/sbin/emailrelay-passwd
       /usr/local/sbin/emailrelay-submit
       /usr/local/share/emailrelay/doc/*
       /usr/local/share/emailrelay/doc/index.html
       /usr/local/share/emailrelay/doc/README
       /usr/local/var/spool/emailrelay/emailrelay.*.content
       /usr/local/var/spool/emailrelay/emailrelay.*.envelope

       FHS style...
       /etc/emailrelay.conf
       /etc/init.d/emailrelay
       /etc/pam.d/emailrelay
       /usr/lib/emailrelay/emailrelay-filter-copy
       /usr/lib/emailrelay/emailrelay-poke
       /usr/lib/emailrelay/examples/*
       /usr/sbin/emailrelay
       /usr/sbin/emailrelay-passwd
       /usr/sbin/emailrelay-submit
       /usr/share/doc/emailrelay/*
       /usr/share/doc/emailrelay/index.html
       /usr/share/doc/emailrelay/README
       /usr/share/man/man1/emailrelay*.1.gz
       /var/spool/emailrelay/emailrelay.*.content
       /var/spool/emailrelay/emailrelay.*.envelope

SEE ALSO
       E-MailRelay    user    guide,   http://emailrelay.sourceforge.net/user-
       guide.html .
       E-MailRelay reference, http://emailrelay.sourceforge.net/reference.html
       .
       emailrelay-submit(1), emailrelay-passwd(1),

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

				     local			 EMAILRELAY(1)

NAME | SYNOPSIS | DESCRIPTION | OPTIONS | FILES | SEE ALSO | AUTHOR

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=emailrelay&sektion=1&manpath=FreeBSD+12.1-RELEASE+and+Ports>

home | help