CYR_VIRUSSCAN(8)

NAME
cyr_virusscan - Cyrus IMAP documentation

Scan mailbox(es) or messages for viruses using configured virus scanner or provided search criteria.

SYNOPSIS

cyr_virusscan [ -C config-file ] [ -s imap-search-string ] [ -r [ -n] ] [-v] [ mboxpattern1 ... ]

DESCRIPTION

cyr_virusscan is used to scan the specified IMAP mailbox(es) with the configured virus scanner (currently only ClamAV is supported). If no mboxpattern is given, cyr_virusscan works on all mailboxes.

Alternately, with the -s option, rather than scanning mailboxes for virus, the IMAP SEARCH string will be used as a specification of messages which are assumed to be infected, and will be treated as such. Useful for removing messages without a distinct signature, such as Phish.

A table of infected messages will be output. However, with the remove flag, -r, infected messages will be removed.

With the notify flag, -n, notifications with message digest information will be appended to the inbox of the mailbox owner. This flag is only operable in combination with -r.

cyr_virusscan is may 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{} stanza in cyrus.conf(5).

cyr_virusscan reads its configuration options out of the imapd.conf(5) file unless specified otherwise by -C.

OPTIONS

-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

EXAMPLES

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.

HISTORY

Virus scan support was first introduced in Cyrus version 3.0.

FILES

/etc/imapd.conf

SEE ALSO

imapd.conf(5), master(8)

AUTHOR
The Cyrus Team, Nic Bernstein (Onlight)

COPYRIGHT
1993-2017, The Cyrus Team