~ubuntu-branches/ubuntu/karmic/cyrus-imapd-2.2/karmic

<DT><A NAME="item_authenticate_%5B%2D%2Dminssf_N%5D_%5B%2D%2Dmaxssf_"><CODE>authenticate</CODE> [<CODE>--minssf</CODE> N] [<CODE>--maxssf</CODE> N] [<CODE>--mechanisms</CODE> list] [user]</A>

<DD>

<DT><A NAME="item_auth_%5B%2D%2Dminssf_N%5D_%5B%2D%2Dmaxssf_N%5D_%5B"><CODE>auth</CODE> [<CODE>--minssf</CODE> N] [<CODE>--maxssf</CODE> N] [<CODE>--mechanisms</CODE> list] [user]</A>

<DD>

<DT><A NAME="item_login_%5B%2D%2Dminssf_N%5D_%5B%2D%2Dmaxssf_N%5D_%5"><CODE>login</CODE> [<CODE>--minssf</CODE> N] [<CODE>--maxssf</CODE> N] [<CODE>--mechanisms</CODE> list] [user]</A>

<DD>

Authenticate to server. You must already be connected to a server and

> [--port n] [--auth mechanism] [--server] server</pre>

but possibly

<pre>

$ perl -MCyrus::IMAP::Shell -e 'run("myscript")'</pre>

or even (not recommended)

<pre>

use Cyrus::IMAP::Admin::Shell;</pre>

<pre>

run('myscriptname');</pre>

<hr />

<h1><a name="description">DESCRIPTION</a></h1>

This module implements cyradm in Perl. It is a shell around

<a href="/Cyrus/IMAP/Admin.html">the Cyrus::IMAP::Admin manpage</a>. Commands are provided in both Tcl-compatible

forms and GNU-style long option forms.

<hr />

<h1><a name="commands">COMMANDS</a></h1>

<dl>

<dt><a name="item_authenticate__5b_2d_2dminssf_n_5d__5b_2d_2dmaxssf_"><code>authenticate</code> [<code>--minssf</code> N] [<code>--maxssf</code> N] [<code>--mechanisms</code> list] [user]</a>

<dt><a name="item_auth__5b_2d_2dminssf_n_5d__5b_2d_2dmaxssf_n_5d__5b"><code>auth</code> [<code>--minssf</code> N] [<code>--maxssf</code> N] [<code>--mechanisms</code> list] [user]</a>

<dt><a name="item_login__5b_2d_2dminssf_n_5d__5b_2d_2dmaxssf_n_5d__5"><code>login</code> [<code>--minssf</code> N] [<code>--maxssf</code> N] [<code>--mechanisms</code> list] [user]</a>

<dd>

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.

<DT><A NAME="item_chdir_directory"><CODE>chdir</CODE> directory</A>

<DD>

<DT><A NAME="item_cd_directory"><CODE>cd</CODE> directory</A>

<DD>

Change directory. A <CODE>pwd</CODE> builtin is not provided, but the default command

action will run <CODE>pwd</CODE> from a shell if invoked.

<DT><A NAME="item_createmailbox_%5B%2D%2Dpartition_partition%5D_mail"><CODE>createmailbox</CODE> [<CODE>--partition</CODE> partition] mailbox</A>

<DD>

<DT><A NAME="item_createmailbox_mailbox_partition"><CODE>createmailbox</CODE> mailbox partition</A>

<DD>

<DT><A NAME="item_create_%5B%2D%2Dpartition_partition%5D_mailbox"><CODE>create</CODE> [<CODE>--partition</CODE> partition] mailbox</A>

<DD>

<DT><A NAME="item_create_mailbox_partition"><CODE>create</CODE> mailbox partition</A>

<DD>

<DT><A NAME="item_cm_%5B%2D%2Dpartition_partition%5D_mailbox"><CODE>cm</CODE> [<CODE>--partition</CODE> partition] mailbox</A>

<DD>

<DT><A NAME="item_cm_mailbox_partition"><CODE>cm</CODE> mailbox partition</A>

<DD>

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).

<DT><A NAME="item_deleteaclmailbox_mailbox_id_%5B%2E%2E%2E%5D"><CODE>deleteaclmailbox</CODE> mailbox id [...]</A>

<DD>

<DT><A NAME="item_deleteacl_mailbox_id_%5B%2E%2E%2E%5D"><CODE>deleteacl</CODE> mailbox id [...]</A>

