1CYR_VIRUSSCAN(8)                  Cyrus IMAP                  CYR_VIRUSSCAN(8)
2
3
4

NAME

6       cyr_virusscan - Cyrus IMAP documentation
7
8       Scan for viruses using configured virus scanner or manage infected mes‐
9       sages using search criteria.
10

SYNOPSIS

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

DESCRIPTION

15       cyr_virusscan can be used to invoke an  external  virus  scanner  (cur‐
16       rently  only  ClamAV is supported) to scan specified IMAP mailboxes. If
17       no mboxpattern is given, cyr_virusscan works on all mailboxes.
18
19       Alternately, with the -s option, the IMAP SEARCH string will be used as
20       a  specification of messages which are assumed to be infected, and will
21       be treated as such.  The virus  scanner  is  not  invoked.  Useful  for
22       removing messages without a distinct signature, such as Phish.
23
24       A table of infected messages will be output.
25
26       To remove infected messages, use the -r flag. Infected messages will be
27       expunged from the user's mailbox.
28
29       With the notify flag, -n, notifications will be appended to  the  inbox
30       of  the  mailbox  owner,  containing message digest information for the
31       affected mail.  This flag is only works in combination with -r.
32
33       cyr_virusscan can be configured to  run  periodically  by  cron(8)  via
34       crontab(5) or your preferred method (i.e. /etc/cron.hourly), or by mas‐
35       ter(8) via the EVENTS{} section in cyrus.conf(5).
36
37       cyr_virusscan reads its configuration options out of the  imapd.conf(5)
38       file unless specified otherwise by -C.
39
40       Note  that  Cyrus  does  not  ship with any virus scanners: you need to
41       install one separately to make use of it with Cyrus.
42

OPTIONS

44       -C config-file
45              Use the specified configuration file config-file rather than the
46              default imapd.conf(5).
47
48       -n     Notify  mailbox  owner of deleted messages via email.  This flag
49              is only operable in combination with -r.
50
51       -r     Remove infected messages.
52
53       -s imap-search-string
54              Rather than scanning for viruses, messages matching  the  search
55              criteria will be treated as infected.
56
57       -v     Produce more verbose output
58

EXAMPLES

60       cyr_virusscan
61          Scan  all  mailboxes,  printing report on the screen.  Do not remove
62          infected messages.
63
64       cyr_virusscan -r -n user/bovik
65          Scan mailbox user/bovik, removing infected messages and append noti‐
66          fications to bovik's inbox.
67
68       cyr_virusscan -r -n -s 'SUBJECT "Fedex"' user/bovik
69          Search  mailbox user/bovik for messages which have Fedex in the sub‐
70          ject line, removing them all, and appending notifications to Bovik's
71          inbox.
72

HISTORY

74       Virus scan support was first introduced in Cyrus version 3.0.
75

FILES

77       /etc/imapd.conf
78

SEE ALSO

80       imapd.conf(5), master(8), ClamAV
81

AUTHOR

83       The Cyrus Team, Nic Bernstein (Onlight)
84

86       1993-2017, The Cyrus Team
87
88
89
90
913.0.13                         December 16, 2019              CYR_VIRUSSCAN(8)
Impressum