cyrus::imap::imsp(3) [suse man page]
IMAP::IMSP(3) User Contributed Perl Documentation IMAP::IMSP(3) NAME
Cyrus::IMAP::IMSP - Perl module for Cyrus IMSP user options SYNOPSIS
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'); DESCRIPTION
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. METHODS
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.) error 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. unset($option) 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($option_pattern) 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. AUTHOR
Brandon S. Allbery, allbery@ece.cmu.edu IMSP modifications by Joseph Jackson, jackson@CMU.EDU SEE ALSO
Cyrus::IMAP perl(1), cyradm(1), imapd(8). perl v5.12.1 2002-05-25 IMAP::IMSP(3)
Check Out this Related Man Page
IMTEST(1) General Commands Manual IMTEST(1) * NAME
imtest - interactive IMAP test program SYNOPSIS
imtest [ -t keyfile ] [ -p port ] [ -m mechanism ] [ -a userid ] [ -u userid ] [ -k num ] [ -l num ] [ -r realm ] [ -f file ] [ -n num ] [ -s ] [ -q ] [ -c ] [ -i ] [ -z ] [ -v ] [ -I file ] [ -x file ] [ -X file ] [ -o option=value ] hostname DESCRIPTION
imtest is a utility that allows you to authenticate to a IMAP or IMSP server and interactively issue commands to it. Once authenticated you may issue any IMAP or IMSP command by simply typing it in. It is capable of multiple SASL authentication mechanisms and handles encryption layers transparently. This utility is often used for testing the operation of a imsp or imap server. Also those developing IMAP clients find it useful. OPTIONS
-t keyfile Enable TLS. keyfile contains the TLS public and private keys. Specify "" to negotiate a TLS encryption layer but not use TLS authentication. -p port Port to connect to. If left off this defaults to imap as defined in /etc/services. -m mechanism Force imtest to use mechanism for authentication. If not specified the strongest authentication mechanism supported by the server is chosen. Specify login to use the LOGIN command instead of AUTHENTICATE. -a userid Userid to use for authentication; defaults to the current user. This is the userid whose password or credentials will be presented to the server for verification. -u userid Userid to use for authorization; defaults to the current user. This is the userid whose identity will be assumed after authentica- tion. NOTE: This is only used with SASL mechanisms that allow proxying (e.g. PLAIN, DIGEST-MD5). -k num Minimum protection layer required. -l num Maximum protection layer to use (0=none; 1=integrity; etc). For example if you are using the KERBEROS_V4 authentication mechanism specifying 0 will force imtest to not use any layer and specifying 1 will force it to use the integrity layer. By default the maxi- mum supported protection layer will be used. -r realm Specify the realm to use. Certain authentication mechanisms (e.g. DIGEST-MD5) may require one to specify the realm. -f file Pipe file into connection after authentication. -n num Number of authentication attempts; default = 1. The client will attempt to do SSL/TLS session reuse and/or fast reauth (e.g. DIGEST-MD5), if possible. -s Enable IMAP over SSL (imaps). -q Enable IMAP COMPRESSion (before the last authentication attempt). -c Enable challenge prompt callbacks. This will cause the OTP mechanism to ask for the the one-time password instead of the secret pass-phrase (library generates the correct response). -i Don't send an initial client response for SASL mechanisms, even if the protocol supports it. -I file Echo the PID of the running process into file (This can be useful with -X). -x file Open the named socket for the interactive portion -X file Like -x, only close all file descriptors & daemonize the process. -o option=value Set the SASL option to value. -v Verbose. Print out more information than usual. -z Timing test. SEE ALSO
imapd(8) CMU
Project Cyrus IMTEST(1)