OPTIONS |
Execute commands from script. |
|||
-user user -u user |
Log in to the server as user. Short form of -user user. |
-layers number -l number Short form of -layers prot. -mech mechanism -m mechanism DESCRIPTION If invoked with host, cyradm runs in interactive mode, connecting to host on port port, authenticating, and then reading commands from the standard input and evaluating them. Port defaults to the standard IMAP port. Cyradm runs until the exit command is invoked or until it reaches end-of-file on its standard input. If the file .cyradmrc is in the home directory of the user, cyradm evaluates the file as a Tcl script just before reading the first command from standard input, after connecting and authenticating to server. INTERACTIVE COMMANDS createmailbox mailbox [partition] deletemailbox mailbox Since administrators don't have implicit delete rights on all mailboxes, they may need to use setaclmailbox to renamemailbox mailbox newmailbox [partition] listmailbox [-subscribed] [pattern] [reference] Two wildcard characters are defined in pattern. The ``*'' wildcard matches zero or more characters. The In some cases, where ``%'' is used as the last character of a pattern, non-mailbox names are listed in paren- |
setaclmailbox mailbox identifier rights [identifier rights]...
The setaclmailbox (or sam) command modifies the access control list of the mailbox mailbox. One or more
identifier-rights pairs may be given after mailbox, each sets the ACL for identifier to rights.
Rights may be a set of access right letters:
l r |
lookup (mailbox is visible to LIST/LSUB/UNSEEN commands) read (SELECT the mailbox, perform CHECK, FETCH, PARTIAL, SEARCH, COPY |
||
s w i p c d a |
keep seen/unseen information across sessions (STORE \SEEN flag) write (STORE flags other than \SEEN and \DELETED) insert (perform APPEND, COPY into mailbox) post (send mail to submission address for mailbox) create (CREATE new sub-mailboxes in any implementation-defined hierarchy) delete (STORE \DELETED flag, perform EXPUNGE) administer (perform SETACL) |
or one of the following words:
none read post append write all |
"" lrs lrsp lrsip lrswipcd lrswipcda |
deleteaclmailbox mailbox identifier [identifier]...
The deleteaclmailbox (or dam) command modifies the access control list of mailbox. One or more identi-
fiers may be specified, each identifier has its access control entry removed.
listaclmailbox mailbox
The listaclmailbox (or lam) command returns a string containing the access control list of the mailbox mail-
box.
setquota root quota...
The setquota (or sq) command sets the limit on the quota root root to quota. The quota is one of the follow-
ing:
- - |
A single numeric value, limiting the use of storage to that value A list of one or more resource-value pairs, limiting the use of each given resource to the given numeric |
||
- |
none, specifying no limits whatsoever |
listquota root
The listquota (or lq) command returns a string listing the quotas on the quota root root.
listquotaroot mailbox
The listquotaroot (or lqr or lqm) command returns a string listing the quota roots and quotas on the mailbox
mailbox.
quit Same as the Tcl command exit. Close the connection and exit cyradm.
Cyradm adds one command to the standard Tcl command set.
cyradm connect connection [host] [port]
The cyradm connect command opens a connection to host and creates a new Tcl command connection that
may be used to invoke various operations on the connection. Host defaults to connection and port defaults to
the standard IMAP port.
The cyradm connect command returns its connection argument.
connection servername
Returns the name of the host that connection is connected to.
connection authenticate [switches]
Authenticates the connection. Switches are:
-user user -pwcommand script |
Log in to the server as user. Attempt a plaintext password login. The argument is a Tcl script which is executed to obtain the login information--the script must return a list with two elements, the user- name and the password. Before executing the script, the authenticate command will replace %-sequences as follows: |
||
%% %h %u |
replaced with a single % replaced with the hostname of the server replaced with the value of the -user switch, or the empty string if the -user |
||
-layers number -mech mechanism |
Specify allowable protection mechanisms for the connection; see above. Specify the SASL mechanism to use, if not plaintext login. |
connection createmailbox mailbox [partition]
Creates a mailbox on connection. Arguments are the same as for the interactive version of the command.
connection deletemailbox mailbox
Delete a mailbox on connection. Arguments are the same as for the interactive version of the command.
connection renamemailbox mailbox newmailbox [partition]
Renames a mailbox on connection. Arguments are the same as for the interactive version of the command.
connection listmailbox [-subscribed] pattern [reference]
Returns a list describing mailboxes on connection matching pattern. The optional reference argument speci-
fies the reference name relative to which pattern is then interpreted.
The -subscribed switch limits the returned mailboxes to those to which the user has subscribed.
The returned value contains a list with one entry for each matching mailbox. Each entry is a list containing
three elements, the name, a list of mailbox attributes, and the hierarchy delimiter. If there is no hierarchy
delimiter, the third element is the empty string.
connection setaclmailbox mailbox identifier rights [...]
Modifies an access control list on connection. Arguments are the same as for the interactive version of the
command.
connection deleteaclmailbox mailbox identifier [...]
Modifies an access control list on connection. Arguments are the same as for the interactive version of the
command.
connection listaclmailbox mailbox
Returns a list containing the access control list of the mailbox mailbox on connection. The returned list con-
tains alternating identifier right pairs.
connection setquota root [resource limit]...
Sets the limit on the quota root root on connection. Zero or more resource limit pairs may be specified, spec-
ifying the limit for each resource.
connection listquota root
Returns a list containing the quotas of the quota root root on connection. The returned list contains zero or
more resource usage limit triplets.
connection listquotaroot mailbox
Returns a list containing the quota roots and quotas on the mailbox mailbox on connection. The returned list
contains zero or more sublists; each sublist contains the name of a quota root followed by zero or more
resource usage limit triplets.