12.5 Summary of the mtasim Administrative Commands

This section provides a summary of administrative commands available in mtasim.

mtasim command: \D name=value [name=value...]

Defines Sendmail macro name to the given value. Any number of name=value pairs can be given as arguments.

See D command.

mtasim command: \E code [regex]

Instructs mtasim to expect next SMTP command to return given code (a three-digit decimal number). Optional regex argument is an extended POSIX regular expression. If supplied, the program will also require that the extended SMTP code (if any) and textual message returned by the command match this expression.

See expect commands.

mtasim command: \L [name...]

Lists defined macros. See L command.

mtasim command: \U name [name...]

Undefines macros given as its arguments.

mtasim command: \S family [hostname address [port]]

Declares the sender socket parameters. See S command, for a detailed description and examples.

This command is available only at the initial stage of a mtasim session, before the first SMTP command was given. It is disabled if the --sender-socket option was given in the command line (see sender-socket). The help output reflects whether or not this command is available.

If neither this command nor the --sender-socket option were given, mtasim behaves as if given the \S stdio command.

The family argument supplies the socket family, i.e. the first argument to the connect handler (see connect handler). It can have either literal or numeric value, as described in the table below:

Literal	Numeric	Meaning
stdio	0	Standard input/output (the MTA is run with -bs option)
unix	1	UNIX socket
inet	2	IPv4 protocol
inet6	3	IPv6 protocol

Table 12.1: Socket families

See also Table 4.3.

Depending on the family, the rest of arguments supply additional parameters:

stdio

The hostname argument can be specified. It defines the first argument of the connect handler (see hostname in connect handler).

inet

inet6

All arguments must be specified.

argument	connect argument	meaning
hostname	1	Sender host name
address	4	Sender IP address
port	3	Sender port number

unix

Hostname and address must be supplied. The address argument must be a full pathname of the UNIX socket.