NOTIFY(8)

✨ NOTIFY(8) ✨

ok so bestie, this is the System Manager's Manual page for notify, and honestly? it's giving "the fax server's little hype-woman who emails you about your job". let's get into it 💖

---

🎀 NAME 🎀

notify — the HylaFAX user notification script. she tells people things. that's the whole gig. 💅

---

🌸 SYNOPSIS 🌸

/var/spool/hylafax/bin/notify qfile why jobtime [ nextTry ]

---

🦋 DESCRIPTION 🦋

bin/notify is the command script that the facsimile server calls up when it needs to notify a user about the status of an outbound job. the default notification script just sends the user an electronic mail describing whatever event or action went down. no cap. 📧

here's what the arguments are, bestie:

• qfile — the pathname of the job description file.
• why — a string that says why the user is being notified in the first place. it's one of these:
  • done — job was completed successfully ¹
  • failed — job was not completed ¹²
  • rejected — job was rejected for specified reasons ¹
  • 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 ¹²
  • blocked — job is blocked by concurrent jobs ³

and the little footnote girlies:

• ¹ A final job state
• ² A transcript of the failed communication is returned to the sender.
• ³ No emails are sent for the block state, the job has been neither requeued nor done, but remains waiting in the queue for the ability to be sent.

• 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 it's present. FaxNotify is sourced after the q-file is parsed and all default values are preset. here are the useful settings for FaxNotify, bestie:

• 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. slay 💅

• 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.
• TEMPLATE — the template subdirectory to use when sending e-mails. HylaFAX ships with a base set of templates, and some direct translations. To use the German translated templates, set TEMPLATE=de in FaxNotify. This is relative to the base template directory.
• 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''.

---

the settings of the user in $notify (read from the sendq job file) controls whether the user will get the notification email. If you want to force notification emails, irregardless of the users selection, or force a blocked notification (which is not sent by default), you can set

notify="always"

which will force the notify script to send the email. periodt. 👑

---

🍓 FILES 🍓

• /var/spool/hylafax — spooling area
• /usr/lib/sendmail — for delivering mail

---

🌈 SEE ALSO 🌈

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

---

ok that's literally the whole page, bestie, no notes, you ate that 🫶

and for the cute sign-off moment: this page is dated May 8, 1996 and comes from the System Manager's Manual, so like… vintage iconic behavior fr fr 💖✨🎀🦋🌸💅