src/Mainpage.dox

   1 /**
   2   @mainpage Trojitá
   3
   4   Trojitá is an IMAP mail client written using the Qt framewrok. Its aim is to
   5   be as standard-compliant and usable as possible.
   6
   7   The Trojita e-mail application consists of several distinct parts.  Classes
   8   related to actual e-mail processing are defined in the Gui namespace.  Actuall
   9   IMAP implementation is in the Imap namespace.  Code dealing with message
  10   submission is in the MSA namespace.
  11
  12   Third-party components typically either define their own namespace (KIMAP,
  13   KCodecs,...) or are in the global namespace.
  14
  15   The core of the IMAP protocol implementation is the Imap::Mailbox::Model
  16   class.  It is assisted by handful other classes.  Parsing of the data stream
  17   from the IMAP server is handled by the Imap::Parser class.
  18
  19   The IMAP library's Imap::Mailbox::Model fully implements the Qt's
  20   QAbstractItemModel interface.  The primary method for dealing with remote IMAP
  21   server is therefore to use standard MVC methods when retrieving data.
  22   Specialized methods are provided for functions like creating new mailboxes,
  23   deleting existing ones etc.
  24
  25  */