<DD>

<DT><A NAME="item_dam_mailbox_id_%5B%2E%2E%2E%5D"><CODE>dam</CODE> mailbox id [...]</A>

<DD>

Remove ACLs from the specified mailbox.

<DT><A NAME="item_deletemailbox_mailbox"><CODE>deletemailbox</CODE> mailbox</A>

<DD>

<DT><A NAME="item_delete_mailbox"><CODE>delete</CODE> mailbox</A>

<DD>

<DT><A NAME="item_dm_mailbox"><CODE>dm</CODE> mailbox</A>

<DD>

Delete the specified mailbox.

Administrators do not have implicit delete rights on mailboxes. Use the

100

setaclmailbox command to grant the <A HREF="#item_c"><CODE>c</CODE></A> permission (or other permission

authenticated once.

</dd>

</li>

<dt><a name="item_chdir_directory"><code>chdir</code> directory</a>

<dt><a name="item_cd_directory"><code>cd</code> directory</a>

<dd>

Change directory. A <code>pwd</code> builtin is not provided, but the default command

action will run <code>pwd</code> from a shell if invoked.

</dd>

</li>

<dt><a name="item_createmailbox__5b_2d_2dpartition_partition_5d_mail"><code>createmailbox</code> [<code>--partition</code> partition] mailbox</a>

<dt><a name="item_createmailbox_mailbox_partition"><code>createmailbox</code> mailbox partition</a>

<dt><a name="item_create__5b_2d_2dpartition_partition_5d_mailbox"><code>create</code> [<code>--partition</code> partition] mailbox</a>

<dt><a name="item_create_mailbox_partition"><code>create</code> mailbox partition</a>

<dt><a name="item_cm__5b_2d_2dpartition_partition_5d_mailbox"><code>cm</code> [<code>--partition</code> partition] mailbox</a>

<dt><a name="item_cm_mailbox_partition"><code>cm</code> mailbox partition</a>

<dd>

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).

</dd>

</li>

<dt><a name="item_deleteaclmailbox_mailbox_id__5b_2e_2e_2e_5d"><code>deleteaclmailbox</code> mailbox id [...]</a>

<dt><a name="item_deleteacl_mailbox_id__5b_2e_2e_2e_5d"><code>deleteacl</code> mailbox id [...]</a>

100

101

<dt><a name="item_dam_mailbox_id__5b_2e_2e_2e_5d"><code>dam</code> mailbox id [...]</a>

102

103

<dd>

104

Remove ACLs from the specified mailbox.

105

</dd>

106

</li>

107

<dt><a name="item_deletemailbox_mailbox"><code>deletemailbox</code> mailbox</a>

108

109

<dt><a name="item_delete_mailbox"><code>delete</code> mailbox</a>

110

111

<dt><a name="item_dm_mailbox"><code>dm</code> mailbox</a>

112

113

<dd>

114

Delete the specified mailbox.

115

</dd>

116

<dd>

117

Administrators do not have implicit delete rights on mailboxes. Use the

118

setaclmailbox command to grant the <a href="#item_c"><code>c</code></a> permission (or other permission

101

119

as specified by the deleteright configuration option in imapd.conf)

102

to your principal if you need to delete a mailbox you do not own.

103

Note that the online help admits to an optional host argument. This argument

120

to your principal if you need to delete a mailbox you do not own.

121

</dd>

122

<dd>

123

Note that the online help admits to an optional host argument. This argument

104

124

is not currently used, and will be rejected with an error if specified; it

105

is reserved for IMSP.

106

107

<DT><A NAME="item_disconnect"><CODE>disconnect</CODE></A>

108

<DD>

109

110

<DD>

111

Disconnect from the current server. The prompt will revert to <CODE>cyradm></CODE>.

112

113

<DT><A NAME="item_exit_%5Bnumber%5D"><CODE>exit</CODE> [number]</A>

114

<DD>

115

<DT><A NAME="item_quit_%5Bnumber%5D"><CODE>quit</CODE> [number]</A>

116

<DD>

117

Exit cyradm, optionally with a specific exit status; the exit status of the

118

last command will be used if one is not specified.

119

120

<DT><A NAME="item_help_%5Bcommand%5D">help [command]</A>

121

<DD>

122

<DT><A NAME="item_%3F_%5Bcommand%5D">? [command]</A>

123

<DD>

124

Show help for <CODE>command</CODE> or all commands.

