summaryrefslogtreecommitdiff
path: root/kimap/Mainpage.dox
blob: 6f0e3ebab6d3d5e756ac45f0e21dc5eabc29e689 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
/*!
 * @mainpage KIMAP - a job-based API for interacting with IMAP servers
 *
 * @section purpose Purpose
 *
 * This library provides a job-based API for interacting with an IMAP4rev1 server.
 * It manages connections, encryption and parameter quoting and encoding, but
 * otherwise provides quite a low-level interface to the protocol.  This library
 * does not implement an IMAP client; it merely makes it easier to do so.
 *
 * Users should be familiar with
 * <a href="http://www.apps.ietf.org/rfc/rfc3501.html" title="IMAP 4rev1">RFC 3501</a>,
 * as well as <a href="http://www.iana.org/assignments/imap4-capabilities">other related RFCs</a>,
 * although the library hides some of the nastier details like the encoding and quoting of
 * strings.
 *
 * @section desc Description
 *
 * @authors
 * The major authors of this library are:\n
 * Sven Carstens \<s.carstens@gmx.de\>
 *
 * @maintainers
 * none at the moment
 *
 * @licenses
 * @lgpl
 */

// DOXYGEN_PROJECTNAME=KIMAP Library