Previous Section Next Section

21.9 Alphabetized sendmail Macros

The sendmail program reserves all lowercase letters, punctuation characters, and digits for its own use. For multicharacter names, it reserves all those that begin with an underscore or a lowercase letter. Table 21-7 lists all the macro names that have special internal meaning to sendmail. Included in this list are macros that are used by the mc configuration technique.[12]

[12] Note that these are the exception to the usual rule in that they are all uppercase letters. In a way this makes sense because they are being used by the configuration file, not by the internals of the sendmail program.

Table 21-7. Reserved macros

Macro

§

Description

$_

$_

RFC1413-validation & IP source route

$a

$a

The origin date in RFC822 format

${addr_type}

${addr_type}

Is address recipient/sender header/envelope

${alg_bits}

${alg_bits}

The number of bits in the TLS cipher

${auth_authen}

${auth_authen}

RFC2554 AUTH credentials

${auth_author}

${auth_author}

RFC2554 AUTH= parameter

${auth_ssf}

${auth_ssf}

AUTH encryption keylength

${auth_type}

${auth_type}

Authentication mechanism used

$b

$b

The current date in RFC2822 format

${bodytype}

${bodytype}

The ESMTP (Extended SMTP) BODY parameter

$B

$B

The BITNET relay (mc configuration, deprecated)

$c

$c

The hop count

${cert_issuer}

${cert_issuer}

Distinguished name of certificate signer

${cert_md5}

${cert_md5}

MD5 of cert certificate

${cert_subject}

${cert_subject}

The cert subject

${cipher}

${cipher}

Cipher suite used for connection

${cipher_bits}

${cipher_bits}

TLS encryption key length

${client_addr}

${client_addr}

The connecting host's IP address

${client_flags}

${client_flags}

The nature of the connection

${client_name}

${client_name}

The connecting host's canonical name

${client_port}

${client_port}

The connecting host's port number

${client_resolve}

${client_resolve}

Result of lookup of ${client_name}

${cn_issuer}

${cn_issuer}

Common name of certificate signer

${cn_subject}

${cn_subject}

Common name of certificate

${currHeader}

${currHeader}

Current header's value

$C

$C

The DECnet relay (mc configuration)

$d

$d

The current date in Unix ctime(3) format

${daemon_addr}

${daemon_addr}

Listening daemon's address

${daemon_family}

${daemon_family}

Listening daemon's family

${daemon_flags}

${daemon_flags}

Listening daemon's flags

${daemon_info}

${daemon_info}

Listening daemon's syslog information

${daemon_name}

${daemon_name}

Listening daemon's name

${daemon_port}

${daemon_port}

Listening daemon's port

${deliveryMode}

${deliveryMode}

The current delivery mode

${dsn_envid}

${dsn_envid}

The DSN ENVID= value

${dsn_notify}

${dsn_notify}

The DSN NOTIFY= value

${dsn_ret}

${dsn_ret}

The DSN RET= value

$e

SmtpGreetingMessage

The SMTP greeting message

${envid}

${envid}

The original DSN envelope ID

$E

$E

The X.400 relay (unused) (mc configuration)

$f

$f

The sender's address

$F

$F

The fax relay (mc configuration)

$g

$g

The sender's address relative to recipient

$h

$h

Host part of the delivery agent triple

${hdr_name}

${hdr_name}

The current header's name

${hdrlen}

${hdrlen}

The length of ${currHeader}

$H

$H

The mail hub (mc configuration)

$i

$i

The queue identifier

${if_addr}

${if_addr}

The IP address of the receive interface

${if_addr_out}

${if_addr_out}

The IP address of the send interface

${if_family}

${if_family}

The network family of the receive interface

${if_family_out}

${if_family_out}

The network family of the send interface

${if_name}

${if_name}

The name of the receive interface

${if_name_out}

${if_name_out}

The name of the send interface

$j

$j

Official canonical name

$k

$k

UUCP node name

$l

UnixFromLine

The Unix From format

${load_avg}

${load_avg}

The current load average

$L

$L

The unknown local user relay (mc configuration)

$m

$m

The DNS domain name

${mail_addr}

${mail_addr}

Saved $: value for MAIL FROM: triple

${mail_host}

${mail_host}

Saved $@ value for MAIL FROM: triple

${mail_mailer}

${mail_mailer}

Saved $# value for MAIL FROM: triple

${msg_size}

${msg_size}

Size of the current message

$M

$M

Whom we are masquerading as (mc configuration)

${MTAHost}

${MTAHost}

Host for the msp feature

$n

$n

Error message sender

${nrcpts}

${nrcpts}

Number of envelope recipients

${ntries}

${ntries}

Number of delivery attempts

$o

OperatorChars

Token separation operators

${opMode}

${opMode}

The startup operating mode

$p

$p

The sendmail process ID

$q

$q

The default format of the sender's address (obsolete)

${queue_interval}

${queue_interval}

The interval specified by -q

$r

$r

The protocol used

${rcpt_addr}

${rcpt_addr}

Saved $: value for RCPT TO: triple

${rcpt_host}

${rcpt_host}

Saved $@ value for RCPT TO: triple

${rcpt_mailer}

${rcpt_mailer}

Saved $# value for RCPT TO: triple

$R

$R

The relay for unqualified names (mc configuration, deprecated)

$s

$s

The sender host's name

${sendmailMTACluster}

${sendmailMTACluster}

The LDAP cluster to use

${server_addr}

${server_addr}

The address of the connected-to machine

${server_name}

${server_name}

The hostname of the connected-to machine

$S

$S

The smart host (mc configuration)

$t

$t

The current time in seconds

${tls_version}

${tls_version}

TLS/Secure Sockets Layer (SSL) version

$u

$u

Address part of a delivery agent triple

$U

$U

The UUCP name to override $k (mc configuration)

$v

$v

Version of the sendmail

${verify}

${verify}

Result of cert verification

$V

$V

The UUCP relay for class $=V (mc configuration)

$w

$w

The short name of this host

$W

$W

The UUCP relay for class $=W (mc configuration)

$x

$x

The full name of the sender

$X

$X

The UUCP relay for class $=X (mc configuration)

$y

$y

Name of the controlling TTY

$Y

$Y

The UUCP relay for unclassified hosts (mc configuration)

$z

$z

The recipient's home directory

$Z

$Z

Version of the mc configuration (mc configuration)

The following pages present a complete reference for each defined sendmail macro. They are presented in alphabetical order for ease of lookup, rather than in the order in which they typically appear in configuration files.

    Previous Section Next Section