125

126

<DT><A NAME="item_info_%5Bmailbox%5D"><CODE>info</CODE> [mailbox]</A>

127

<DD>

128

Display the mailbox/server metadata.

129

130

<DT><A NAME="item_listaclmailbox_mailbox"><CODE>listaclmailbox</CODE> mailbox</A>

131

<DD>

132

<DT><A NAME="item_listacl_mailbox"><CODE>listacl</CODE> mailbox</A>

133

<DD>

134

<DT><A NAME="item_lam_mailbox"><CODE>lam</CODE> mailbox</A>

135

<DD>

136

List ACLs on the specified mailbox.

137

138

<DT><A NAME="item_listmailbox_%5B%2D%2Dsubscribed%5D_%5Bpattern_%5Br"><CODE>listmailbox</CODE> [<CODE>--subscribed</CODE>] [pattern [reference]]</A>

139

<DD>

140

<DT><A NAME="item_list_%5B%2D%2Dsubscribed%5D_%5Bpattern_%5Breferenc"><CODE>list</CODE> [<CODE>--subscribed</CODE>] [pattern [reference]]</A>

141

<DD>

142

<DT><A NAME="item_lm_%5B%2D%2Dsubscribed%5D_%5Bpattern_%5Breference%"><CODE>lm</CODE> [<CODE>--subscribed</CODE>] [pattern [reference]]</A>

143

<DD>

144

List all, or all subscribed, mailboxes matching the specified pattern.

145

The pattern may have embedded wildcards <CODE>'*'</CODE> or <CODE>'%'</CODE>, which match

146

anything or anything except the separator character, respectively.

147

Mailboxes returned will be relative to the specified reference if one

125

is reserved for IMSP.

126

</dd>

127

</li>

128

<dt><a name="item_disconnect"><code>disconnect</code></a>

129

130

131

132

<dd>

133

Disconnect from the current server. The prompt will revert to <code>cyradm></code>.

134

</dd>

135

</li>

136

<dt><a name="item_exit__5bnumber_5d"><code>exit</code> [number]</a>

137

138

<dt><a name="item_quit__5bnumber_5d"><code>quit</code> [number]</a>

139

140

<dd>

141

Exit cyradm, optionally with a specific exit status; the exit status of the

142

last command will be used if one is not specified.

143

</dd>

144

</li>

145

<dt><a name="item_help__5bcommand_5d">help [command]</a>

146

147

<dt><a name="item__3f__5bcommand_5d">? [command]</a>

148

149

<dd>

150

Show help for <code>command</code> or all commands.

151

</dd>

152

</li>

153

<dt><a name="item_info__5bmailbox_5d"><code>info</code> [mailbox]</a>

154

155

<dd>

156

Display the mailbox/server metadata.

157

</dd>

158

</li>

159

<dt><a name="item_listaclmailbox_mailbox"><code>listaclmailbox</code> mailbox</a>

160

161

<dt><a name="item_listacl_mailbox"><code>listacl</code> mailbox</a>

162

163

<dt><a name="item_lam_mailbox"><code>lam</code> mailbox</a>

164

165

<dd>

166

List ACLs on the specified mailbox.

167

</dd>

168

</li>

169

<dt><a name="item_listmailbox__5b_2d_2dsubscribed_5d__5bpattern__5br"><code>listmailbox</code> [<code>--subscribed</code>] [pattern [reference]]</a>

170

171

<dt><a name="item_list__5b_2d_2dsubscribed_5d__5bpattern__5breferenc"><code>list</code> [<code>--subscribed</code>] [pattern [reference]]</a>

172

173

<dt><a name="item_lm__5b_2d_2dsubscribed_5d__5bpattern__5breference_"><code>lm</code> [<code>--subscribed</code>] [pattern [reference]]</a>

174

175

<dd>

176

List all, or all subscribed, mailboxes matching the specified pattern.

177

The pattern may have embedded wildcards <code>'*'</code> or <code>'%'</code>, which match

178

anything or anything except the separator character, respectively.

179

</dd>

180

<dd>

181

Mailboxes returned will be relative to the specified reference if one

148

182

is specified. This allows a mailbox list to be limited to a particular

149

hierarchy.

150

In some cases when the <CODE>'%'</CODE> wildcard is used to end a pattern, it may

183

hierarchy.

184

</dd>

185

<dd>

186

In some cases when the <code>'%'</code> wildcard is used to end a pattern, it may

