| 1 |
.. cyrusman:: notifyd(8) |
| 2 |
|
| 3 |
.. author: Nic Bernstein (Onlight) |
| 4 |
|
| 5 |
.. _imap-reference-manpages-systemcommands-notifyd: |
| 6 |
|
| 7 |
=========== |
| 8 |
**notifyd** |
| 9 |
=========== |
| 10 |
|
| 11 |
Cyrus notification server |
| 12 |
|
| 13 |
Synopsis |
| 14 |
======== |
| 15 |
|
| 16 |
.. parsed-literal:: |
| 17 |
|
| 18 |
**notifyd** [ **-C** *config-file* ] [ **-U** *uses* ] [ **-T** *timeout* ] [ **-D** ] |
| 19 |
|
| 20 |
Description |
| 21 |
=========== |
| 22 |
|
| 23 |
**notifyd** is a daemon started from :cyrusman:`master(8)` that handles |
| 24 |
notification requests on behalf of :cyrusman:`lmtpd(8)`. **Notifyd** |
| 25 |
accepts the request and performs the notification using the method |
| 26 |
specified in the request. |
| 27 |
|
| 28 |
Note that for **notifyd** to run properly you must set ``proto=udp`` in |
| 29 |
its :cyrusman:`cyrus.conf(5)` services entry. ``prefork=1`` is also |
| 30 |
recommended. |
| 31 |
|
| 32 |
**notifyd** |default-conf-text| |
| 33 |
|
| 34 |
``notifysocket`` option is used to specify the Unix domain socket to |
| 35 |
listen on for notifications. |
| 36 |
|
| 37 |
Options |
| 38 |
======= |
| 39 |
|
| 40 |
.. program:: notifyd |
| 41 |
|
| 42 |
.. option:: -C config-file |
| 43 |
|
| 44 |
|cli-dash-c-text| |
| 45 |
|
| 46 |
.. option:: -U uses |
| 47 |
|
| 48 |
The maximum number of times that the process should be used for new |
| 49 |
connections before shutting down. The default is 250. |
| 50 |
|
| 51 |
.. option:: -T timeout |
| 52 |
|
| 53 |
The number of seconds that the process will wait for a new |
| 54 |
connection before shutting down. Note that a value of 0 (zero) |
| 55 |
will disable the timeout. The default is 60. |
| 56 |
|
| 57 |
.. option:: -D |
| 58 |
|
| 59 |
Run external debugger specified in debug_command. |
| 60 |
|
| 61 |
NOTIFICATION METHODS |
| 62 |
==================== |
| 63 |
|
| 64 |
**null** |
| 65 |
|
| 66 |
Ignore the notification request. |
| 67 |
|
| 68 |
**log** |
| 69 |
|
| 70 |
Log the notification to syslog (for testing). |
| 71 |
|
| 72 |
**mailto** |
| 73 |
|
| 74 |
Email the notification. This method can ONLY be used in a |
| 75 |
Sieve 'notify' action as it requires a *mailto:* URL to be |
| 76 |
specified as an *:option*. |
| 77 |
|
| 78 |
**zephyr** |
| 79 |
|
| 80 |
Send the notification as a zephyrgram. If used in a Sieve 'notify' |
| 81 |
action, additional recipients can be specified as *:options*. |
| 82 |
|
| 83 |
**external** |
| 84 |
|
| 85 |
Send the notification via an external program. The path to the |
| 86 |
program is specified using the *notify_external* option in the |
| 87 |
configuration file. |
| 88 |
|
| 89 |
Files |
| 90 |
===== |
| 91 |
|
| 92 |
/etc/imapd.conf, |
| 93 |
/etc/cyrus.conf |
| 94 |
|
| 95 |
See Also |
| 96 |
======== |
| 97 |
|
| 98 |
:cyrusman:`imapd.conf(5)`, |
| 99 |
:cyrusman:`cyrus.conf(5)` |