™.. IMAP::Shell - Online Linux Manual PageSection : 3
Updated : 2008-04-04
Source : perl v5.10.1
Note : User Contributed Perl Documentation
NAMECyrus::IMAP::Shell − Perl version of cyradm
SYNOPSIS​ $ cyradm [−−user authid] [−−authz authzid] [−−[no]rc] [−−systemrc file] [−−userrc file] \ ​ > [−−port n] [−−auth mechanism] [−−server] server but possibly ​ $ perl −MCyrus::IMAP::Shell −e 'run("myscript")' or even (not recommended) ​ use Cyrus::IMAP::Admin::Shell; ​ ​ run('myscriptname');
DESCRIPTIONThis module implements cyradm in Perl. It is a shell around Cyrus::IMAP::Admin. Commands are provided in both Tcl-compatible forms and GNU-style long option forms.
COMMANDSauthenticate [−−minssf N] [−−maxssf N] [−−mechanisms list] [user] auth [−−minssf N] [−−maxssf N] [−−mechanisms list] [user] login [−−minssf N] [−−maxssf N] [−−mechanisms list] [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. chdir directory cd directory Change directory. A \*(C`pwd\*(C'\fR builtin is not provided, but the default command action will run \*(C`pwd\*(C'\fR from a shell if invoked. createmailbox [−−partition partition] mailbox createmailbox mailbox partition create [−−partition partition] mailbox create mailbox partition cm [−−partition partition] mailbox cm mailbox 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). deleteaclmailbox mailbox id [...] deleteacl mailbox id [...] dam mailbox id [...] Remove ACLs from the specified mailbox. deletemailbox mailbox delete mailbox dm mailbox Delete the specified mailbox. Administrators do not have implicit delete rights on mailboxes. Use the ​setaclmailbox command to grant the \*(C`k\*(C'\fR 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. disconnect disc Disconnect from the current server. The prompt will revert to \*(C`cyradm>\*(C'\fR. exit [number] quit [number] Exit cyradm, optionally with a specific exit status; the exit status of the last command will be used if one is not specified. help [command] ? [command] Show help for \*(C`command\*(C'\fR or all commands. info [mailbox] Display the mailbox/server metadata. listaclmailbox mailbox listacl mailbox lam mailbox List ACLs on the specified mailbox. listmailbox [−−subscribed] [pattern [reference]] list [−−subscribed] [pattern [reference]] lm [−−subscribed] [pattern [reference]] List all, or all subscribed, mailboxes matching the specified pattern. The pattern may have embedded wildcards '*' or '%', 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 '%' 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. listquota root lq root List quotas on specified root. If the specified mailbox path does not have a quota assigned, an error will be raised; see listquotaroot for a way to find the quota root for a mailbox. listquotaroot mailbox lqm mailbox lqr mailbox? show quota roots and quotas for mailbox mboxconfig mailbox attribute value mboxcfg mailbox attribute value Set mailbox metadata. A value of ‟none” will remove the attribute. The currently supported attributes are: comment Sets a comment or description associated with the mailbox. condstore Enables the IMAP CONDSTORE extension (modification sequences) on the mailbox. expire Sets the number of days after which messages will be expired from the mailbox. news2mail Sets an email address to which messages injected into the server via NNTP will be sent. 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. 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). squat Indicates that the mailbox should have a squat index created for it. renamemailbox [−−partition partition] oldname newname rename [−−partition partition] oldname newname renm [−−partition partition] oldname newname renamemailbox oldname newname [partition] rename oldname newname [partition] renm oldname newname [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. server [−−noauthenticate] [server] connect [−−noauthenticate] [server] 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\*(C'\fR option is specified. (This may change; in particular, either automatic authentication will be removed or all \*(C`authenticate\*(C'\fR options will be added.) When connected to a server, cyradm's prompt changes from \*(C`cyradm>\*(C'\fR to ​\*(C`servername>\*(C'\fR, where \fIservername\fR is the fully qualified domain name of the connected server. setaclmailbox mailbox id rights [id rights ...] setacl mailbox id rights [id rights ...] sam mailbox id rights [id rights ...] Set ACLs on a mailbox. The ACL may be one of the special strings \*(C`none\*(C'\fR, ​\*(C`read\*(C'\fR (\f(CW\*(C`lrs\*(C'\fR), \f(CW\*(C`post\*(C'\fR (\f(CW\*(C`lrsp\*(C'\fR), \f(CW\*(C`append\*(C'\fR (\f(CW\*(C`lrsip\*(C'\fR), \f(CW\*(C`write\*(C'\fR (\*(C`lrswipkxte\*(C'\fR), \f(CW\*(C`delete\*(C'\fR (\f(CW\*(C`lrxte\*(C'\fR), or \f(CW\*(C`all\*(C'\fR (\f(CW\*(C`lrswipkxte\*(C'\fR), or any combinations of the ACL codes: l Lookup (mailbox is visible to LIST/LSUB, SUBSCRIBE mailbox) r Read (SELECT/EXAMINE the mailbox, perform STATUS) s Seen (set/clear \SEEN flag via STORE, also set \SEEN flag during
    APPEND/COPY/FETCH BODY[...]) w Write flags other than \SEEN and \DELETED i Insert (APPEND, COPY destination) p Post (send mail to mailbox) k Create mailbox (CREATE new sub-mailboxes, parent for new mailbox in RENAME) x Delete mailbox (DELETE mailbox, old mailbox name in RENAME) t Delete messages (set/clear \DELETED flag via STORE, also set \DELETED
    flag during APPEND/COPY) e Perform EXPUNGE and expunge as part of CLOSE a Administer (SETACL/DELETEACL/GETACL/LISTRIGHTS) setinfo attribute value Set server metadata. A value of ‟none” will remove the attribute. The currently supported attributes are: motd Sets a ‟message of the day”. The message gets displayed as an ALERT upon connection. comment Sets a comment or description associated with the server. admin Sets the administrator email address for the server. shutdown Sets a shutdown message. The message gets displayed as an ALERT and all users are disconnected from the server (subsequent logins are disallowed). expire Sets the number of days after which messages will be expired from the server (unless overridden by a mailbox annotation). squat Indicates that all mailboxes should have a squat indexes created for them (unless overridden by a mailbox annotation). setquota root resource value [resource value ...] sq root resource value [resource value ...] Set a quota on the specified root, which may or may not be an actual mailbox. The only resource understood by Cyrus is \*(C`STORAGE\*(C'\fR. The units are as defined in RFC 2087, groups of 1024 octets (i.e. Kilobytes). The value may be the special string \*(C`none\*(C'\fR which will remove the quota. version ver Display the version info of the current server. xfermailbox [−−partition partition] mailbox server xfer [−−partition partition] mailbox server xfermailbox mailbox server [partition] xfer mailbox server [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.
NOTESGNU-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 ';' 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 cyradm is used for scripting as well as interactively. While this is possible to a limited extent by use of the \*(C`run\*(C'\fR method, scripting would normally be done with \*(C`Cyrus::IMAP::Admin\*(C'\fR, which is far more flexible than either interactive \*(C`cyradm\*(C'\fR or the Tcl scripting mechanism for Cyrus. ​cyradm understands /bin/sh−style redirection: any command can have its standard or error output redirected, with all sh−style redirections (except \*(C`<>\*(C'\fR) supported. It does not currently understand pipes or backgrounding. If the \*(C`Term::Readline::Perl\*(C'\fR or \f(CW\*(C`Term::Readline::GNU\*(C'\fR modules are available, 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.
AUTHORBrandon S. Allbery, allbery@ece.cmu.edu
SEE ALSOCyrus::IMAP::Admin Term::ReadLine ​sh (1), perl (1), imapd (8). 0
Johanes Gumabo
Data Size   :   60,952 byte
man-Cyrus::IMAP::Shell.3pmBuild   :   2024-12-05, 20:55   :  
Visitor Screen   :   x
Visitor Counter ( page / site )   :   2 / 180,787
Visitor ID   :     :  
Visitor IP   :   18.226.214.1   :  
Visitor Provider   :   AMAZON-02   :  
Provider Position ( lat x lon )   :   39.962500 x -83.006100   :   x
Provider Accuracy Radius ( km )   :   1000   :  
Provider City   :   Columbus   :  
Provider Province   :   Ohio ,   :   ,
Provider Country   :   United States   :  
Provider Continent   :   North America   :  
Visitor Recorder   :   Version   :  
Visitor Recorder   :   Library   :  
Online Linux Manual Page   :   Version   :   Online Linux Manual Page - Fedora.40 - march=x86-64 - mtune=generic - 24.12.05
Online Linux Manual Page   :   Library   :   lib_c - 24.10.03 - march=x86-64 - mtune=generic - Fedora.40
Online Linux Manual Page   :   Library   :   lib_m - 24.10.03 - march=x86-64 - mtune=generic - Fedora.40
Data Base   :   Version   :   Online Linux Manual Page Database - 24.04.13 - march=x86-64 - mtune=generic - fedora-38
Data Base   :   Library   :   lib_c - 23.02.07 - march=x86-64 - mtune=generic - fedora.36
Very long time ago, I have the best tutor, Wenzel Svojanovsky . If someone knows the email address of Wenzel Svojanovsky , please send an email to johanes_gumabo@yahoo.co.id .
If error, please print screen and send to johanes_gumabo@yahoo.co.id
Under development. Support me via PayPal.
ERROR : Need New Coding :         (parse_manual_page_|249|Cyrus::IMAP::Shell.3pm|36/37|el══─{─══.|.el══─{─══. ds -- \|\(em\| )         (htmlprn|149|Cyrus::IMAP::Shell.3pm|36/37|.el══─{─══. ds --  —  |.el══─{─══. ds -- \|\(em\| )         (parse_manual_page_|249|Cyrus::IMAP::Shell.3pm|41|br══─}─══|'br══─}─══ )         (htmlprn|149|Cyrus::IMAP::Shell.3pm|41|'br══─}─══ |'br══─}─══ )         (rof_nr_x|149|Cyrus::IMAP::Shell.3pm|51/52|\nF|.ie \nF ══─{─══. de IX )         (rof_unit_scale_px|41|Cyrus::IMAP::Shell.3pm|51/52|F|.ie \nF ══─{─══. de IX )         (rof_if|19|Cyrus::IMAP::Shell.3pm|51/52|\nF|.ie \nF ══─{─══. de IX )         (htmlprn|149|Cyrus::IMAP::Shell.3pm|51/52|.ie \nF ══─{─══. de IX|.ie \nF ══─{─══. de IX )         (rof_escape_sequence|91|Cyrus::IMAP::Shell.3pm|53|\$1\t\\n%\t"\\$2" |. tm Index:\\$1\t\\n%\t"\\$2" )         (parse_manual_page_|249|Cyrus::IMAP::Shell.3pm|57|══─}─══|.══─}─══ )         (htmlprn|149|Cyrus::IMAP::Shell.3pm|57|.══─}─══ |.══─}─══ )         (rof_escape_sequence|91|Cyrus::IMAP::Shell.3pm|183|\*(C`pwd\*(C'\fR builtin is not provided, but the default command |Change directory. A \f(CW\*(C`pwd\*(C'\fR builtin is not provided, but the default command )         (rof_escape_sequence|91|Cyrus::IMAP::Shell.3pm|184|\*(C`pwd\*(C'\fR from a shell if invoked. |action will run \f(CW\*(C`pwd\*(C'\fR from a shell if invoked. )         (rof_escape_sequence|91|Cyrus::IMAP::Shell.3pm|233|\*(C`k\*(C'\fR permission to your |\&\fBsetaclmailbox\fR command to grant the \f(CW\*(C`k\*(C'\fR permission to your )         (rof_escape_sequence|91|Cyrus::IMAP::Shell.3pm|247|\*(C`cyradm>\*(C'\fR. |Disconnect from the current server. The prompt will revert to \f(CW\*(C`cyradm>\*(C'\fR. )         (rof_escape_sequence|91|Cyrus::IMAP::Shell.3pm|264|\*(C`command\*(C'\fR or all commands. |Show help for \f(CW\*(C`command\*(C'\fR or all commands. )         (rof_escape_sequence|91|Cyrus::IMAP::Shell.3pm|403|\*(C`\-\-noauthenticate\*(C'\fR |server. It will prompt for automatic login unless the \f(CW\*(C`\-\-noauthenticate\*(C'\fR )         (rof_escape_sequence|91|Cyrus::IMAP::Shell.3pm|405|\*(C`authenticate\*(C'\fR options will be added.) |authentication will be removed or all \f(CW\*(C`authenticate\*(C'\fR options will be added.) )         (rof_escape_sequence|91|Cyrus::IMAP::Shell.3pm|407|\*(C`cyradm>\*(C'\fR to |When connected to a server, \fBcyradm\fR's prompt changes from \f(CW\*(C`cyradm>\*(C'\fR to )         (rof_escape_sequence|91|Cyrus::IMAP::Shell.3pm|408|\*(C`servername>\*(C'\fR, where \fIservername\fR is the fully qualified domain name |\&\f(CW\*(C`servername>\*(C'\fR, where \fIservername\fR is the fully qualified domain name )         (rof_escape_sequence|91|Cyrus::IMAP::Shell.3pm|421|\*(C`none\*(C'\fR, |Set ACLs on a mailbox. The \s-1ACL\s0 may be one of the special strings \f(CW\*(C`none\*(C'\fR, )         (rof_escape_sequence|91|Cyrus::IMAP::Shell.3pm|422|\*(C`read\*(C'\fR (\f(CW\*(C`lrs\*(C'\fR), \f(CW\*(C`post\*(C'\fR (\f(CW\*(C`lrsp\*(C'\fR), \f(CW\*(C`append\*(C'\fR (\f(CW\*(C`lrsip\*(C'\fR), \f(CW\*(C`write\*(C'\fR |\&\f(CW\*(C`read\*(C'\fR (\f(CW\*(C`lrs\*(C'\fR), \f(CW\*(C`post\*(C'\fR (\f(CW\*(C`lrsp\*(C'\fR), \f(CW\*(C`append\*(C'\fR (\f(CW\*(C`lrsip\*(C'\fR), \f(CW\*(C`write\*(C'\fR )         (rof_escape_sequence|91|Cyrus::IMAP::Shell.3pm|423|\*(C`lrswipkxte\*(C'\fR), \f(CW\*(C`delete\*(C'\fR (\f(CW\*(C`lrxte\*(C'\fR), or \f(CW\*(C`all\*(C'\fR (\f(CW\*(C`lrswipkxte\*(C'\fR), or |(\f(CW\*(C`lrswipkxte\*(C'\fR), \f(CW\*(C`delete\*(C'\fR (\f(CW\*(C`lrxte\*(C'\fR), or \f(CW\*(C`all\*(C'\fR (\f(CW\*(C`lrswipkxte\*(C'\fR), or )         (rof_escape_sequence|91|Cyrus::IMAP::Shell.3pm|510|\*(C`STORAGE\*(C'\fR. The units |The only \fIresource\fR understood by \fBCyrus\fR is \f(CW\*(C`STORAGE\*(C'\fR. The units )         (rof_escape_sequence|91|Cyrus::IMAP::Shell.3pm|512|\*(C`none\*(C'\fR which will remove the quota. |The \fIvalue\fR may be the special string \f(CW\*(C`none\*(C'\fR which will remove the quota. )         (rof_escape_sequence|91|Cyrus::IMAP::Shell.3pm|554|\*(C`run\*(C'\fR method, |While this is possible to a limited extent by use of the \f(CW\*(C`run\*(C'\fR method, )         (rof_escape_sequence|91|Cyrus::IMAP::Shell.3pm|555|\*(C`Cyrus::IMAP::Admin\*(C'\fR, which is far |scripting would normally be done with \f(CW\*(C`Cyrus::IMAP::Admin\*(C'\fR, which is far )         (rof_escape_sequence|91|Cyrus::IMAP::Shell.3pm|556|\*(C`cyradm\*(C'\fR or the Tcl scripting |more flexible than either interactive \f(CW\*(C`cyradm\*(C'\fR or the Tcl scripting )         (rof_escape_sequence|91|Cyrus::IMAP::Shell.3pm|561|\*(C`<>\*(C'\fR) supported. It does not currently understand pipes |(except \f(CW\*(C`<>\*(C'\fR) supported. It does not currently understand pipes )         (rof_escape_sequence|91|Cyrus::IMAP::Shell.3pm|564|\*(C`Term::Readline::Perl\*(C'\fR or \f(CW\*(C`Term::Readline::GNU\*(C'\fR modules are |If the \f(CW\*(C`Term::Readline::Perl\*(C'\fR or \f(CW\*(C`Term::Readline::GNU\*(C'\fR modules are )