kmail

KMail Namespace Reference

Detailed Description

The KMail namespace contains classes used for KMail.

This is to keep them out of the way from all the other un-namespaced classes in libs and the rest of PIM.


Classes
class	AccountComboBox
	A readonly combobox showing the accounts, to select one. More...
class	AccountManager
	The account manager is responsible for creating accounts of various types via the factory method create() and for keeping track of them. More...
struct	ACLListEntry
	One entry in the ACL list: user and permissions. More...
struct	AnnotationAttribute
	One entry in the annotation list: attribute name and attribute value. More...
class	AntiSpamConfig
	Singleton to manage loading the kmail.antispamrc file. More...
class	AntiSpamWizard
	KMail anti-spam wizard. More...
class	Callback
	This class is used for callback hooks needed by bodypart formatter plugins. More...
class	MboxCompactionJob
	A job that runs in the background and compacts mbox folders. More...
class	MaildirCompactionJob
	A job that runs in the background and compacts maildir folders. More...
class	ScheduledCompactionTask
	A scheduled "compact mails in this folder" task. More...
class	DictionaryComboBox
	A combo box for selecting the dictionary used for spell checking. More...
class	ScheduledExpireTask
	A scheduled "expire mails in this folder" task. More...
class	FilterLog
	KMail Filter Log Collector. More...
class	FilterLogDialog
	KMail Filter Log Collector. More...
class	ACLEntryDialog
	"New Access Control Entry" dialog. More...
class	FolderDiaACLTab
	"Access Control" tab in the folder dialog Internal class, only used by KMFolderDialog More...
class	FolderRequester
	A widget that contains a KLineEdit which shows the current folder and a button that fires a KMFolderSelDlg The dialog is set to disable readonly folders by default Search folders are excluded. More...
class	SortCacheItem
	Represents an item in the set of mails to be displayed but only as far as sorting, threading and reading/writing of the current sort order to a disk cache is concerned. More...
class	HeaderItem
	Visual representation of a member of the set of displayables (mails in the current folder). More...
class	HeaderStyle
	This class encapsulates the visual appearance of message headers.Encapsulates visual appearance of message headers. More...
class	HtmlStatusBar
	The HTML statusbar widget for use with the reader. More...
class	IdentityDrag
	A QDragObject for KPIM::Identity. More...
class	IdentityListViewItem
	A QListViewItem for use in IdentityListView. More...
class	IdentityListView
	A listview for KPIM::Identity. More...
class	HtmlWriter
	An interface to HTML sinks. More...
class	RuleWidgetHandler
	An interface to filter/search rule widget handlers. More...
class	URLHandler
	An interface to reader link handlers. More...
class	ScheduledTask
	A scheduled task is some information about a folder job that should be run later. More...
class	JobScheduler
	The unique JobScheduler instance (owned by kmkernel) implements "background processing" of folder operations (like expiration and compaction). More...
class	ScheduledJob
	Base class for scheduled jobs. More...
class	FolderDiaTab
	This is the base class for tabs in the folder dialog. More...
class	FolderDiaGeneralTab
	"General" tab in the folder dialog Internal class, only used by KMFolderDialog More...
class	ListJob
	Generic folder list job for (d)imap accounts. More...
class	MailingList
	Class is used for all Mailing List handling inside KMail. More...
class	PartNodeBodyPart
	an implemenation of the BodyPart interface using partNodes More...
class	PopAccount
	KMail account for pop mail account. More...
class	RedirectDialog
	KMail message redirection dialog. More...
class	RenameJob
	Rename and move (d)imap folders They can be moved everywhere (except search folders) as a new folder is created, all messages are moved there and the original folder is deleted. More...
class	RuleWidgetHandlerManager
	Singleton to manage the list of RuleWidgetHandlers. More...
class	SearchJob
	Search job. More...
class	SearchWindow
	The SearchWindow class provides a dialog for triggering a search on folders and storing that search as a search folder. More...
class	SecondaryWindow
	Window class for secondary KMail window like the composer window and the separate message window. More...