151

187

match an entry which is not a mailbox but which contains other mailboxes.

152

188

In this case, the entry will be parenthesized to indicate that it is a

153

root for other mailboxes, as opposed to a mailbox itself.

154

155

<DT><A NAME="item_listquota_root"><CODE>listquota</CODE> root</A>

156

<DD>

157

158

<DD>

159

List quotas on specified root. If the specified mailbox path does not have

160

a quota assigned, an error will be raised; see listquotaroot for a way to

161

find the quota root for a mailbox.

162

163

<DT><A NAME="item_listquotaroot_mailbox"><CODE>listquotaroot</CODE> mailbox</A>

164

<DD>

165

<DT><A NAME="item_lqm_mailbox"><CODE>lqm</CODE> mailbox</A>

166

<DD>

167

<DT><A NAME="item_lqr_mailbox%3F"><CODE>lqr</CODE> mailbox?</A>

168

<DD>

169

show quota roots and quotas for mailbox

170

171

<DT><A NAME="item_mboxconfig_mailbox_attribute_value"><CODE>mboxconfig</CODE> mailbox attribute value</A>

172

<DD>

173

<DT><A NAME="item_mboxcfg_mailbox_attribute_value"><CODE>mboxcfg</CODE> mailbox attribute value</A>

174

<DD>

175

Set mailbox metadata. A value of ``none'' will remove the attribute.

176

The currently supported attributes are:

177

<DL>

178

<DT><A NAME="item_comment"><CODE>comment</CODE></A>

179

<DD>

180

Sets a comment or description associated with the mailbox.

181

182

<DT><A NAME="item_expire"><CODE>expire</CODE></A>

183

<DD>

184

Sets the number of days after which messages will be expired from the mailbox.

185

186

<DT><A NAME="item_squat"><CODE>squat</CODE></A>

187

<DD>

188

Indicates that the mailbox should have a squat index created for it.

189

190

191

<DD>

192

Sets an email address to which messages injected into the server via NNTP

193

will be sent.

194

</DL>

195

<DT><A NAME="item_renamemailbox_%5B%2D%2Dpartition_partition%5D_oldn"><CODE>renamemailbox</CODE> [<CODE>--partition</CODE> partition] oldname newname</A>

196

<DD>

197

<DT><A NAME="item_rename_%5B%2D%2Dpartition_partition%5D_oldname_new"><CODE>rename</CODE> [<CODE>--partition</CODE> partition] oldname newname</A>

198

<DD>

199

<DT><A NAME="item_renm_%5B%2D%2Dpartition_partition%5D_oldname_newna"><CODE>renm</CODE> [<CODE>--partition</CODE> partition] oldname newname</A>

200

<DD>

201

<DT><A NAME="item_renamemailbox_oldname_newname_%5Bpartition%5D"><CODE>renamemailbox</CODE> oldname newname [partition]</A>

202

<DD>

203

<DT><A NAME="item_rename_oldname_newname_%5Bpartition%5D"><CODE>rename</CODE> oldname newname [partition]</A>

204

<DD>

205

<DT><A NAME="item_renm_oldname_newname_%5Bpartition%5D"><CODE>renm</CODE> oldname newname [partition]</A>

206

<DD>

207

Rename the specified mailbox, optionally moving it to a different partition.

189

root for other mailboxes, as opposed to a mailbox itself.

190

</dd>

191

</li>

192

<dt><a name="item_listquota_root"><code>listquota</code> root</a>

193

194

195

196

<dd>

197

List quotas on specified root. If the specified mailbox path does not have

198

a quota assigned, an error will be raised; see listquotaroot for a way to

199

find the quota root for a mailbox.

200

</dd>

201

</li>

202

<dt><a name="item_listquotaroot_mailbox"><code>listquotaroot</code> mailbox</a>

203

204

<dt><a name="item_lqm_mailbox"><code>lqm</code> mailbox</a>

205

206

<dt><a name="item_lqr_mailbox_3f"><code>lqr</code> mailbox?</a>

207

208

<dd>

209

show quota roots and quotas for mailbox

210

</dd>

211

</li>

212

<dt><a name="item_mboxconfig_mailbox_attribute_value"><code>mboxconfig</code> mailbox attribute value</a>

213

214

<dt><a name="item_mboxcfg_mailbox_attribute_value"><code>mboxcfg</code> mailbox attribute value</a>

