IMAP::IMSP
IMAP::IMSP
NAMESYNOPSIS
DESCRIPTION
METHODS
AUTHOR
SEE ALSO
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).
Opportunity
Personal Opportunity - Free software gives you access to billions of dollars of software at no cost. Use this software for your business, personal use or to develop a profitable skill. Access to source code provides access to a level of capabilities/information that companies protect though copyrights. Open source is a core component of the Internet and it is available to you. Leverage the billions of dollars in resources and capabilities to build a career, establish a business or change the world. The potential is endless for those who understand the opportunity.
Business Opportunity - Goldman Sachs, IBM and countless large corporations are leveraging open source to reduce costs, develop products and increase their bottom lines. Learn what these companies know about open source and how open source can give you the advantage.
Free Software
Free Software provides computer programs and capabilities at no cost but more importantly, it provides the freedom to run, edit, contribute to, and share the software. The importance of free software is a matter of access, not price. Software at no cost is a benefit but ownership rights to the software and source code is far more significant.
Free Office Software - The Libre Office suite provides top desktop productivity tools for free. This includes, a word processor, spreadsheet, presentation engine, drawing and flowcharting, database and math applications. Libre Office is available for Linux or Windows.
Free Books
The Free Books Library is a collection of thousands of the most popular public domain books in an online readable format. The collection includes great classical literature and more recent works where the U.S. copyright has expired. These books are yours to read and use without restrictions.
Source Code - Want to change a program or know how it works? Open Source provides the source code for its programs so that anyone can use, modify or learn how to write those programs themselves. Visit the GNU source code repositories to download the source.
Education
Study at Harvard, Stanford or MIT - Open edX provides free online courses from Harvard, MIT, Columbia, UC Berkeley and other top Universities. Hundreds of courses for almost all major subjects and course levels. Open edx also offers some paid courses and selected certifications.
Linux Manual Pages - A man or manual page is a form of software documentation found on Linux/Unix operating systems. Topics covered include computer programs (including library and system calls), formal standards and conventions, and even abstract concepts.