class	SieveDebugDialog
	Diagnostic info for Sieve. More...
class	SpamScore
	A simple tupel of agent, score and header. More...
class	SpamHeaderAnalyzer
	Flyweight for analysing spam headers. More...
class	TeeHtmlWriter
	A HtmlWriter that dispatches all calls to a list of other HtmlWriters. More...
class	TransportManager
	Currently only used to provide a function for reading the transport list. More...
class	UndoInfo
	A class for storing Undo information. More...
class	URLHandlerManager
	Singleton to manage the list of URLHandlers. More...
Namespaces
namespace	ACLJobs
namespace	AnnotationJobs
namespace	Interface
namespace	Util
Typedefs
typedef QValueVector< ACLListEntry >	ACLList
typedef QValueVector< AnnotationAttribute >	AnnotationList
typedef QValueList< SpamAgent >	SpamAgents
typedef QValueListIterator< SpamAgent >	SpamAgentsIterator
typedef QValueList< SpamScore >	SpamScores
typedef QValueListIterator< SpamScore >	SpamScoresIterator
Enumerations
enum	SpamAgentTypes { SpamAgentNone, SpamAgentBool, SpamAgentFloat, SpamAgentFloatLarge, SpamAgentAdjustedFloat }
enum	IMAPUserIdFormat { FullEmail, UserName }
enum	FolderContentsType { ContentsTypeMail = 0, ContentsTypeCalendar, ContentsTypeContact, ContentsTypeNote, ContentsTypeTask, ContentsTypeJournal, ContentsTypeLast = ContentsTypeJournal }
enum	{ num_primes = 29 }
enum	ReplyStrategy { ReplySmart = 0, ReplyAuthor, ReplyList, ReplyAll, ReplyNone }
enum	StatusValueTypes { StatusImportant = 0, StatusNew = 1, StatusUnread = 2, StatusRead = 3, StatusOld = 4, StatusDeleted = 5, StatusReplied = 6, StatusForwarded = 7, StatusQueued = 8, StatusSent = 9, StatusWatched = 10, StatusIgnored = 11, StatusSpam = 12, StatusHam = 13, StatusToDo = 14, StatusHasAttachment = 15 }
Functions
static void	renameChildFolders (KMFolderDir *dir, const QString &oldPath, const QString &newPath)
Composer *	makeComposer (KMMessage *msg=0, uint identity=0)
static QStringList	stringList (const char *headers[], int numHeaders)
static QString	directionOf (const QString &str)
static QString	strToHtml (const QString &str, int flags=LinkLocator::PreserveSpaces)
void	KMail::ImapAccountBase::removeJob (KIO::Job *job)
unsigned long	nextPrime (unsigned long n)
void	checkConfigUpdates ()
void	lockOrDie ()
void	insertLibraryCataloguesAndIcons ()
void	cleanup ()
static QString	dotstuff (QString s)
static KURL	findUrlForAccount (const KMail::ImapAccountBase *a)
Variables
static const about_data	authors []
static const about_data	credits []
static const AttachmentStrategy *	iconicStrategy = 0
static const AttachmentStrategy *	smartStrategy = 0
static const AttachmentStrategy *	inlinedStrategy = 0
static const AttachmentStrategy *	hiddenStrategy = 0
static const char *	briefHeaders []
static const int	numBriefHeaders = sizeof briefHeaders / sizeof *briefHeaders
static const char *	standardHeaders []
static const int	numStandardHeaders = sizeof standardHeaders / sizeof *standardHeaders
static const char *	richHeaders []
static const int	numRichHeaders = sizeof richHeaders / sizeof *richHeaders
static const HeaderStrategy *	allStrategy = 0
static const HeaderStrategy *	richStrategy = 0
static const HeaderStrategy *	standardStrategy = 0
static const HeaderStrategy *	briefStrategy = 0
static const HeaderStrategy *	customStrategy = 0
static const HeaderStyle *	briefStyle = 0
static const HeaderStyle *	plainStyle = 0
static const HeaderStyle *	fancyStyle = 0
static const char	kmailIdentityMimeType [] = "application/x-kmail-identity-drag"
static const unsigned short int	imapDefaultPort = 143
static const unsigned long	prime_list [num_primes]
static const MessageStatus	StatusValues []
static const int	StatusValueCount
static const int	StatusValueCountWithoutHidden = StatusValueCount - 1
static QMap< QString, int >	s_serverConnections

