/usr/bin/cyradm is in cyrus-admin-2.4 2.4.17+caldav~beta9-3.
This file is owned by root:root, with mode 0o755.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 | #! /bin/sh
#
# Copyright (c) 1994-2008 Carnegie Mellon University. All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions
# are met:
#
# 1. Redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer.
#
# 2. Redistributions in binary form must reproduce the above copyright
# notice, this list of conditions and the following disclaimer in
# the documentation and/or other materials provided with the
# distribution.
#
# 3. The name "Carnegie Mellon University" must not be used to
# endorse or promote products derived from this software without
# prior written permission. For permission or any legal
# details, please contact
# Carnegie Mellon University
# Center for Technology Transfer and Enterprise Creation
# 4615 Forbes Avenue
# Suite 302
# Pittsburgh, PA 15213
# (412) 268-7393, fax: (412) 268-7395
# innovation@andrew.cmu.edu
#
# 4. Redistributions of any form whatsoever must retain the following
# acknowledgment:
# "This product includes software developed by Computing Services
# at Carnegie Mellon University (http://www.cmu.edu/computing/)."
#
# CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO
# THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
# AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
# FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
# AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
# OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
#
# $Id: cyradm.sh,v 1.21 2010/01/06 17:01:55 murch Exp $
INCS=
SITEARCH="/usr/local/lib/perl/5.18.2"
if [ -n "$SITEARCH" -a -d "$SITEARCH" ]; then
INCS="-I$SITEARCH"
fi
case "x$BASH_VERSION" in
x) exec perl $INCS -MCyrus::IMAP::Shell -e shell -- ${1+"$@"} ;;
*) exec perl $INCS -MCyrus::IMAP::Shell -e shell -- "$@" ;;
esac
echo "$0: how did I get here?" >&2
exit 1
=head1 NAME
cyradm - Cyrus administration shell, alter ego of Cyrus::IMAP::Shell
=head1 SYNOPSIS
$ cyradm [--user user] [--[no]rc] [--systemrc file] [--userrc file] \
> [--port n] [--auth mechanism] [--tlskey keyfile] [--notls] \
> [--server] server
but possibly
$ perl -MCyrus::IMAP::Shell -e 'run("myscript")'
or even (not recommended)
use Cyrus::IMAP::Admin::Shell;
run('myscriptname');
=head1 DESCRIPTION
This module implements B<cyradm> in Perl. It is a shell around
L<Cyrus::IMAP::Admin>. Commands are provided in both Tcl-compatible
forms and GNU-style long option forms.
=head1 COMMANDS
=over 4
=item C<authenticate> [C<--minssf> I<N>] [C<--maxssf> I<N>] [C<--mechanisms> I<list>] [I<user>]
=item C<auth> [C<--minssf> I<N>] [C<--maxssf> I<N>] [C<--mechanisms> I<list>] [I<user>]
=item C<login> [C<--minssf> I<N>] [C<--maxssf> I<N>] [C<--mechanisms> I<list>] [I<user>]
Authenticate to server. You must already be connected to a server and
Cyrus imapd will refuse to allow you to re-authenticate once you have
authenticated once.
=item C<chdir> I<directory>
=item C<cd> I<directory>
Change directory. A C<pwd> builtin is not provided, but the default command
action will run C<pwd> from a shell if invoked.
=item C<createmailbox> [C<--partition> I<partition>] I<mailbox>
=item C<createmailbox> I<mailbox> I<partition>
=item C<create> [C<--partition> I<partition>] I<mailbox>
=item C<create> I<mailbox> I<partition>
=item C<cm> [C<--partition> I<partition>] I<mailbox>
=item C<cm> I<mailbox> I<partition>
Create a mailbox on the default or a specified partition. Both old-style
and getopt-style usages are accepted (combining them will produce an error).
=item C<deleteaclmailbox> I<mailbox> I<id> [...]
=item C<deleteacl> I<mailbox> I<id> [...]
=item C<dam> I<mailbox> I<id> [...]
Remove ACLs from the specified mailbox.
=item C<deletemailbox> I<mailbox>
=item C<delete> I<mailbox>
=item C<dm> I<mailbox>
Delete the specified mailbox.
Administrators do not have implicit delete rights on mailboxes. Use the
B<setaclmailbox> command to grant the C<x> permission to your
principal if you need to delete a mailbox you do not own.
Note that the online help admits to an optional host argument. This argument
is not currently used, and will be rejected with an error if specified; it
is reserved for IMSP.
=item C<disconnect>
=item C<disc>
Disconnect from the current server. The prompt will revert to C<cyradmE<gt>>.
=item C<exit> [I<number>]
=item C<quit> [I<number>]
Exit B<cyradm>, optionally with a specific exit status; the exit status of the
last command will be used if one is not specified.
=item help [command]
=item ? [command]
Show help for C<command> or all commands.
=item C<info> [I<mailbox>]
Display the mailbox/server metadata.
=item C<listaclmailbox> I<mailbox>
=item C<listacl> I<mailbox>
=item C<lam> I<mailbox>
List ACLs on the specified mailbox.
=item C<listmailbox> [C<--subscribed>] [I<pattern> [I<reference>]]
=item C<list> [C<--subscribed>] [I<pattern> [I<reference>]]
=item C<lm> [C<--subscribed>] [I<pattern> [I<reference>]]
List all, or all subscribed, mailboxes matching the specified pattern.
The pattern may have embedded wildcards C<'*'> or C<'%'>, which match
anything or anything except the separator character, respectively.
Mailboxes returned will be relative to the specified reference if one
is specified. This allows a mailbox list to be limited to a particular
hierarchy.
In some cases when the C<'%'> wildcard is used to end a pattern, it may
match an entry which is not a mailbox but which contains other mailboxes.
In this case, the entry will be parenthesized to indicate that it is a
root for other mailboxes, as opposed to a mailbox itself.
=item C<listquota> I<root>
=item C<lq> I<root>
List quotas on specified root. If the specified mailbox path does not have
a quota assigned, an error will be raised; see I<listquotaroot> for a way to
find the quota root for a mailbox.
=item C<listquotaroot> I<mailbox>
=item C<lqm> I<mailbox>
=item C<lqr> I<mailbox?>
show quota roots and quotas for mailbox
=item C<mboxconfig> I<mailbox> I<attribute> I<value>
=item C<mboxcfg> I<mailbox> I<attribute> I<value>
Set mailbox metadata. A value of "none" will remove the attribute.
The currently supported attributes are:
=over 4
=item C<comment>
Sets a comment or description associated with the mailbox.
=item C<expire>
Sets the number of days after which messages will be expired from the mailbox.
=item C<news2mail>
Sets an email address to which messages injected into the server via NNTP
will be sent.
=item C<sharedseen>
Enables the use of a shared \Seen flag on messages rather than a
per-user \Seen flag. The 's' right in the mailbox ACL still controls
whether a user can set the shared \Seen flag.
=item C<sieve>
Indicates the name of the global sieve script that should be run when
a message is delivered to the shared mailbox (not used for personal
mailboxes).
=item C<squat>
Indicates that the mailbox should have a squat index created for it.
=item C</explicit/annotation>
Sets the annotation I</explicit/annotation> on I<mailbox> to I<value>.
=back
=item C<renamemailbox> [C<--partition> I<partition>] I<oldname> I<newname>
=item C<rename> [C<--partition> I<partition>] I<oldname> I<newname>
=item C<renm> [C<--partition> I<partition>] I<oldname> I<newname>
=item C<renamemailbox> I<oldname> I<newname> [I<partition>]
=item C<rename> I<oldname> I<newname> [I<partition>]
=item C<renm> I<oldname> I<newname> [I<partition>]
Rename the specified mailbox, optionally moving it to a different partition.
Both old-style and getopt-style usages are accepted; combining them will
produce an error.
=item server [--noauthenticate] [server]
=item connect [--noauthenticate] [server]
=item servername [--noauthenticate] [server]
With no arguments, show the current server. With an argument, connect to that
server. It will prompt for automatic login unless the C<--noauthenticate>
option is specified. (This may change; in particular, either automatic
authentication will be removed or all C<authenticate> options will be added.)
When connected to a server, B<cyradm>'s prompt changes from C<cyradmE<gt>> to
C<servernameE<gt>>, where I<servername> is the fully qualified domain name
of the connected server.
=item C<setaclmailbox> I<mailbox> I<id> I<rights> [I<id> I<rights> ...]
=item C<setacl> I<mailbox> I<id> I<rights> [I<id> I<rights> ...]
=item C<sam> I<mailbox> I<id> I<rights> [I<id> I<rights> ...]
Set ACLs on a mailbox. The ACL may be one of the special strings C<none>,
C<read> (C<lrs>), C<post> (C<lrsp>), C<append> (C<lrsip>), C<write>
(C<lrswipkxte>), C<delete> (C<lrxte>), or C<all> (C<lrswipkxte>), or
any combinations of the ACL codes:
=over 4
=item l
Lookup (mailbox is visible to LIST/LSUB, SUBSCRIBE mailbox)
=item r
Read (SELECT/EXAMINE the mailbox, perform STATUS)
=item s
Seen (set/clear \SEEN flag via STORE, also set \SEEN flag during
APPEND/COPY/FETCH BODY[...])
=item w
Write flags other than \SEEN and \DELETED
=item i
Insert (APPEND, COPY destination)
=item p
Post (send mail to mailbox)
=item k
Create mailbox (CREATE new sub-mailboxes, parent for new mailbox in RENAME)
=item x
Delete mailbox (DELETE mailbox, old mailbox name in RENAME)
=item t
Delete messages (set/clear \DELETED flag via STORE, also set \DELETED
flag during APPEND/COPY)
=item e
Perform EXPUNGE and expunge as part of CLOSE
=item a
Administer (SETACL/DELETEACL/GETACL/LISTRIGHTS)
=back
=item C<setinfo> I<attribute> I<value>
Set server metadata. A value of "none" will remove the attribute.
The currently supported attributes are:
=over 4
=item C<motd>
Sets a "message of the day". The message gets displayed as an ALERT after
authentication.
=item C<comment>
Sets a comment or description associated with the server.
=item C<admin>
Sets the administrator email address for the server.
=item C<shutdown>
Sets a shutdown message. The message gets displayed as an ALERT and
all users are disconnected from the server (subsequent logins are disallowed).
=item C<expire>
Sets the number of days after which messages will be expired from the
server (unless overridden by a mailbox annotation).
=item C<squat>
Indicates that all mailboxes should have a squat indexes created for
them (unless overridden by a mailbox annotation).
=back
=item C<setquota> I<root> I<resource> I<value> [I<resource> I<value> ...]
=item C<sq> I<root> I<resource> I<value> [I<resource> I<value> ...]
Set a quota on the specified root, which may or may not be an actual mailbox.
The only I<resource> understood by B<Cyrus> is C<STORAGE>. The I<value> may
be the special string C<none> which will remove the quota.
=item C<version>
=item C<ver>
Display the version info of the current server.
=item C<xfermailbox> [C<--partition> I<partition>] I<mailbox> I<server>
=item C<xfer> [C<--partition> I<partition>] I<mailbox> I<server>
=item C<xfermailbox> I<mailbox> I<server> [I<partition>]
=item C<xfer> I<mailbox> I<server> [I<partition>]
Transfer (relocate) the specified mailbox to a different server.
Both old-style and getopt-style usages are accepted; combining them will
produce an error.
=back
=head1 NOTES
GNU-style long options must be given in their entirety; Tcl-style options
may be abbreviated.
Tcl-style options are provided as a compatibility feature. They will
probably go away in the future.
Multiple commands can be given on a line, separated by C<';'> characters.
All commands set an exit status, which at present is not useful.
Unknown commands are passed to a subshell for execution.
The Tcl version of B<cyradm> is used for scripting as well as interactively.
While this is possible to a limited extent by use of the C<run> method,
scripting would normally be done with C<Cyrus::IMAP::Admin>, which is far
more flexible than either interactive C<cyradm> or the Tcl scripting
mechanism for Cyrus.
B<cyradm> understands B</bin/sh>-style redirection: any command can have
its standard or error output redirected, with all B<sh>-style redirections
(except C<E<lt>E<gt>>) supported. It does not currently understand pipes
or backgrounding.
If the C<Term::Readline::Perl> or C<Term::Readline::GNU> modules are
available, B<cyradm> will use it.
An alias facility is implemented internally, but no access is currently
provided to it. This will change, if only to allow some of the predefined
aliases to be removed if they conflict with useful shell commands.
=head1 AUTHOR
Brandon S. Allbery, allbery@ece.cmu.edu
=head1 SEE ALSO
Cyrus::IMAP::Admin
Term::ReadLine
sh(1), perl(1), imapd(8).
=cut
|