Cyrus::IMAP::IMSP − Perl module for Cyrus IMSP user options


  use Cyrus::IMAP::IMSP;
  my $client = Cyrus::IMAP::IMSP−>new('imsphost'[, $port[, $flags]]);
  $rc = $client−>set('mailreader.window.size', '200x300');
  %options = $client−>get('mailreader.*')
  $rc = $client−>unset('mailreader.window.size');


This module is a Perl interface to the Cyrus IMSP functions that relate to user options (preferences). Only three IMSP operations are implemented: set, unset, and get.


new($server[, $port[, $flags]])

Instantiates a Cyrus::IMAP::IMSP object. This is in fact a Cyrus::IMAP object with a few additional methods, so all Cyrus::IMAP methods are available if needed. (In particular, you will always want to use the "authenticate" method.)


Return the last error that occurred, or undef if the last operation was successful. This is in some cases (such as "get") the only way to distinguish between a successful return of an empty list and an error return.

Calling "error" does not reset the error state, so it is legal to write:

    %options = $client−>get($option);
    print STDERR "Error: ", $client−>error if $client−>error;

set($option, $value)

Sets the option named by $option to the value in $value.

There are no restrictions or quoting rules needed to protect special characters in the value argument. (The Cyrus::IMAP layer will take care those details by adding double quotes or a literal introducer.)

If successful, returns 1. Otherwise, returns undef and makes an error message available through the "error" function.


Removes the option named by $option. The option is completely removed from the user’s name space but will revert to a site-wide default if one has been set. Note that this is different from assigning an option the null value with set($option, ’’).

If you try to unset an option that does not exist, an error is returned saying that the option was already unset.

If successful, returns 1. Otherwise, returns undef and makes an error message available through the "error" function.


Get takes either an option name or a pattern of names to fetch. The pattern can contain either "*" or "%" wildcards anywhere in the string. The usual IMAP wildcard semantics apply.

The return value is a hash of options with each key being an option name and each value being the option’s value string. If an empty hash is returned, it’s either because there were no matching options or because some error happened. Check the "error" function to see which was the case.

The IMSP protocol also returns an access flag of "[ READ−WRITE ]" or "[ READ−ONLY ]" but that information is discarded by this function. A more complicated function that returns both the value and the access flag could be added later if needed.


Brandon S. Allbery, IMSP modifications by Joseph Jackson, jackson@CMU.EDU


Cyrus::IMAP perl(1), cyradm(1), imapd(8).

More Linux Commands

Tcl_DictObjSize(3) - manipulate Tcl objects as dictionaries
Tcl dictionary objects have an internal representation that supports efficient mapping from keys to values and which guarantees that the particular ordering of

pbuildid(1) - print the build id of an ELF executable or cor
pbuildid reads the build id embedded in the process image of a core file or an executable file. The build id note is allocated an can be found in the process im

gnutls_openpgp_privkey_get_revoked_status.3 - Get revocation status of key. RETURNS true (1) if the key has been revoked, or false (0) if it has not, or a negat

git-unpack-file(1) - Creates a temporary file with a blobs c
Creates a file holding the contents of the blob specified by sha1. It returns the name of the temporary file in the following format: .merge_file_XXXXX OPTIONS

DBM_Filter(3pm) - Filter DBM keys/values - Linux man page...
This module provides an interface that allows filters to be applied to tied Hashes associated with DBM files. It builds on the DBM Filter hooks that are present

tigetstr_sp(3ncurses) - curses screen-pointer extension.....
This implementation can be configured to provide a set of functions which improve the ability to manage multiple screens. This feature can be added to any of th

XrmOptionDescRec(3) - initialize the Resource Manager, Resou
The XrmInitialize function initialize the resource manager. It must be called before any other Xrm functions are used. The XrmParseCommand function parses an (a

MIME::Head(3pm) - MIME message header (a subclass of Mail::H
A class for parsing in and manipulating RFC-822 message headers, with some methods geared towards standard (and not so standard) MIME fields as specified in the

iso_8859-5(7) - ISO 8859-5 character set encoded in octal, d
The ISO 8859 standard includes several 8-bit extensions to the ASCII character set (also known as ISO 646-IRV). ISO 8859-5 encodes the Cyrillic alphabet as used

ber_first_element(3) - OpenLDAP LBER simplified Basic Encodi
ber_first_element.3 - These routines provide a subroutine interface to a simplified implementation of the Basic Encoding Rules of ASN.1. The version of BER thes

groffer(1) - display groff files and man pages on X and tty
The groffer program is the easiest way to use groff(1). It can display arbitrary documents written in the groff language, see groff(7), or other roff languages,

mkfifoat(3) - make a FIFO (named pipe) relative to a directo
mkfifo() makes a FIFO special file with name pathname. mode specifies the FIFOs permissions. It is modified by the processs umask in the usual way: the permissi

We can't live, work or learn in freedom unless the software we use is free.