E-Mail White-List Checking
$whitelist_email pathname|databasespec [domain|combined] [EmptyOK] [WSDelim]
This command is used in a Job Administration UJP file to specify a white-list look-up file for use at launch time for e-mail items. The command may also be placed in an FS Template file (.FST) for use in an FFBC launch. Multiple commands may be supplied, and commands from System, Owner and Jobtype UJP files migrate to the job instance properties in the usual way.
 | The same pathname should only be used once in a set of lookup files. |
The advantages of the launch-time do-not-send and white-list commands are described in the Configuration topic and an overview appears in Launch-Time Do-Not-Send Checking.
A match in the white-list file causes checking specified in the $dns_email entries in the same file to be skipped. It also causes legacy do-not-send look-ups at transmit time to be skipped. If there is a $dns_email command with a FailAll keyword, all entries not in the whitelist(s) will be failed.
The parameters on this command are used as follows:
| pathname | The pathname of the look-up file to be used. Currently supported file extensions are: |
| .NDX | a character- or numeric-mode index file created and maintained by the CFUTIL PIN utility. |
| .TXT | a list of entries to be matched |
| databasespec | The components of the database specifier are separated by the vertical bar symbol (|) and are described in more detail in the description of the do-not-send feature. |
| Database Name | The full pathname of a supported database, or a DSN source |
| Table Name | The name of the table to use (default table name: DNS) |
| Key Field Name | The name of the key field to use (default key field RECIPIENT) |
| Timeout Value | Timeout for look-up (defaults to ADO default value) |
| Data Field Name | The name of the data field to use from the matched entry. |
| domain | A keyword which indicates that the index/list contains only domain names to be matched |
| combined | A keyword which indicates that the index/list contains both e-mail addresses and domain names |
| EmptyOK | A keyword which indicates that the index/list may be empty. This suppresses the check that ensures that at least one entry has been loaded from the file. Failure to load any entries could be a symptom of a corrupted file. |
| WSDelim | A keyword which indicates that any number of white spaces may separate the phone number and the WHITELIST_DATA code in a loaded TXT list. |
The NDX file may contain a positive numeric data value for each entry, the TXT file may contain a positive numeric data value separated from the phone number by a single TAB character (or any whitespace, if WSDelim is used), and the database data field may also contain a numeric value. The default value is 1. The value will be saved as the value of a variable named WHITELIST_DATA in the launched FS file. This variable is used to cause legacy and pre-loaded do-not-send checking at transmit time to be skipped.
When multiple commands are specified, items will be checked in the order of System, Owner and Jobtype entries and in the reverse sequence to that in which they appear in each file. In an FEB2 broadcast type (two list columns) a matched item will be prevent rejection even if fax transmission was specified to occur second.
Default: Do-not-send items will not be skipped.
Example:
$whitelist_email @FFBASE\whiteemail.txt