Enumeration Type Documentation

enum KMail::SpamAgentTypes

Valid types of SpamAgent.

Enumeration values:

SpamAgentNone	Invalid SpamAgent, skip this agent.
SpamAgentBool	Simple Yes or No (Razor).
SpamAgentFloat	For straight percentages between 0.0 and 1.0 (BogoFilter).
SpamAgentFloatLarge	For straight percentages between 0.0 and 100.0.
SpamAgentAdjustedFloat	Use this when we need to compare against a threshold (SpamAssasssin).

Definition at line 46 of file antispamconfig.h.

Variable Documentation

const char* KMail::briefHeaders[] [static]

Initial value:

 {
    "subject", "from", "cc", "bcc", "date"
  }

Definition at line 49 of file headerstrategy.cpp.

const unsigned long KMail::prime_list[num_primes] [static]

Initial value:

  {
    31ul,        53ul,         97ul,         193ul,       389ul,
    769ul,       1543ul,       3079ul,       6151ul,      12289ul,
    24593ul,     49157ul,      98317ul,      196613ul,    393241ul,
    786433ul,    1572869ul,    3145739ul,    6291469ul,   12582917ul,
    25165843ul,  50331653ul,   100663319ul,  201326611ul, 402653189ul,
    805306457ul, 1610612741ul, 3221225473ul, 4294967291ul
  }

Definition at line 70 of file kmglobal.h.

const char* KMail::richHeaders[] [static]

Initial value:

 {
    "subject", "date", "from", "cc", "bcc", "to",
    "organization", "organisation", "reply-to"
  }

Definition at line 61 of file headerstrategy.cpp.

const char* KMail::standardHeaders[] [static]

Initial value:

 {
    "subject", "from", "cc", "bcc", "to"
  }

Definition at line 55 of file headerstrategy.cpp.

const int KMail::StatusValueCount [static]

Initial value:

    sizeof( StatusValues ) / sizeof( MessageStatus )

Definition at line 255 of file kmsearchpattern.h.

const MessageStatus KMail::StatusValues[] [static]

Initial value:

 {
    { I18N_NOOP( "Important" ),        "kmmsgflag"   },
    { I18N_NOOP( "New" ),              "kmmsgnew"   },
    { I18N_NOOP( "Unread" ),           "kmmsgunseen"   },
    { I18N_NOOP( "Read" ),             "kmmsgread"   },
    { I18N_NOOP( "Old" ),              0   },
    { I18N_NOOP( "Deleted" ),          "kmmsgdel"   },
    { I18N_NOOP( "Replied" ),          "kmmsgreplied"   },
    { I18N_NOOP( "Forwarded" ),        "kmmsgforwarded"   },
    { I18N_NOOP( "Queued" ),           "kmmsgqueued"   },
    { I18N_NOOP( "Sent" ),             "kmmsgsent"   },
    { I18N_NOOP( "Watched" ),          "kmmsgwatched"   },
    { I18N_NOOP( "Ignored" ),          "kmmsgignored"   },
    { I18N_NOOP( "Spam" ),             "kmmsgspam"   },
    { I18N_NOOP( "Ham" ),              "kmmsgham"   },
    { I18N_NOOP( "To Do" ),            "kmmsgtodo"   },
    { I18N_NOOP( "Has Attachment"),    "kmmsgattachment"   }
  }

Definition at line 217 of file kmsearchpattern.h.

kmail

KMail Namespace Reference

Detailed Description

Classes

Namespaces

Typedefs

Enumerations

Functions

Variables

Enumeration Type Documentation

Variable Documentation

kmail

API Dox