215

216

<dd>

217

Set mailbox metadata. A value of ``none'' will remove the attribute.

218

The currently supported attributes are:

219

</dd>

220

<dl>

221

<dt><a name="item_comment"><code>comment</code></a>

222

223

<dd>

224

Sets a comment or description associated with the mailbox.

225

</dd>

226

</li>

227

<dt><a name="item_expire"><code>expire</code></a>

228

229

<dd>

230

Sets the number of days after which messages will be expired from the mailbox.

231

</dd>

232

</li>

233

<dt><a name="item_sieve"><code>sieve</code></a>

234

235

<dd>

236

Indicates the name of the global sieve script that should be run when

237

a message is delivered to the shared mailbox (not used for personal

238

mailboxes).

239

</dd>

240

</li>

241

<dt><a name="item_squat"><code>squat</code></a>

242

243

<dd>

244

Indicates that the mailbox should have a squat index created for it.

245

</dd>

246

</li>

247

248

249

<dd>

250

Sets an email address to which messages injected into the server via NNTP

251

will be sent.

252

</dd>

253

</li>

254

</dl>

255

<dt><a name="item_renamemailbox__5b_2d_2dpartition_partition_5d_oldn"><code>renamemailbox</code> [<code>--partition</code> partition] oldname newname</a>

256

257

<dt><a name="item_rename__5b_2d_2dpartition_partition_5d_oldname_new"><code>rename</code> [<code>--partition</code> partition] oldname newname</a>

258

259

<dt><a name="item_renm__5b_2d_2dpartition_partition_5d_oldname_newna"><code>renm</code> [<code>--partition</code> partition] oldname newname</a>

260

261

<dt><a name="item_renamemailbox_oldname_newname__5bpartition_5d"><code>renamemailbox</code> oldname newname [partition]</a>

262

263

<dt><a name="item_rename_oldname_newname__5bpartition_5d"><code>rename</code> oldname newname [partition]</a>

264

265

<dt><a name="item_renm_oldname_newname__5bpartition_5d"><code>renm</code> oldname newname [partition]</a>

266

267

<dd>

268

Rename the specified mailbox, optionally moving it to a different partition.

208

269

Both old-style and getopt-style usages are accepted; combining them will

209

produce an error.

210

211

<DT><A NAME="item_server_%5B%2D%2Dnoauthenticate%5D_%5Bserver%5D">server [--noauthenticate] [server]</A>

212

<DD>

213

<DT><A NAME="item_connect_%5B%2D%2Dnoauthenticate%5D_%5Bserver%5D">connect [--noauthenticate] [server]</A>

214

<DD>

215

<DT><A NAME="item_servername_%5B%2D%2Dnoauthenticate%5D_%5Bserver%5D">servername [--noauthenticate] [server]</A>

216

<DD>

217

With no arguments, show the current server. With an argument, connect to that

218

server. It will prompt for automatic login unless the <CODE>--noauthenticate</CODE>

270

produce an error.

271

</dd>

272

</li>

273

<dt><a name="item_server__5b_2d_2dnoauthenticate_5d__5bserver_5d">server [--noauthenticate] [server]</a>

274

275

<dt><a name="item_connect__5b_2d_2dnoauthenticate_5d__5bserver_5d">connect [--noauthenticate] [server]</a>

276

277

<dt><a name="item_servername__5b_2d_2dnoauthenticate_5d__5bserver_5d">servername [--noauthenticate] [server]</a>

278

279

<dd>

280

With no arguments, show the current server. With an argument, connect to that

281

server. It will prompt for automatic login unless the <code>--noauthenticate</code>

219

282

option is specified. (This may change; in particular, either automatic

220

authentication will be removed or all <CODE>authenticate</CODE> options will be added.)

221

When connected to a server, cyradm's prompt changes from <CODE>cyradm></CODE> to

222

<CODE>servername></CODE>, where servername is the fully qualified domain name

223

of the connected server.

224

225

<DT><A NAME="item_setaclmailbox_mailbox_id_rights_%5Bid_rights_%2E%2"><CODE>setaclmailbox</CODE> mailbox id rights [id rights ...]</A>

226

<DD>

227

<DT><A NAME="item_setacl_mailbox_id_rights_%5Bid_rights_%2E%2E%2E%5D"><CODE>setacl</CODE> mailbox id rights [id rights ...]</A>

228

<DD>

229

