Listener action variables for Windows

The following action variables can be used in an action or a filter. The value is substituted into the action variable prior to initiating the message handler.

Action variables start with a dollar sign ( $ ). The escape character is also a dollar sign, so use two dollar signs ( $$ ) to specify a single dollar sign as plain text.

Variable Description

$subject

The subject of a message.

$content

The content of a message.

$message

An entire message, including subject, content, and sender.

$message_start

The beginning portion of a message, as specified by the message_start filter keyword. This variable is only available if you have specified the message_start filter keyword. See Listener keywords for Windows.

$message_end

The portion of a message, excluded from the message_start filter keyword. This variable is only available if you have specified the message_start filter keyword. See Listener keywords for Windows.

$ml_connect

The MobiLink network protocol options as specified by the dblsn -x option. The default is an empty string. See -x option.

$ml_user

The MobiLink user name as specified by the dblsn -u option. The default name is device-name-dblsn.

$ml_password

The MobiLink password as specified by dblsn -w option, or the new MobiLink password if -y is used.

$priority

The meaning of this variable is carrier library-dependent.

$request_id

The request ID that was specified in a push request. See Push requests.

$remote_id

The remote ID. This variable can only be used when the dblsn -r option is specified. See Filtering messages by remote ID.

$sender

The sender of a message.

$type

The meaning of this variable is carrier library-dependent.

$year

The meaning of this variable is carrier library-dependent.

$month

The meaning of this variable is carrier library-dependent. Values can be from 1-12.

$day

The meaning of this variable is carrier library-dependent. Values can be from 1-31.

$hour

The meaning of this variable is carrier library-dependent. Values can be from 0-23.

$minute

The meaning of this variable is carrier library-dependent. Values can be from 0-59.

$second

The meaning of this variable is carrier library-dependent. Values can be from 0-59.

$best_adapter_mac

The MAC address of the best NIC for reaching the MobiLink server that is specified by the dblsn -x option. If the best route does not go through a NIC, the value is an empty string.

$best_adapter_name

The adapter name of the best NIC for reaching the MobiLink server that is specified by the dblsn -x option. If the best route does not go through a NIC, the value is an empty string.

$best_ip

The IP address of the best IP interface for reaching the MobiLink server that is specified by the dblsn -x option. If that server is unreachable, the value is 0.0.0.0.

$best_network_name

The RAS or dial-up profile name of the best profile for reaching the MobiLink server that is specified by the dblsn -x option. If the best route does not go through a RAS/dial-up connection, the value is an empty string.

$adapters

A list of active network adapter names, each separated by a vertical bar ( | ).

$network_names

A list of connected RAS entry names, each separated by a vertical bar ( | ). RAS entry names are sometimes referred to as dial-up entry names or Dial-Up Network (DUN).

$poll_connect

The MobiLink network protocol options as specified by the poll_connect polling keyword. The default is an empty string. See Listener keywords for Windows.

$poll_notifier

The name of the Notifier as specified by the poll_notifier polling keyword. See Listener keywords for Windows.

$poll_key

The poll key as specified by the poll_key polling keyword. See Listener keywords for Windows.

$poll_every

The polling frequency as specified by the poll_every polling keyword. See Listener keywords for Windows.

See also
Example

The following examples uses the $message_end action variable to determine which publication to synchronize:

dblsn -l "message_start=start-of-message;action='run dbmlsync.exe -c ... -n $message_end'"