Provided by: hylafax-server_4.4.3-1_i386 bug

NAME

       notify - HylaFAX user notification script

SYNOPSIS

       /var/spool/hylafax/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               ¹       job was not completed
                 rejected                     job was rejected for specified reasons
                 blocked                      job is blocked by concurrent jobs
                 requeued            ¹        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       ¹        a polling request was rejected by the remote side
                 poll_no_document    ¹        a polling request failed because nothing was available
                 poll_failed         ¹        a polling request failed for an unknown reason
                 ¹ 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.   Multiple values may be specified by
              separating  them  with  whitespace.  In  that  case  a  separate
              attachment is created for each filetype.

       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’’ and is used to indicate whether or  not  the
              session   transcript   (log)   should   be   returned  with  the
              notification message on the error conditions noted above.

       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

       /var/spool/hylafax    spooling area
       /usr/sbin/sendmail    for delivering mail

SEE ALSO

       faxq(8), hylafax-server(5), sendq(5)

                                  May 8, 1996                        NOTIFY(8)