<DT><A NAME="item_sam_mailbox_id_rights_%5Bid_rights_%2E%2E%2E%5D"><CODE>sam</CODE> mailbox id rights [id rights ...]</A>

230

<DD>

231

Set ACLs on a mailbox. The ACL may be one of the special strings <CODE>none</CODE>,

232

<CODE>read</CODE> (<CODE>lrs</CODE>), <CODE>post</CODE> (<CODE>lrsp</CODE>), <CODE>append</CODE> (<CODE>lrsip</CODE>), <CODE>write</CODE>

233

(<CODE>lrswipcd</CODE>), or <CODE>all</CODE> (<CODE>lrswipcda</CODE>), or any combinations of the ACL codes:

234

<DL>

235

236

<DD>

237

Lookup (visible to LIST/LSUB/UNSEEN)

238

239

240

<DD>

241

Read (SELECT, CHECK, FETCH, PARTIAL, SEARCH, COPY source)

242

243

244

<DD>

245

Seen (STORE \SEEN)

246

247

248

<DD>

249

Write flags other than \SEEN and \DELETED

250

251

252

<DD>

253

Insert (APPEND, COPY destination)

254

255

256

<DD>

257

Post (send mail to mailbox)

258

259

260

<DD>

261

Create and Delete mailbox (CREATE new sub-mailboxes, RENAME or DELETE mailbox)

262

263

264

<DD>

265

Delete (STORE \DELETED, EXPUNGE)

266

267

268

<DD>

269

Administer (SETACL)

270

</DL>

271

<DT><A NAME="item_setinfo_attribute_value"><CODE>setinfo</CODE> attribute value</A>

272

<DD>

273

Set server metadata. A value of ``none'' will remove the attribute.

274

The currently supported attributes are:

275

<DL>

276

277

<DD>

278

Sets a ``message of the day''. The message gets displayed as an ALERT after

279

authentication.

280

281

<DT><CODE>comment</CODE>

282

<DD>

283

Sets a comment or description associated with the server.

284

285

<DT><A NAME="item_admin"><CODE>admin</CODE></A>

286

<DD>

287

Sets the administrator email address for the server.

288

289

<DT><A NAME="item_shutdown"><CODE>shutdown</CODE></A>

290

<DD>

291

Sets a shutdown message. The message gets displayed as an ALERT and

292

all users are disconnected from the server (subsequent logins are disallowed).

293

294

<DT><CODE>expire</CODE>

295

<DD>

296

Sets the number of days after which messages will be expired from the

297

server (unless overridden by a mailbox annotation).

298

299

<DT><CODE>squat</CODE>

300

<DD>

301

Indicates that all mailboxes should have a squat indexes created for

302

them (unless overridden by a mailbox annotation).

303

</DL>

304

<DT><A NAME="item_setquota_root_resource_value_%5Bresource_value_%2E"><CODE>setquota</CODE> root resource value [resource value ...]</A>

305

<DD>

306

<DT><A NAME="item_sq_root_resource_value_%5Bresource_value_%2E%2E%2E"><CODE>sq</CODE> root resource value [resource value ...]</A>

307

<DD>

308

Set a quota on the specified root, which may or may not be an actual mailbox.

309

The only resource understood by Cyrus is <CODE>STORAGE</CODE>. The value may

310

be the special string <CODE>none</CODE> which will remove the quota.

311

312

<DT><A NAME="item_version"><CODE>version</CODE></A>

313

<DD>

314

315

<DD>

316

Display the version info of the current server.

317

318

<DT><A NAME="item_xfermailbox_%5B%2D%2Dpartition_partition%5D_mailbo"><CODE>xfermailbox</CODE> [<CODE>--partition</CODE> partition] mailbox server</A>

319

<DD>

320

<DT><A NAME="item_xfer_%5B%2D%2Dpartition_partition%5D_mailbox_serve"><CODE>xfer</CODE> [<CODE>--partition</CODE> partition] mailbox server</A>

321

<DD>

322

<DT><A NAME="item_xfermailbox_mailbox_server_%5Bpartition%5D"><CODE>xfermailbox</CODE> mailbox server [partition]</A>

323

<DD>

324

<DT><A NAME="item_xfer_mailbox_server_%5Bpartition%5D"><CODE>xfer</CODE> mailbox server [partition]</A>

325

<DD>

326

Transfer (relocate) the specified mailbox to a different server.

283

