#include <mailbox.h>

Data Structures
class	BaseIterator

class	iterator

Public Types
enum	Iterator { INCLUDE_EXPUNGED = 1 , SKIP_EXPUNGED = 2 }

enum	Mode { UID_MODE = 4 , SQNR_MODE = 8 }

Public Member Functions
virtual iterator	begin (const SequenceSet &bset, unsigned int mod=INCLUDE_EXPUNGED\|SQNR_MODE) const =0

virtual iterator	end (void) const =0

virtual bool	getStatus (const std::string &, Status &) const =0

virtual bool	isMailbox (const std::string &) const =0

virtual bool	isMarked (const std::string &) const =0

virtual unsigned int	getStatusID (const std::string &) const =0

virtual void	bumpUidValidity (const std::string &) const =0

void	setReadOnly (bool readOnly)

bool	isReadOnly (void) const

virtual const std::string	getTypeName (void) const =0

const std::string	getName (void) const

void	setName (const std::string &name)

virtual unsigned int	getMaxUid (void) const =0

virtual unsigned int	getMaxSqnr (void) const =0

virtual unsigned int	getUidNext (void) const =0

virtual unsigned int	getUidValidity (void) const =0

virtual bool	getUpdates (bool scan, unsigned int type, PendingUpdates &updates, bool forceScan)=0

virtual void	updateFlags (void)=0

virtual void	expungeMailbox (void)=0

virtual bool	selectMailbox (const std::string &name, const std::string &s_in)=0

virtual bool	createMailbox (const std::string &s, mode_t mode, uid_t owner=0, gid_t group=0, bool root=false)=0

virtual bool	deleteMailbox (const std::string &s)=0

virtual void	closeMailbox (void)=0

virtual Message *	createMessage (const std::string &mbox, time_t idate=0)=0

virtual bool	commitNewMessages (const std::string &mbox)=0

virtual bool	rollBackNewMessages (void)=0

virtual bool	fastCopy (Message &source, Mailbox &desttype, const std::string &destname)=0

const std::string &	getLastError (void) const

void	setLastError (const std::string &error) const

	Mailbox (void)

virtual	~Mailbox (void)

Protected Attributes
bool	readOnly

Friends
class	Mailbox::iterator

Detailed Description

Definition at line 30 of file mailbox.h.

Member Enumeration Documentation

◆ Iterator

enum Iterator

Enumerator
INCLUDE_EXPUNGED
SKIP_EXPUNGED

Definition at line 67 of file mailbox.h.

◆ Mode

enum Mode

Enumerator
UID_MODE
SQNR_MODE

Definition at line 72 of file mailbox.h.

Constructor & Destructor Documentation

◆ Mailbox()

Mailbox ( void )

Definition at line 27 of file mailbox.cc.

◆ ~Mailbox()

~Mailbox ( void )

virtual

Definition at line 32 of file mailbox.cc.

Member Function Documentation

◆ begin()

virtual iterator begin	(	const SequenceSet &	bset,
		unsigned int	mod = `INCLUDE_EXPUNGED\|SQNR_MODE`
	)		const

pure virtual

Implemented in Maildir.

Here is the caller graph for this function:

◆ bumpUidValidity()

virtual void bumpUidValidity ( const std::string & ) const

pure virtual

Implemented in Maildir.

Here is the caller graph for this function:

◆ closeMailbox()

virtual void closeMailbox ( void )

pure virtual

Implemented in Maildir.

Here is the caller graph for this function:

◆ commitNewMessages()

virtual bool commitNewMessages ( const std::string & mbox )

pure virtual

Implemented in Maildir.

Here is the caller graph for this function:

◆ createMailbox()

virtual bool createMailbox	(	const std::string &	s,
		mode_t	mode,
		uid_t	owner = `0`,
		gid_t	group = `0`,
		bool	root = `false`
	)

pure virtual

Implemented in Maildir.

Here is the caller graph for this function:

◆ createMessage()

virtual Message * createMessage	(	const std::string &	mbox,
		time_t	idate = `0`
	)

pure virtual

Implemented in Maildir.

Here is the caller graph for this function:

◆ deleteMailbox()

virtual bool deleteMailbox ( const std::string & s )

pure virtual

Implemented in Maildir.

Here is the caller graph for this function:

◆ end()

virtual iterator end ( void ) const

pure virtual

Implemented in Maildir.

Here is the caller graph for this function:

◆ expungeMailbox()

virtual void expungeMailbox ( void )

pure virtual

Implemented in Maildir.

Here is the caller graph for this function:

◆ fastCopy()

