Content-type: text/html
Man page of NOTIFY
NOTIFY
Section: Misc. Reference Manual Pages (1m)
Updated: May 8, 1996
Index
Return to Main Contents
NAME
notify - HylaFAX user notification script
SYNOPSIS
${SPOOL}/bin/notify
qfile
why
jobtime
[
nextTry
]
DESCRIPTION
bin/notify
is the command script invoked by the facsimile server to notify a
user about the status of an outbound job.
The default notification script sends the user
electronic mail describing the event or action.
The arguments are:
- qfile
-
the pathname of the job description file.
- why
-
a string that specifies why the user is being notified; one of:
Why Notes Meaning
done job was completed successfully
failed S1 job was not completed
rejected job was rejected for specified reasons
blocked job is blocked by concurrent jobs
requeued S1 job was not completed, but was requeued for retry
removed job was deleted from the queue
killed job was deleted from the queue
timedout job could not be sent before kill time expired
format_failed document conversion failed
no_formatter the document conversion program was not found
poll_rejected S1 a polling request was rejected by the remote side
poll_no_document S1 a polling request failed because nothing was available
poll_failed S1 a polling request failed for an unknown reason
S1 A transcript of the failed communication is returned
to the sender.
- jobtime
-
the total transmission time of a successful job or the connect
time of a failed request (passed as a string).
- nextTry
-
the time (passed as a string) at which the next attempt will be
made to complete the job.
This parameter is passed only if
why
is ``requeued''.
NOTES
The behavior of
notify
is intended to be customizable via the
etc/FaxNotify
script, if present. FaxNotify is sourced after the q-file is parsed and
all default values are preset. Useful settings for FaxNotify are:
- WHY
-
is identical to
why
mentioned above and can be useful in determining under what conditions
various settings should take effect. For example,
if [ "$WHY" != "done" ]; then
RETURNFILETYPE=pdf;
fi
This would only set
RETURNFILETYPE
when the job did not complete successfully.
- RETURNFILETYPE
-
can be set to ``tif'', ``pdf'', ``ps'', or ``original''. If set,
this causes
notify
to return a copy of the submitted documents to the
SENDER
address along with the notification message. The ``original'' setting
uses the format type that was used in the submission.
- RETURNTECHINFO
-
defaults to ``yes'' and is used to indicate whether or not technical
information such as the session parameters should be included with the notification
message. If set to anything other than ``yes'' this information will
not be included.
- RETURNTRANSCRIPT
-
defaults to ``yes'' only on the error conditions noted above and is used to
indicate whether or not the session transcript (log) should be returned with the
notification message.
- NOTIFY_FAXMASTER
-
is used to deliver a notification message to
TOADDR
(which defaults to ``FaxMaster'') that contains technical information
about the job. This is useful in allowing the administrator to be aware of
any problems before those problems are reported by the users.
Possible settings are ``yes'', ``always'', ``no'', ``never'', and ``errors''.
If ``errors'' is used then the notification message is only sent to FaxMaster
when the job experienced an error. The default is ``no''.
FILES
${SPOOL} spooling area
${SENDMAIL} for delivering mail
SEE ALSO
faxq(1m),
hylafax-server(4f),
sendq(4f)
Index
- NAME
-
- SYNOPSIS
-
- DESCRIPTION
-
- NOTES
-
- FILES
-
- SEE ALSO
-
This document was created by
man2html,
using the manual pages.
Time: 01:00:11 GMT, December 17, 2005