authentication will be removed or all <code>authenticate</code> options will be added.)

284

</dd>

285

<dd>

286

When connected to a server, cyradm's prompt changes from <code>cyradm></code> to

287

<code>servername></code>, where servername is the fully qualified domain name

288

of the connected server.

289

</dd>

290

</li>

291

<dt><a name="item_setaclmailbox_mailbox_id_rights__5bid_rights__2e_2"><code>setaclmailbox</code> mailbox id rights [id rights ...]</a>

292

293

<dt><a name="item_setacl_mailbox_id_rights__5bid_rights__2e_2e_2e_5d"><code>setacl</code> mailbox id rights [id rights ...]</a>

294

295

<dt><a name="item_sam_mailbox_id_rights__5bid_rights__2e_2e_2e_5d"><code>sam</code> mailbox id rights [id rights ...]</a>

296

297

<dd>

298

Set ACLs on a mailbox. The ACL may be one of the special strings <code>none</code>,

299

<code>read</code> (<code>lrs</code>), <code>post</code> (<code>lrsp</code>), <code>append</code> (<code>lrsip</code>), <code>write</code>

300

(<code>lrswipcd</code>), or <code>all</code> (<code>lrswipcda</code>), or any combinations of the ACL codes:

301

</dd>

302

<dl>

303

304

305

<dd>

306

Lookup (visible to LIST/LSUB/UNSEEN)

307

</dd>

308

</li>

309

310

311

<dd>

312

Read (SELECT, CHECK, FETCH, PARTIAL, SEARCH, COPY source)

313

</dd>

314

</li>

315

316

317

<dd>

318

Seen (STORE \SEEN)

319

</dd>

320

</li>

321

322

323

<dd>

324

Write flags other than \SEEN and \DELETED

325

</dd>

326

</li>

327

328

329

<dd>

330

Insert (APPEND, COPY destination)

331

</dd>

332

</li>

333

334

335

<dd>

336

Post (send mail to mailbox)

337

</dd>

338

</li>

339

340

341

<dd>

342

Create and Delete mailbox (CREATE new sub-mailboxes, RENAME or DELETE mailbox)

343

</dd>

344

</li>

345

346

347

<dd>

348

Delete (STORE \DELETED, EXPUNGE)

349

</dd>

350

</li>

351

352

353

<dd>

354

Administer (SETACL)

355

</dd>

356

</li>

357

</dl>

358

<dt><a name="item_setinfo_attribute_value"><code>setinfo</code> attribute value</a>

359

360

<dd>

361

Set server metadata. A value of ``none'' will remove the attribute.

362

The currently supported attributes are:

363

</dd>

364

<dl>

365

366

367

<dd>

368

Sets a ``message of the day''. The message gets displayed as an ALERT after

369

authentication.

370

</dd>

371

</li>

372

<dt><code>comment</code>

373

374

<dd>

375

Sets a comment or description associated with the server.

376

</dd>

377

</li>

378

<dt><a name="item_admin"><code>admin</code></a>

379

380

<dd>

381

Sets the administrator email address for the server.

382

</dd>

383

</li>

384

<dt><a name="item_shutdown"><code>shutdown</code></a>

385

386

<dd>

387

Sets a shutdown message. The message gets displayed as an ALERT and

388

all users are disconnected from the server (subsequent logins are disallowed).

389

</dd>

390

</li>

391

<dt><code>expire</code>

392

393

<dd>

394

Sets the number of days after which messages will be expired from the

395

server (unless overridden by a mailbox annotation).

396

</dd>

397

</li>

398

<dt><code>squat</code>

399

400

<dd>

401

Indicates that all mailboxes should have a squat indexes created for

402

them (unless overridden by a mailbox annotation).

403

</dd>

404

</li>

405

</dl>

406

<dt><a name="item_setquota_root_resource_value__5bresource_value__2e"><code>setquota</code> root resource value [resource value ...]</a>

407

408

<dt><a name="item_sq_root_resource_value__5bresource_value__2e_2e_2e"><code>sq</code> root resource value [resource value ...]</a>

409

410

<dd>

411

Set a quota on the specified root, which may or may not be an actual mailbox.

412

The only resource understood by Cyrus is <code>STORAGE</code>. The value may

413

be the special string <code>none</code> which will remove the quota.

414

</dd>

415

</li>

416

<dt><a name="item_version"><code>version</code></a>

417

418

419

420

<dd>

421

Display the version info of the current server.

