RelayFax online help

 
DAT File Processing Macros

Navigation:  RelayFax Macros >

DAT File Processing Macros

Print this Topic Previous pageReturn to chapter overviewNext page

The following macros can be used within one or more of the RelayFax DAT Files. Some files can contain only certain macros. See RelayFax Data Files for a list of the files in which these macros may be used.

$TRACKINGNUMBER$

Every fax is assigned a unique tracking number. This macro returns that value and is useful for matching a fax event with the log files.

$RECIPIENTNAME$

This macro expands to the name of the fax recipient.

$RECIPIENTCOMPANY$

This macro expands to the company name of the fax recipient.

$RECIPIENTFAX$

This macro expands to the fax number of the fax recipient.

$FAXNUMBER$

This macro expands to the fax number to which the fax was sent.

$DID$

This macro expands to the DID number.

$FAXSUBJECT$

This macro expands to the subject of the fax.

$FROMLINE$ -or-

$FROMADDRESS$

This macro expands to the email address of the sender of the fax.

$FROMNAME$

This macro expands to the name of the sender of the fax.

$FROMCOMPANY$

This macro expands to the name of the company that sent the fax.

$FROMFAX$

This macro expands to the fax number of the sender of the fax. (typically the RelayFax Server's fax number).

$FROMPHONE$

This macro expands to the telephone number of the sender of the fax. This macro corresponds to the voice number setting in RelayFax's template files.

$STREET1$

Expands to the sender's street address.

$STREET2$

Expands to the sender's secondary address, or second line of their street address.

$CITY$

Expands to the sender's city.

$STATE$

This macro expands to the sender's state or province.

$ZIP$

Expands to the sender's zip or postal code.

$HOMEPHONE$

The sender's home telephone number.

$HOMEFAX$

The sender's home fax number.

$BUSPHONE$

Expands to the sender's business phone number.

$BUSFAX$

Sender's business fax number.

$BILLINGCODE$

This macro expands to the billing code of the sender.

$REPLYLINE$

When faxes are received and an email is generated to send the fax to its proper recipient(s) this macro will be used to generate the Reply-To header in that email. If the fax machine sending the fax transmits a fax ID to RelayFax then that fax ID will be used in the Reply-To field. This will allow the recipient of the fax to hit REPLY in their mail client and send the fax back to the person who originated it. If no fax ID is provided then this macro expands to a statement telling the recipient of the email not to generate replies. If the fax ID does not contain a fax number then a rule will have to be setup to make this feature work properly. This macro is valid in the NEWFAX.DAT and PARTFAX.DAT files only.

$LOCALID$

This macro expands to the fax machine ID of the local fax device sending the fax.

$REMOTEID$

This macro expands to the fax machine ID of the remote fax device accepting the fax.

$REASONSTRING$

This macro expands to a text description detailing why a fax attempt failed. This macro is valid in the FAILURE.DAT file only.

$COVERPAGE$

This macro expands to the path name of the cover page used on the fax.

$BANNERTEXT$

This macro expands to the banner used on each fax page.

$COMMENTS$

This macro expands to the comments used on the cover page.

$SPEED$

This macro expands to the baud rate of the fax connection.

$PAGECOUNT$

This macro expands to the total number of pages in the fax.

$PAGESSENT$

This macro expands to the total number of pages actually faxed.

$RETRYCOUNT$

This macro expands to the number of attempts taken to deliver the fax.

$RESOLUTION$

This macro expands to 0 for low resolution or 1 for hi-resolution.

$FAXCLASS$

This macro expands to CLASS_1, CLASS_2, or CLASS_20

$DURATION$

This macro expands to the number of seconds taken while sending or receiving the fax.

$PORT$

This macro expands to the port used to send the fax.

$SENDYEAR$

This macro expands to the year that the fax was sent or received.

$SENDMONTH$

This macro expands to the month that the fax was sent or received.

$SENDDAY$

This macro expands to the day that the fax was sent or received.

$SENDHOUR$

This macro expands to the hour that the fax was sent or received.

$SENDMINUTE$

This macro expands to the minute that the fax was sent or received.

$SENDSECOND$

This macro expands to the second that the fax was sent or received.

$TIMESTAMP$

This macro expands to a formatted string displaying the date and time the fax was sent or received.

$ATTACHFAXFILE$

This macro causes RelayFax to attach the fax image file to whatever message is being generated using this macro.

$ATTACHOCRFILE$

Attaches the OCR file corresponding to the fax.

$ATTACHMENT:path$

Attaches the file specified in the path to a message.

$CURRENTVERSION$

Expands to RelayFax's current version number.

$YOURVERSION$

Expands to the version number of the user's RelayFax SMTP Client.

NOTE: This macro can only be used in the UPDATE.DAT file.

$CLIENTINSTALL$

Expands to the name of the client install file (without path). This can be used to create a link to the install file in the update message.

$FAXFILE$

This macro expands to the name of the fax image file stored on disk.

$FAXFILENOPATH$

This macro expands to the name only of the fax image file stored on disk. The file path is not included.

$INCLUDEURL$

When this Macro is used in the NEWFAX.DAT or PARTFAX.DAT files, URLs will be included with messages that are built from these files that will make it possible for users to mark faxes originating from the same number as junk, prevent future faxes from being sent to them, and cause future faxes from the same source to be forwarded to an alternative email address.

$CNDDATA$

Returns all of the CND information provided to RelayFax by your fax modem. The "|" character is used in place of line breaks.


$CNDNAME$

Returns only the CND name element. This macro will only work properly when the CND name label is properly configured within the Modem Properties dialog.


$CNDNUMBER$

Returns only the CND number element. This macro will only work properly when the CND number label is properly configured within the Modem Properties dialog.

See also: