Reference

faxrcvd(8hylafax)

HylaFAX notification script for received facsimile

NAME

faxrcvd - HylaFAX notification script for received facsimile

SYNOPSIS

/var/spool/hylafax/bin/faxrcvd qfile devid commid error-msg cidnumber cidname

DESCRIPTION

bin/faxrcvd is the command script invoked by the facsimile server whenever a facsimile is received. The default script sends electronic mail to the FaxMaster user describing the content of the facsimile and other useful information such as the time spent receiving the document. The arguments are:

qfile

the pathname of the received TIFF file relative to the root of the spooling hierarchy.

devid

the modem device on which the facsimile was received.

commid

the communication identifier for the inbound call.

error-msg

an error message that is non-null if an error was encountered during the receive operation.

cidnumber

the value of CIDNumber when using QualifyCID

cidname

the value of CIDName when using QualifyCID

NOTES

This script can route facsimile directly to the intended receipient. To do this create a shell script etc/FaxDispatch in the spooling area that sets SENDTO to the receiver's electronic mail address. For example,

case "$SENDER" in
*1*510*526*1212*) SENDTO=sam;;          # Sam's test rig in Berkeley
*1*415*390*1212*) SENDTO=raster@asd;;   # 7L Xerox room, used for scanning
*5107811212)      SENDTO=peebles@mti;;  # stuff from home
esac
case "$DEVICE" in
ttyS1)            SENDTO=john;;         # all faxes received on ttyS1
ttyLT0)           SENDTO=mary@home;;    # all faxes received on ttyLT0
esac
case "$CIDNUMBER" in
435*)        SENDTO=lee; FILETYPE=pdf;; # all faxes from area code 435
5059627777)  SENDTO=amy; FILETYPE=tif;; # Amy wants faxes in TIFF
esac

Note that you must match any embedded white space. The facsimile will be sent as a MIME-encoded PostScript document as default.

CIDNAME

is equivalent to CIDName above.

CIDNUMBER

is equivalent to CIDNumber above.

DEVICE

is equivalent to device above.

FILETYPE

controls the filetype of the image attachment. Current filetype options are ``ps'', ``tif'', and ``pdf''.

MSG

is equivalent to error-msg above.

SENDER

is the received TSI of the fax sender.

SENDTO

controls the recipient of the received fax notification. It is given as an e-mail address.

Other shell variables are available. Consult the faxrcvd script directly.

FILES

/var/spool/hylafax	spooling area
/usr/sbin/faxinfo	for printing information about the facsimile
/usr/bin/fax2ps	for converting TIFF to PostScript
/usr/sbin/sendmail	for delivering mail

SEE ALSO

faxd(8C), hylafax-server(5F), recvq(5F)

History