1NOTIFY(8C) NOTIFY(8C)
2
6 notify - HylaFAX user notification program
7
9 /var/spool/hylafax/bin/notify qfile why jobtime [ nextTry ]
10
12 bin/notify is the program invoked by the facsimile server to notify a
13 user about the status of an outbound job. It is designed to be custom‐
14 izable by the administrator. (Ideally this is done by creating a cus‐
15 tomized notify program in a different filename or by copying the
16 default program to a different filename, customizing that new file, and
17 then using NotifyCmd in the scheduler config file to point faxq(8C) at
18 the customized program. See hylafax-config(5F).)
19 The default notification program sends the user electronic mail
21 describing the event or action. The arguments are:
22 qfile the pathname of the job description file.
24 why a string that specifies why the user is being notified; one
26 of:
27 Why Notes Meaning
28 done job was completed successfully
29 failed ¹ job was not completed
30 rejected job was rejected for specified reasons
31 blocked job is blocked by concurrent jobs
32 requeued ¹ job was not completed, but was requeued for retry
33 removed job was deleted from the queue
34 killed job was deleted from the queue
35 timedout job could not be sent before kill time expired
36 format_failed document conversion failed
37 no_formatter the document conversion program was not found
38 poll_rejected ¹ a polling request was rejected by the remote side
39 poll_no_document ¹ a polling request failed because nothing was available
40 poll_failed ¹ a polling request failed for an unknown reason
41 ¹ A transcript of the failed communication is returned to the
42 sender.
43 jobtime the total transmission time of a successful job or the con‐
45 nect time of a failed request (passed as a string).
46 nextTry the time (passed as a string) at which the next attempt will
48 be made to complete the job. This parameter is passed only
49 if why is ``requeued''.
50
52 The behavior of notify is intended to be customizable via the
53 etc/FaxNotify program, if present. FaxNotify is sourced after the q-
54 file is parsed and all default values are preset. Useful settings for
55 FaxNotify are:
56 WHY is identical to why mentioned above and can be useful in deter‐
58 mining under what conditions various settings should take
59 effect. For example,
60 if [ "$WHY" != "done" ]; then
62 RETURNFILETYPE=pdf;
63 fi
64 This would only set RETURNFILETYPE when the job did not complete
66 successfully.
67 RETURNFILETYPE
69 can be set to ``tif'', ``pdf'', ``ps'', or ``original''. If
70 set, this causes notify to return a copy of the submitted docu‐
71 ments to the SENDER address along with the notification message.
72 The ``original'' setting uses the format type that was used in
73 the submission. Multiple values may be specified by separating
74 them with whitespace. In that case a separate attachment is cre‐
75 ated for each filetype.
76 RETURNTECHINFO
78 defaults to ``yes'' and is used to indicate whether or not tech‐
79 nical information such as the session parameters should be
80 included with the notification message. If set to anything
81 other than ``yes'' this information will not be included.
82 RETURNTRANSCRIPT
84 defaults to ``yes'' and is used to indicate whether or not the
85 session transcript (log) should be returned with the notifica‐
86 tion message on the error conditions noted above.
87 NOTIFY_FAXMASTER
89 is used to deliver a notification message to TOADDR (which
90 defaults to ``FaxMaster'') that contains technical information
91 about the job. This is useful in allowing the administrator to
92 be aware of any problems before those problems are reported by
93 the users. Possible settings are ``yes'', ``always'', ``no'',
94 ``never'', and ``errors''. If ``errors'' is used then the noti‐
95 fication message is only sent to FaxMaster when the job experi‐
96 enced an error. The default is ``no''.
97 NOTIFICATIONLANGUAGE
99 The language of the e-mail messages sent by HylaFAX is selected
100 according to the setting of the NOTIFICATIONLANGUAGE variable,
101 which can be assigned a locale name like the LC_* and LANG
102 locale environment variables.
103 If the NOTIFICATIONLANGUAGE variable is not set or set to the
105 empty value, then, as a default, the value of the LC_MESSAGES
106 category locale name, i.e., the value of the LC_ALL variable (if
107 not empty), else of the LC_MESSAGES variable (if not empty),
108 else of the LANG variable, is used.
109 A suggestion for NOTIFICATIONLANGUAGE may be:
111 NOTIFICATIONLANGUAGE="${LC_ALL:-${LC_MES‐
113 SAGES:-${LC_CTYPE:-${LANG:-}}}}"
114
116 /var/spool/hylafax spooling area
117 /usr/sbin/sendmail for delivering mail
118
120 faxq(8C), hylafax-server(5F), sendq(5F)
121 May 8, 1996 NOTIFY(8C)