Managing IMAP

Batch Account Maintenance with cyradm

cyradm can be invoked in a script to read and evaluate a series of Tcl commands. In batch mode, cyradm command names cannot be abbreviated as they can be in interactive mode (e.g., setaclmailbox cannot be invoked as sam). When running cyradm in non-interactive mode, you will always use one Tcl command that has not been mentioned yet: the command cyradm connect. The cyradm connect command opens an IMAP connection to the server, and it is always the first command you execute in a batch cyradm script.

The usage of the cyradm connect command is:

cyradm connect 
               connectionname

where connectionname is an arbitrary handle that denotes the connection to the IMAP server. Once a connection is established, other cyradm commands are issued as:

connectionname command

The command command is any one of the cyradm commands discussed earlier in the chapter. It may also be one of the following commands that have not yet been introduced:

connectionname servername

Returns the hostname of the server the connection is connected to.

connectionname authenticate

Authenticates the connection. connection authenticate has two command switches, shown in Table 9-4 .

Table 9-4. connection authenticate Command Switches

Switch	Function
-user username	Log in to the Cyrus server as username.
-pwcommand script	Perform a plaintext password login. script must consist of Tcl commands that return the username and password, for example: cyr_conn authenticate –pwcommand { set adminid ...