virtual bool fastCopy	(	Message &	source,
		Mailbox &	desttype,
		const std::string &	destname
	)

pure virtual

Implemented in Maildir.

Here is the caller graph for this function:

◆ getLastError()

const string & getLastError ( void ) const

Definition at line 103 of file mailbox.cc.

Here is the caller graph for this function:

◆ getMaxSqnr()

virtual unsigned int getMaxSqnr ( void ) const

pure virtual

Implemented in Maildir.

Here is the caller graph for this function:

◆ getMaxUid()

virtual unsigned int getMaxUid ( void ) const

pure virtual

Implemented in Maildir.

Here is the caller graph for this function:

◆ getName()

const string getName ( void ) const

Definition at line 97 of file mailbox.cc.

Here is the caller graph for this function:

◆ getStatus()

virtual bool getStatus	(	const std::string &	,
		Status &
	)		const

pure virtual

Implemented in Maildir.

Here is the caller graph for this function:

◆ getStatusID()

virtual unsigned int getStatusID ( const std::string & ) const

pure virtual

Implemented in Maildir.

Here is the caller graph for this function:

◆ getTypeName()

virtual const std::string getTypeName ( void ) const

pure virtual

Implemented in Maildir.

◆ getUidNext()

virtual unsigned int getUidNext ( void ) const

pure virtual

Implemented in Maildir.

Here is the caller graph for this function:

◆ getUidValidity()

virtual unsigned int getUidValidity ( void ) const

pure virtual

Implemented in Maildir.

Here is the caller graph for this function:

◆ getUpdates()

virtual bool getUpdates	(	bool	scan,
		unsigned int	type,
		PendingUpdates &	updates,
		bool	forceScan
	)

pure virtual

Implemented in Maildir.

Here is the caller graph for this function:

◆ isMailbox()

virtual bool isMailbox ( const std::string & ) const

pure virtual

Implemented in Maildir.

◆ isMarked()

virtual bool isMarked ( const std::string & ) const

pure virtual

Implemented in Maildir.

Here is the caller graph for this function:

◆ isReadOnly()

bool isReadOnly ( void ) const

Definition at line 37 of file mailbox.cc.

◆ rollBackNewMessages()

virtual bool rollBackNewMessages ( void )

pure virtual

Implemented in Maildir.

Here is the caller graph for this function:

◆ selectMailbox()

virtual bool selectMailbox	(	const std::string &	name,
		const std::string &	s_in
	)

pure virtual

Implemented in Maildir.

Here is the caller graph for this function:

◆ setLastError()

void setLastError ( const std::string & error ) const

Definition at line 109 of file mailbox.cc.

Here is the caller graph for this function:

◆ setName()

void setName ( const std::string & name )

Definition at line 91 of file mailbox.cc.

Here is the caller graph for this function:

◆ setReadOnly()

void setReadOnly ( bool readOnly )

Definition at line 43 of file mailbox.cc.

Here is the caller graph for this function:

◆ updateFlags()

virtual void updateFlags ( void )

pure virtual

Implemented in Maildir.

Here is the caller graph for this function:

Friends And Related Function Documentation

◆ Mailbox::iterator

friend class Mailbox::iterator

friend

Definition at line 122 of file mailbox.h.

Field Documentation

◆ readOnly

bool readOnly

protected

Definition at line 125 of file mailbox.h.

The documentation for this class was generated from the following files:

2.0/bincimap-2.0.16/src/include/mailbox.h
2.0/bincimap-2.0.16/src/mailbox.cc

Data Structures

Public Types

Public Member Functions

Protected Attributes

Friends

Detailed Description

Member Enumeration Documentation

◆ Iterator

◆ Mode

Constructor & Destructor Documentation

◆ Mailbox()

◆ ~Mailbox()

Member Function Documentation

◆ begin()

◆ bumpUidValidity()

◆ closeMailbox()

◆ commitNewMessages()

◆ createMailbox()

◆ createMessage()

◆ deleteMailbox()

◆ end()

◆ expungeMailbox()

◆ fastCopy()

◆ getLastError()

◆ getMaxSqnr()

◆ getMaxUid()

◆ getName()

◆ getStatus()

◆ getStatusID()

◆ getTypeName()

◆ getUidNext()

◆ getUidValidity()

◆ getUpdates()

◆ isMailbox()

◆ isMarked()

◆ isReadOnly()

◆ rollBackNewMessages()

◆ selectMailbox()

◆ setLastError()

◆ setName()

◆ setReadOnly()

◆ updateFlags()

Friends And Related Function Documentation

◆ Mailbox::iterator

Field Documentation

◆ readOnly