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

NAME

6       arbitron - Cyrus IMAP documentation
7
8       Report readership statistics for mailboxes on the server.
9

SYNOPSIS

11          arbitron [ -C config-file ] [ -o ] [ -u ] [ -l ] [ -p months ]
12                   [ -d days | -D mmddyyyy[:mmddyyyy] ] mailbox...
13

DESCRIPTION

15       arbitron  collects  and  reports readership statistics for mailboxes on
16       the server. It also optionally prunes the mailboxes of \Seen state  for
17       dormant users.
18
19       arbitron produces one line of output per mailbox, reporting the mailbox
20       name followed by a space, followed by the number of readers (and if  -u
21       is  specified,  followed  by  a colon and a comma-separated list of the
22       reader's user IDs), and if -o is not specified, another space  and  the
23       number  of subscribers (and if -u is specified, followed by a colon and
24       a comma-separated list of the subscribers userids).
25
26       IMPORTANT:
27          This format is subject to change in future versions.
28
29       Each "reader" is  a  distinct  authorization  identity  which  has  the
30       imap-admin-access-control-right-s  right  to  the mailbox and which has
31       SELECTed the mailbox within either the past -d days or the specified -D
32       date[:range].
33
34       Users  are  not  counted as reading their own personal mail‐boxes. Per‐
35       sonal mailboxes are not reported unless there is at  least  one  reader
36       other than the mailboxes owner.
37
38       arbitron  reads its configuration options out of the imapd.conf(5) file
39       unless specified otherwise by -C.
40

OPTIONS

42       -C config-file
43              Use the specified configuration file config-file rather than the
44              default imapd.conf(5).
45
46       -D mmddyyyy[:mmddyyyy], --date=mmddyyyy[:mmddyyyy]
47              Count  as  a reader an authorization identity which has used the
48              mailbox within the given date range.
49
50              The start date and optionally the  end  date  are  specified  as
51              2-digit month of the year, 2-digit day of the month, and 4-digit
52              year.
53
54              If the end date is not specified, the current system  time  will
55              be used as the end time.
56
57              NOTE:
58                 Please note that the date notation is American [mmddyyyy] not
59                 [ddmmyyyy].
60
61       -d days, --days=days
62              Count as a reader an authorization identity which has  used  the
63              mailbox within the past days days.
64
65       -l, --detailed
66              Enable long reporting (comma delimited table consisting of mbox,
67              userid, r/s, start time, end time).
68
69       -o, --no-subscribers
70              Report "the old way" -- not including subscribers.
71
72       -p months, --prune-seen=months
73              Prune \Seen state for users who have not used the mailbox within
74              the past months months. The default is infinity.
75
76       -u, --include-userids
77              Include userids of mailbox readers in the report.  If the report
78              will contain mailbox subscribers  (see  --no-subscribers),  also
79              include userids of the subscribers.
80

EXAMPLES

82          arbitron -l
83          Long-format list.
84
85          arbitron -o
86          Old format (no subscribers) short list.
87
88          arbitron
89          Normal short list.
90
91          arbitron -d 14
92          Normal short list format for the past 14 days.
93
94          arbitron -D 04012015:04152015
95          Normal short list Within date range of 12 - 15 April, 2015.
96

FILES

98       /etc/imapd.conf
99

SEE ALSO

101       imapd.conf(5)
102

AUTHOR

104       The Cyrus Team, Nic Bernstein (Onlight), Jeroen van Meeuwen (Kolab Sys‐
105       tems)
106

108       1993–2023, The Cyrus Team
109
110
111
112
1133.8.1                            Sep 11, 2023                      ARBITRON(8)
Impressum