cyr_virusscan - Cyrus IMAP documentation
Scan for viruses using configured virus scanner or manage infected messages using search criteria.
cyr_virusscan [ -C config-file ] [ -s imap-search-string ] [ -r [ -n] ] [-v] [ mboxpattern1 ... ]
cyr_virusscan can be used to invoke an external virus scanner (currently only ClamAV is supported) to scan specified IMAP mailboxes. If no mboxpattern is given, cyr_virusscan works on all mailboxes.
Alternately, with the -s option, the IMAP SEARCH string will be used as a specification of messages which are assumed to be infected, and will be treated as such. The virus scanner is not invoked. Useful for removing messages without a distinct signature, such as Phish.
A table of infected messages will be output.
To remove infected messages, use the -r flag. Infected messages will be expunged from the user's mailbox.
With the notify flag, -n, notifications will be appended to the inbox of the mailbox owner, containing message digest information for the affected mail. This flag is only works in combination with -r.
cyr_virusscan can be configured to run periodically by cron(8) via crontab(5) or your preferred method (i.e. /etc/cron.hourly), or by master(8) via the EVENTS{} section in cyrus.conf(5).
cyr_virusscan reads its configuration options out of the imapd.conf(5) file unless specified otherwise by -C.
Note that Cyrus does not ship with any virus scanners: you need to install one separately to make use of it with Cyrus.
-C config-file
Use the specified configuration file config-file rather than the default imapd.conf(5).
-n |
Notify mailbox owner of deleted messages via email. This flag is only operable in combination with -r. | ||
-r |
Remove infected messages. |
-s imap-search-string
Rather than scanning for viruses, messages matching the search criteria will be treated as infected.
-v |
Produce more verbose output |
cyr_virusscan
Scan all mailboxes, printing report on the screen. Do not remove infected messages.
cyr_virusscan -r -n user/bovik
Scan mailbox user/bovik, removing infected messages and append notifications to bovik's inbox.
cyr_virusscan -r -n -s 'SUBJECT "Fedex"' user/bovik
Search mailbox user/bovik for messages which have Fedex in the subject line, removing them all, and appending notifications to Bovik's inbox.
Virus scan support was first introduced in Cyrus version 3.0.
/etc/imapd.conf
imapd.conf(5), master(8), ClamAV
The Cyrus Team, Nic Bernstein (Onlight)
1993-2017, The Cyrus Team