xref: /freebsd/contrib/sendmail/src/helpfile (revision e9ac41698b2f322d55ccf9da50a3596edb2c1800)
1#vers	2
2cpyr
3cpyr	Copyright (c) 1998-2000, 2002, 2004-2007 Proofpoint, Inc. and its suppliers.
4cpyr	    All rights reserved.
5cpyr	Copyright (c) 1983, 1995-1997 Eric P. Allman.  All rights reserved.
6cpyr	Copyright (c) 1988, 1993
7cpyr	    The Regents of the University of California.  All rights reserved.
8cpyr
9cpyr
10cpyr	By using this file, you agree to the terms and conditions set
11cpyr	forth in the LICENSE file which can be found at the top level of
12cpyr	the sendmail distribution.
13cpyr
14smtp	This is sendmail version $v
15smtp	Topics:
16smtp		HELO	EHLO	MAIL	RCPT	DATA
17smtp		RSET	NOOP	QUIT	HELP	VRFY
18smtp		EXPN	VERB	ETRN	DSN	AUTH
19smtp		STARTTLS
20smtp	For more info use "HELP <topic>".
21smtp	To report bugs in the implementation see
22smtp		http://www.sendmail.org/email-addresses.html
23smtp	For local information send email to Postmaster at your site.
24help	HELP [ <topic> ]
25help		The HELP command gives help info.
26helo	HELO <hostname>
27helo		Introduce yourself.
28ehlo	EHLO <hostname>
29ehlo		Introduce yourself, and request extended SMTP mode.
30ehlo	Possible replies include:
31ehlo		SEND		Send as mail			[RFC821]
32ehlo		SOML		Send as mail or terminal	[RFC821]
33ehlo		SAML		Send as mail and terminal	[RFC821]
34ehlo		EXPN		Expand the mailing list		[RFC821]
35ehlo		HELP		Supply helpful information	[RFC821]
36ehlo		TURN		Turn the operation around	[RFC821]
37ehlo		8BITMIME	Use 8-bit data			[RFC1652]
38ehlo		SIZE		Message size declaration	[RFC1870]
39ehlo		VERB		Verbose				[Allman]
40ehlo		BINARYMIME	Binary MIME			[RFC1830]
41ehlo		PIPELINING	Command Pipelining		[RFC1854]
42ehlo		DSN		Delivery Status Notification	[RFC1891]
43ehlo		ETRN		Remote Message Queue Starting	[RFC1985]
44ehlo		STARTTLS	Secure SMTP			[RFC2487]
45ehlo		AUTH		Authentication			[RFC2554]
46ehlo		ENHANCEDSTATUSCODES	Enhanced status codes	[RFC2034]
47ehlo		DELIVERBY	Deliver By			[RFC2852]
48ehlo		SMTPUTF8	Internationalized Email		[RFC6530]
49mail	MAIL From:<sender> [ <parameters> ]
50mail		Specifies the sender.  Parameters are ESMTP extensions.
51mail		See "HELP DSN" for details.
52rcpt	RCPT To:<recipient> [ <parameters> ]
53rcpt		Specifies the recipient.  Can be used any number of times.
54rcpt		Parameters are ESMTP extensions.  See "HELP DSN" for details.
55data	DATA
56data		Following text is collected as the message.
57data		End with a single dot on a line by itself.
58rset	RSET
59rset		Resets the system.
60quit	QUIT
61quit		Exit sendmail (SMTP).
62auth	AUTH mechanism [initial-response]
63auth		Start authentication.
64starttls	STARTTLS
65starttls		Start TLS negotiation.
66verb	VERB
67verb		Go into verbose mode.  This sends 0xy responses that are
68verb		not RFC821 standard (but should be).  They are recognized
69verb		by humans and other sendmail implementations.
70vrfy	VRFY <recipient>
71vrfy		Verify an address.  If you want to see what it aliases
72vrfy		to, use EXPN instead.
73expn	EXPN <recipient>
74expn		Expand an address.  If the address indicates a mailing
75expn		list, return the contents of that list.
76noop	NOOP
77noop		Do nothing.
78send	SEND FROM:<sender>
79send		replaces the MAIL command, and can be used to send
80send		directly to a users terminal.  Not supported in this
81send		implementation.
82soml	SOML FROM:<sender>
83soml		Send or mail.  If the user is logged in, send directly,
84soml		otherwise mail.  Not supported in this implementation.
85saml	SAML FROM:<sender>
86saml		Send and mail.  Send directly to the user's terminal,
87saml		and also mail a letter.  Not supported in this
88saml		implementation.
89turn	TURN
90turn		Reverses the direction of the connection.  Not currently
91turn		implemented.
92etrn	ETRN [ <hostname> | @<domain> | \#<queuename> ]
93etrn		Run the queue for the specified <hostname>, or
94etrn		all hosts within a given <domain>, or a specially-named
95etrn		<queuename> (implementation-specific).
96dsn	MAIL From:<sender> [ RET={ FULL | HDRS} ] [ ENVID=<envid> ]
97dsn	RCPT To:<recipient> [ NOTIFY={NEVER,SUCCESS,FAILURE,DELAY} ]
98dsn			     [ ORCPT=<recipient> ]
99dsn		SMTP Delivery Status Notifications.
100dsn	Descriptions:
101dsn		RET	Return either the full message or only headers.
102dsn		ENVID	Sender's "envelope identifier" for tracking.
103dsn		NOTIFY	When to send a DSN. Multiple options are OK, comma-
104dsn			delimited. NEVER must appear by itself.
105dsn		ORCPT	Original recipient.
106-bt	Help for test mode:
107-bt	?		 :this help message.
108-bt	.Dmvalue	 :define macro `m' to `value'.
109-bt	.Ccvalue	 :add `value' to class `c'.
110-bt	=Sruleset	 :dump the contents of the indicated ruleset.
111-bt	=M		 :display the known mailers.
112-bt	-ddebug-spec	 :equivalent to the command-line -d debug flag.
113-bt	$$m		 :print the value of macro $$m.
114-bt	$$=c		 :print the contents of class $$=c.
115-bt	/mx host	 :returns the MX records for `host'.
116-bt	/gethostbyname host [family]  :calls gethostbyname() for `host'.
117-bt	/dnslookup host [qtype] [flags]	 :Does a qtype DNS lookup for `host'.
118-bt	/parse address	 :parse address, returning the value of crackaddr, and
119-bt			  the parsed address.
120-bt	/sender address	 :parse sender address, returning the value of
121-bt			  setsender.
122-bt	/expand string	 :expands string, returning the value of expand.
123-bt	/try mailer addr :rewrite address into the form it will have when
124-bt			  presented to the indicated mailer.
125-bt	/tryflags flags	 :set flags used by parsing.  The flags can be `H' for
126-bt			  Header or `E' for Envelope, and `S' for Sender or `R'
127-bt			  for Recipient.  These can be combined, `HR' sets
128-bt			  flags for header recipients.
129-bt	/canon hostname	 :try to canonify hostname.
130-bt	/map mapname key :look up `key' in the indicated `mapname'.
131-bt	/header header	 :parses header, returning header flags
132-bt	/quit		 :quit address test mode.
133-bt	rules addr	 :run the indicated address through the named rules.
134-bt			  Rules can be a comma separated list of rules.
135control	Help for smcontrol:
136control	help		This message.
137control	restart		Restart sendmail.
138control	shutdown	Shutdown sendmail.
139control	status		Show sendmail status.
140control	mstat		Show sendmail status (machine readable format).
141control	memdump		Dump allocated memory list (for debugging only).
142