FAXRCVD(8C)FAXRCVD(8C)NAMEfaxrcvd - HylaFAX notification script for received facsimile
SYNOPSIS
/var/spool/fax/bin/faxrcvd qfile devid commid error-msg [ callid-1 [
callid-2 [ ... [ callid-n ] ] ] ]
DESCRIPTION
bin/faxrcvd is the command script invoked by the facsimile server when‐
ever a facsimile is received. It is designed to be customizable by the
administrator. (Ideally this is done by creating a customized faxrcvd
script in a different filename or by copying the default script to a
different filename, customizing that new file, and then using FaxRcvd‐
Cmd in the modem config file to point faxgetty(8C) at the customized
script. See hylafax-config(5F).)
The default script sends electronic mail to the FaxMaster user describ‐
ing 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.
callid the value of various identification indicators from the call
NOTES
This script can route facsimile directly to the intended recipient. 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
case "$SUBADDR" in
53) SENDTO=FaxMaster;; # without double-notification
roger) SENDTO=roger;; # possible text subaddressing
esac
Note that you must match any embedded white space. The facsimile will
be sent as a MIME-encoded PostScript document as default.
BCCTO controls the blind copy recipient of the received fax notifica‐
tion. It is given as an e-mail address.
CALLIDn
is equivalent to the nth call identification parameter
CCTO controls the copy recipient of the received fax notification.
It is given as an e-mail address.
CIDNAME
is equivalent to CALLID2 above.
CIDNUMBER
is equivalent to CALLID1 above.
DEVICE is equivalent to device above.
FILETYPE
controls the filetype of the image attachment. Current filetype
options are ``ps'', ``tif'', and ``pdf''. Multiple values may
be specified by separating them with whitespace. In that case a
separate attachment is created for each filetype.
FROMADDR
controls the sender of the received fax notification. It is
given as an e-mail address.
LANG controls the localization of the text of the received fax noti‐
fication.
MSG is equivalent to error-msg above.
NOTIFY_FAXMASTER
(an underscore ``_'' character is between NOTIFY and FAXMASTER)
indicates whether or not the HylaFAX administrator should be
notified regarding incoming facsimile. Default is ``always''.
Also available are ``never'', which means to never send any
received facsimile notification, and ``errors'', which means to
send notification only if there were reception errors.
RECV_DATA_CONVERSION
Indicates whether TIFF files saved to disk by HylaFAX should be
converted in place to another compression data format. At this
time the only available option is ``JBIG:2D-MMR'' which causes
TIFF files using JBIG compression to be converted to 2D-MMR (G4)
compression. Since the majority of TIFF file viewers lacks JBIG
support, this setting may be useful if JBIG-compressed fax
receiving is enabled (see ``Class1JBIGSupport'' config option)
and the received fax files are to be directly accessed by users,
either through HylaFAX clients such as WHFC or via a shared
directory. Note that if the received faxes are viewed/accessed
only as email attachments then there's no need to use this set‐
ting: TIFF email attachments are automatically sent as 2D-MMR
(G4) when the on disk compression data format is JBIG.
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. To indicate multiple recipients
SENDTO should be given a list of addresses separated by white‐
space.
SUBADDR
the received subaddress value, communicated by the sender for
post-reception routing purposes
Other shell variables are available. Consult the faxrcvd script
directly.
FILES
/var/spool/fax 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 ALSOfaxd(8C), hylafax-server(5F), recvq(5F)
May 28, 2001 FAXRCVD(8C)