422

</dd>

423

</li>

424

<dt><a name="item_xfermailbox__5b_2d_2dpartition_partition_5d_mailbo"><code>xfermailbox</code> [<code>--partition</code> partition] mailbox server</a>

425

426

<dt><a name="item_xfer__5b_2d_2dpartition_partition_5d_mailbox_serve"><code>xfer</code> [<code>--partition</code> partition] mailbox server</a>

427

428

<dt><a name="item_xfermailbox_mailbox_server__5bpartition_5d"><code>xfermailbox</code> mailbox server [partition]</a>

429

430

<dt><a name="item_xfer_mailbox_server__5bpartition_5d"><code>xfer</code> mailbox server [partition]</a>

431

432

<dd>

433

Transfer (relocate) the specified mailbox to a different server.

327

434

Both old-style and getopt-style usages are accepted; combining them will

328

produce an error.

329

</DL>

330

331

<HR>

332

<H1><A NAME="notes">NOTES</A></H1>

333

GNU-style long options must be given in their entirety; Tcl-style options

334

may be abbreviated.

335

Tcl-style options are provided as a compatibility feature. They will

336

probably go away in the future.

337

Multiple commands can be given on a line, separated by <CODE>';'</CODE> characters.

338

All commands set an exit status, which at present is not useful.

339

Unknown commands are passed to a subshell for execution.

340

The Tcl version of cyradm is used for scripting as well as interactively.

341

While this is possible to a limited extent by use of the <CODE>run</CODE> method,

342

scripting would normally be done with <CODE>Cyrus::IMAP::Admin</CODE>, which is far

343

more flexible than either interactive <CODE>cyradm</CODE> or the Tcl scripting

344

mechanism for Cyrus.

345

cyradm understands /bin/sh-style redirection: any command can have

346

its standard or error output redirected, with all sh-style redirections

347

(except <CODE><></CODE>) supported. It does not currently understand pipes

348

or backgrounding.

349

If the <CODE>Term::Readline::Perl</CODE> or <CODE>Term::Readline::GNU</CODE> modules are

350

available, cyradm will use it.

351

An alias facility is implemented internally, but no access is currently

435

produce an error.

436

</dd>

437

</li>

438

</dl>

439

440

441

<hr />

442

<h1><a name="notes">NOTES</a></h1>

443

GNU-style long options must be given in their entirety; Tcl-style options

444

may be abbreviated.

445

Tcl-style options are provided as a compatibility feature. They will

446

probably go away in the future.

447

Multiple commands can be given on a line, separated by <code>';'</code> characters.

448

All commands set an exit status, which at present is not useful.

449

Unknown commands are passed to a subshell for execution.

450

The Tcl version of cyradm is used for scripting as well as interactively.

451

While this is possible to a limited extent by use of the <code>run</code> method,

452

scripting would normally be done with <code>Cyrus::IMAP::Admin</code>, which is far

453

more flexible than either interactive <code>cyradm</code> or the Tcl scripting

454

mechanism for Cyrus.

455

cyradm understands /bin/sh-style redirection: any command can have

456

its standard or error output redirected, with all sh-style redirections

457

(except <code><></code>) supported. It does not currently understand pipes

458

or backgrounding.

459

If the <code>Term::Readline::Perl</code> or <code>Term::Readline::GNU</code> modules are

460

available, cyradm will use it.

461

An alias facility is implemented internally, but no access is currently

352

462

provided to it. This will change, if only to allow some of the predefined

353

aliases to be removed if they conflict with useful shell commands.

354

355

<HR>

356

<H1><A NAME="author">AUTHOR</A></H1>

357

Brandon S. Allbery, <A HREF="mailto:allbery@ece.cmu.edu">allbery@ece.cmu.edu</A>

358

359

<HR>

360

361

Cyrus::IMAP::Admin

463

aliases to be removed if they conflict with useful shell commands.

464

465

466

<hr />

467

<h1><a name="author">AUTHOR</a></h1>

468

Brandon S. Allbery, <a href="mailto:allbery@ece.cmu.edu">allbery@ece.cmu.edu</a>

469

470

471

<hr />

472

473

Cyrus::IMAP::Admin

362

474

Term::ReadLine

363

sh(1), perl(1), imapd(8).

364

365

</BODY>

366

367

</HTML>

475

sh(1), perl(1), imapd(8).

476

477

</body>

478

479

</html>

Older »