6.2.1 Variable Expansion

In the discussion below we often refer to meta-variable expansion in strings. This is a process, whereby any sequence ‘${variable}’ is replaced with the value of variable. The defined variables are:

db

The database name.

map

The map name.

key

The lookup key.

diag

If the key was not found or some error occurred, this variable expands to a short diagnostics string, suitable for return message. Otherwise, expands to empty string.

name

The ‘name’ field from the retrieved record. Empty string if the user not found.

passwd

The ‘passwd’ field from the retrieved record. Empty string if the user not found.

uid

The ‘uid’ field from the retrieved record. If the user was not found, expands to ‘-1’.

gid

The ‘gid’ field from the retrieved record. If the user was not found, expands to ‘-1’.

gecos

The ‘gecos’ field from the retrieved record. Empty string if the user not found.

dir

The ‘dir’ field from the retrieved record. Empty string if the user not found.

shell

The ‘shell’ field from the retrieved record. Empty string if the user not found.

mailbox

The ‘mailbox’ field from the retrieved record. Empty string if the user not found.

quota

The ‘quota’ field from the retrieved record. If the user was not found, expands to ‘NONE’.

mbsize

Mailbox size, in bytes. Defined only in ‘mbq’ mode.

msgsize

Expected message size, in bytes. Defined only in ‘mbq’ mode.