• Skip to content
  • Skip to link menu
KDE 4.2 API Reference
  • KDE API Reference
  • kdepim
  • Sitemap
  • Contact Us
 

maildir

KPIM::Maildir

KPIM::Maildir Class Reference

#include <maildir.h>

List of all members.

Detailed Description

Definition at line 31 of file maildir.h.


Public Member Functions

QString addEntry (const QByteArray &data)
QString addSubFolder (const QString &folderName)
bool create ()
QStringList entryList () const
bool isValid (QString &error) const
bool isValid () const
 Maildir (const Maildir &rhs)
 Maildir (const QString &path=QString(), bool isRoot=false)
Maildir & operator= (const Maildir &rhs)
bool operator== (const Maildir &rhs) const
QString path () const
QByteArray readEntry (const QString &key) const
QByteArray readEntryHeaders (const QString &key) const
bool removeEntry (const QString &key)
bool removeSubFolder (const QString &folderName)
Maildir subFolder (const QString &folderName)
QStringList subFolderList () const
void writeEntry (const QString &key, const QByteArray &data)
 ~Maildir ()

Constructor & Destructor Documentation

Maildir::Maildir ( const QString &  path = QString(),
bool  isRoot = false 
) [explicit]

Definition at line 100 of file maildir.cpp.

Maildir::Maildir ( const Maildir &  rhs  ) 

Definition at line 113 of file maildir.cpp.

Maildir::~Maildir (  ) 

Definition at line 135 of file maildir.cpp.

Member Function Documentation

QString Maildir::addEntry ( const QByteArray &  data  ) 

Adds the given.

Parameters:
to the maildir. Returns the key of the entry.

Definition at line 350 of file maildir.cpp.

QString Maildir::addSubFolder ( const QString &  folderName  ) 

Adds subfolder with the given.

Parameters:
folderName. 
Returns:
an empty string on failure or the full path of the new subfolder on success

Definition at line 202 of file maildir.cpp.

bool Maildir::create (  ) 

Make a valid maildir at the path of this Maildir object.

This involves creating the necessary subdirs, etc. Note that an empty Maildir is not valid, unless it is given valid path, or until create( ) is called on it.

Definition at line 183 of file maildir.cpp.

QStringList Maildir::entryList (  )  const

Returns the list of items (mails) in the maildir.

These are keys, which map to filenames, internally, but that's an implementation detail, which should not be relied on.

Definition at line 254 of file maildir.cpp.

bool Maildir::isValid ( QString &  error  )  const

Returns whether the maildir is valid, and sets the error out-parameter so it can be used to signal the kind of error to the user.

See also:
isValid

Definition at line 174 of file maildir.cpp.

bool Maildir::isValid (  )  const

Returns whether the maildir has all the necessary subdirectories, that they are readable, etc.

Definition at line 168 of file maildir.cpp.

Maildir & Maildir::operator= ( const Maildir &  rhs  ) 

Definition at line 120 of file maildir.cpp.

bool Maildir::operator== ( const Maildir &  rhs  )  const

Equality comparison.

Definition at line 129 of file maildir.cpp.

QString Maildir::path (  )  const

Returns the path of this maildir.

Definition at line 197 of file maildir.cpp.

QByteArray Maildir::readEntry ( const QString &  key  )  const

Return the contents of the file in the maildir with the given.

Parameters:
key. 

Definition at line 284 of file maildir.cpp.

QByteArray Maildir::readEntryHeaders ( const QString &  key  )  const

Return the contents of the headers section of the file the maildir with the given.

Parameters:
key. 

Definition at line 304 of file maildir.cpp.

bool Maildir::removeEntry ( const QString &  key  ) 

Removes the entry with the given .

Returns success or failure.

Definition at line 372 of file maildir.cpp.

bool Maildir::removeSubFolder ( const QString &  folderName  ) 

Removes subfolder with the given.

Parameters:
folderName. Returns success or failure.

Definition at line 223 of file maildir.cpp.

Maildir Maildir::subFolder ( const QString &  folderName  ) 

Returns a Maildir object for the given.

Parameters:
folderName. If such a folder exists, the Maildir object will be valid, otherwise you can call create() on it, to make a subfolder with that name.

Definition at line 238 of file maildir.cpp.

QStringList Maildir::subFolderList (  )  const

Returns the list of subfolders, as names (relative paths).

Use the subFolder method to get Maildir objects representing them.

Definition at line 266 of file maildir.cpp.

void Maildir::writeEntry ( const QString &  key,
const QByteArray &  data 
)

Write the given.

Parameters:
data to a file in the maildir with the given
key. 

Definition at line 336 of file maildir.cpp.

The documentation for this class was generated from the following files:
  • maildir.h
  • maildir.cpp

maildir

Skip menu "maildir"
  • Main Page
  • Namespace List
  • Alphabetical List
  • Class List
  • File List
  • Class Members

kdepim

Skip menu "kdepim"
  • akonadi
  •   clients
  •   kabc
  •   kcal
  •   kcm
  • akregator
  • console
  •   kabcclient
  •   konsolekalendar
  • kaddressbook
  • kalarm
  •   lib
  • kdgantt
  • kdgantt1
  • kjots
  • kleopatra
  • kmail
  • kmobiletools
  • knode
  • knotes
  • kontact
  • kontactinterfaces
  • korganizer
  •   korgac
  • kpilot
  • ktimetracker
  • libkdepim
  • libkholidays
  • libkleo
  • libkpgp
  • maildir
Generated for kdepim by doxygen 1.5.4
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal