1FAXRCVD(8C) FAXRCVD(8C)
2
6 faxrcvd - HylaFAX notification script for received facsimile
7
9 /var/spool/hylafax/bin/faxrcvd qfile devid commid error-msg [ callid-1
10 [ callid-2 [ ... [ callid-n ] ] ] ]
11
13 bin/faxrcvd is the command script invoked by the facsimile server when‐
14 ever a facsimile is received. It is designed to be customizable by the
15 administrator. (Ideally this is done by creating a customized faxrcvd
16 script in a different filename or by copying the default script to a
17 different filename, customizing that new file, and then using FaxRcvd‐
18 Cmd in the modem config file to point faxgetty(8C) at the customized
19 script. See hylafax-config(5F).)
20 The default script sends electronic mail to the FaxMaster user describ‐
22 ing the content of the facsimile and other useful information such as
23 the time spent receiving the document. The arguments are:
24 qfile the pathname of the received TIFF file relative to the root
26 of the spooling hierarchy.
27 devid the modem device on which the facsimile was received.
29 commid the communication identifier for the inbound call.
31 error-msg an error message that is non-null if an error was encountered
33 during the receive operation.
34 callid the value of various identification indicators from the call
36
38 This script can route facsimile directly to the intended recipient. To
39 do this create a shell script etc/FaxDispatch in the spooling area that
40 sets SENDTO to the receiver's electronic mail address. For example,
41 case "$SENDER" in
43 *1*510*526*1212*) SENDTO=sam;; # Sam's test rig in Berkeley
44 *1*415*390*1212*) SENDTO=raster@asd;; # 7L Xerox room, used for scanning
45 *5107811212) SENDTO=peebles@mti;; # stuff from home
46 esac
47 case "$DEVICE" in
48 ttyS1) SENDTO=john;; # all faxes received on ttyS1
49 ttyLT0) SENDTO=mary@home;; # all faxes received on ttyLT0
50 esac
51 case "$CIDNUMBER" in
52 435*) SENDTO=lee; FILETYPE=pdf;; # all faxes from area code 435
53 5059627777) SENDTO=amy; FILETYPE=tif;; # Amy wants faxes in TIFF
54 esac
55 case "$CALLID4" in
56 7890) SENDTO=user1@domain;; # DID 7890 received at $CALLID4
57 7891) SENDTO=user2@domain;; # DID 7891 received at $CALLID4
58 7892) SENDTO=user3@domain;; # DID 7892 received at $CALLID4
59 esac
60 case "$SUBADDR" in
61 53) SENDTO=FaxMaster;; # without double-notification
62 roger) SENDTO=roger;; # possible text subaddressing
63 esac
64 Note that you must match any embedded white space. The facsimile will
66 be sent as a MIME-encoded PostScript document as default.
67 BCCTO controls the blind copy recipient of the received fax notifica‐
69 tion. It is given as an e-mail address.
70 CALLIDn
72 is equivalent to the nth call identification parameter
73 CCTO controls the copy recipient of the received fax notification.
75 It is given as an e-mail address.
76 CIDNAME
78 is equivalent to CALLID2 above.
79 CIDNUMBER
81 is equivalent to CALLID1 above.
82 DEVICE is equivalent to device above.
84 FILETYPE
86 controls the filetype of the image attachment. Current filetype
87 options are ``ps'', ``tif'', ``pdf'', and ``none''. Multiple
88 values may be specified by separating them with whitespace. In
89 that case a separate attachment is created for each filetype.
90 FROMADDR
92 controls the sender of the received fax notification. It is
93 given as an e-mail address.
94 LANG controls the localization of the text of the received fax noti‐
96 fication.
97 MSG is equivalent to error-msg above.
99 NOTIFY_FAXMASTER
101 (an underscore ``_'' character is between NOTIFY and FAXMASTER)
102 indicates whether or not the HylaFAX administrator should be
103 notified regarding incoming facsimile. Default is ``always''.
104 Also available are ``never'', which means to never send any
105 received facsimile notification, and ``errors'', which means to
106 send notification only if there were reception errors.
107 RECV_DATA_CONVERSION
109 Indicates whether TIFF files saved to disk by HylaFAX should be
110 converted in place to another compression data format. At this
111 time the only available option is ``JBIG:MMR'' which causes TIFF
112 files using JBIG compression to be converted to 2D-MMR (G4) com‐
113 pression. Since the majority of TIFF file viewers lack JBIG sup‐
114 port, this setting may be useful if JBIG-compressed fax receiv‐
115 ing is enabled (see ``Class1JBIGSupport'' config option) and the
116 received fax files are to be directly accessed by users, either
117 through HylaFAX clients such as WHFC or via a shared directory.
118 Note that if the received faxes are viewed/accessed only as
119 email attachments then there's no need to use this setting: TIFF
120 email attachments are automatically sent as 2D-MMR (G4) when the
121 on disk compression data format is JBIG.
122 SENDER is the received TSI of the fax sender.
124 SENDTO controls the recipient of the received fax notification. It is
126 given as an e-mail address. To indicate multiple recipients
127 SENDTO should be given a list of addresses separated by white‐
128 space.
129 SUBADDR
131 the received subaddress value, communicated by the sender for
132 post-reception routing purposes
133 Other shell variables are available. Consult the faxrcvd script
135 directly.
136
138 /var/spool/hylafax spooling area
139 /usr/sbin/faxinfo for printing information about the facsimile
140 /usr/bin/fax2ps for converting TIFF to PostScript
141 /usr/sbin/sendmail for delivering mail
142
144 faxd(8C), hylafax-server(5F), recvq(5F)
145 May 28, 2001 FAXRCVD(8C)