commit 66814b3cb18f7dbd70532ef3c03c851bee7989f0
parent 6724ad6d806a9e34178bcb7c601cfe901bb7c6bd
Author: andreaha <andreaha@b31fe1f4-c0d1-0310-8000-a34f4ae90293>
Date: Wed, 28 Jan 2004 23:08:11 +0000
- Added doxygen docs.
git-svn-id: file:///home/cwright/convert/bincimap/trunk@12 b31fe1f4-c0d1-0310-8000-a34f4ae90293
Diffstat:
| M | src/maildir.h | | | 270 | +++++-------------------------------------------------------------------------- |
1 file changed, 15 insertions(+), 255 deletions(-)
diff --git a/src/maildir.h b/src/maildir.h
@@ -77,94 +77,22 @@ namespace Binc {
public:
typedef std::map<unsigned int, MaildirMessage> MessageMap;
- /*!
- \class Maildir::iterator
-
- \brief The iterator class provides a special Mailbox iterator
- for the Maildir mailbox type.
-
- It is a proxy iterator; the real iterator is hidden inside. This
- allows you to use the iterator with polymorphic access, so this
- works:
-
- Mailbox::iterator i = maildir->begin();
- while (i != maildir->end()) {
- ++i;
- }
-
- The messages are traversed in ascending order of UID.
- */
class iterator : public BaseIterator {
public:
- /*!
- Constructs an invalid iterator.
- */
iterator(void);
-
- /*!
- Constructs an iterator.
-
- \param home The Maildir to iterate over.
- \param i The MessageMap iterator to encapsulate.
- \param mod Flags. See also Mailbox.
- */
iterator(Maildir *home, MessageMap::iterator i,
const SequenceSet &bset,
unsigned int mod = INCLUDE_EXPUNGED | SQNR_MODE);
-
- /*!
- Constructs a copy of an iterator.
-
- \param copy The new iterator becomes the copy of this
- iterator.
- */
iterator(const iterator ©);
-
- /*!
- Destructs an iterator.
- */
~iterator(void);
- /*!
- Returns the reference to the current MaildirMessage as a
- Message reference. If the iterator is invalid, the message
- reference will also be invalid so make sure to check for
- begin() and end().
- */
Message &operator *(void);
-
- /*!
- Advances the iterator one step.
- */
void operator ++(void);
+ bool operator ==(const BaseIterator &) const;
+ bool operator !=(const BaseIterator &) const;
- /*!
- Returns true if this iterator is equal to the one passed as
- argument; meaning that they both point to the same message or
- both to the end iterator, otherwise returns false.
- */
- bool operator ==(const BaseIterator &i) const;
-
- /*!
- Returns true if this iterator is not equal to the one passed
- as argument; meaning that they both point to the same message
- or both to the end iterator, otherwise returns false.
- */
- bool operator !=(const BaseIterator &i) const;
-
- /*!
- Makes this iterator a copy of the iterator passed as argument.
- This is an assignment iterator:
-
- iterator i, j;
- iterator i = j; // assignment
- */
iterator &operator =(const iterator ©);
- /*!
- Removes the message that this iterator points to from the
- MessageMap. Advances the iterator one step.
- */
void erase(void);
friend class Maildir;
@@ -181,209 +109,41 @@ namespace Binc {
MessageMap::iterator i;
iterator(iterator &external);
};
-
- /*!
- Returns the type name of this Mailbox. Always returns "Maildir".
- */
+
const std::string getTypeName(void) const;
- /*!
- Returns an iterator that points to the first message in this
- Maildir. If there are no messages, returns the invalid position
- equal to end().
-
- \param mod The flags.
- */
- Mailbox::iterator begin(const SequenceSet &bset,
- unsigned int mod = INCLUDE_EXPUNGED | SQNR_MODE) const;
-
- /*!
- Returns an iterator that points to the invalid position after
- the last (if any) message in the Maildir.
- */
+ Mailbox::iterator begin(const SequenceSet &bset, unsigned int mod = INCLUDE_EXPUNGED | SQNR_MODE) const;
Mailbox::iterator end(void) const;
- /*!
- Returns the maximum UID value of all messages in this Maildir.
- */
unsigned int getMaxUid(void) const;
-
- /*!
- Returns the maximum sequence number of all messages in this
- Maildir. This is equal to the number of messages.
- */
unsigned int getMaxSqnr(void) const;
-
- /*!
- Returns the Maildir's UIDVALIDITY.
- */
unsigned int getUidValidity(void) const;
-
- /*!
- Returns the next UID that will be assigned by this Maildir
- (UIDNEXT).
- */
unsigned int getUidNext(void) const;
- /*!
- Returns certain changes to the Maildir since the last time a
- similar check was done. Returns true if the check succeeed;
- otherwise returns false.
-
- \param doscan If true, the depository will be scanned for
- changes. Otherwise the cached information is checked.
- \param type A bitwise mask of the types of changes to check
- for. See also PendingUpdates.
- \param updates A reference to a structure where the changes are
- stored.
- */
bool getUpdates(bool doscan, unsigned int type,
PendingUpdates &updates);
- /*!
- Returns the file system path to the Maildir.
- */
const std::string &getPath(void) const;
-
- /*!
- Sets the file system path to the Maildir.
- */
void setPath(const std::string &path_in);
- /*!
- Advances UIDVALIDITY. Resets the internal cache and drops the
- UID values of the Maildir, forcing the server to re-delegate
- UIDs the next time the mailbox is selected.
-
- \param path The path of the Maildir whose UIDVALIDITY is to be
- bumped.
- */
- void bumpUidValidity(const std::string &path) const;
-
- /*!
- Returns a unique ID that represents the state of the mailbox.
- If a change is made to the mailbox, this status ID must also
- change unconditionally. This value should be very quick to
- calculate, and scanning the mailbox should be avoided.
-
- \param path The path to the Maildir whose status ID is returned.
- */
- unsigned int getStatusID(const std::string &path) const;
-
- /*!
- Fetches the status of a Maildir at a certain path, such as the
- number of messages, the UIDVALIDITY value, the UIDNEXT value,
- the number of recent and unseen messages.
-
- \param path The path to the Maildir whose status is fetched
- \param status A Status structure that is fed with the status
- of the mailbox.
- */
- bool getStatus(const std::string &path, Status &status) const;
-
- /*!
- Commits the in-memory message flags to the mailbox.
- */
- void updateFlags(void);
-
- /*!
- Returns true if a directory entry qualifies as a Maildir;
- otherwise returns false. The criteria are that the entry is a
- directory, and that it contains the subdirectories cur, new and
- tmp.
-
- \param path The path to the directory that is evaluated.
- */
- bool isMailbox(const std::string &path) const;
+ void bumpUidValidity(const std::string &) const;
- /*!
- Returns true if a Maildir directory entry contains recent
- messages; otherwise returns false.
+ unsigned int getStatusID(const std::string &) const;
+ bool getStatus(const std::string &, Status &) const;
+ void updateFlags(void);
- \param path The path to the directory that is evaluated.
- */
+ bool isMailbox(const std::string &) const;
bool isMarked(const std::string &) const;
-
- /*!
- Selects a mailbox. Returns true if the select was successful;
- otherwise returns false.
-
- \param name The IMAP name of the mailbox.
- \param path The file system path to the mailbox.
- */
- bool selectMailbox(const std::string &name, const std::string &path);
-
- /*!
- Closes any selected mailbox.
- */
+ bool selectMailbox(const std::string &name, const std::string &s_in);
void closeMailbox(void);
-
- /*!
- Expunges all messages from the mailbox that have the \Deleted
- flag set.
- */
void expungeMailbox(void);
+ bool createMailbox(const std::string &s, mode_t mode, uid_t owner = 0, gid_t group = 0, bool root = false);
+ bool deleteMailbox(const std::string &s);
- /*!
- Creates a Maildir. Returns true if the create succeeded;
- otherwise returns false.
-
- \param path The file system path to the new Maildir.
- \param mode The file system mode to use when creating the mailbox.
- \param owner The unix user that will own the mailbox.
- \param group The unix group that will own the mailbox.
- \param root If true, the Maildir at "." is created.
- */
- bool createMailbox(const std::string &path, mode_t mode, uid_t owner = 0, gid_t group = 0, bool root = false);
-
- /*!
- Deletes a Maildir. Removes all messages and returns true on
- success. If false is returned, the state of the Maildir is
- undefined.
-
- \param path The path to the Maildir to be deleted.
- */
- bool deleteMailbox(const std::string &path);
-
- /*!
- Creates a message in a mailbox, with a given internal date.
- Returns a pointer to a MaildirMessage which is still open. Data
- is then written to the message with Message::appendChunk, and
- Message::close is then called. When done with creating messages,
- commitNewMessages() will move the message into new/ and then
- cur/.
-
- \param path The path to the Maildir in which the message is
- created.
- \param idate The internal date of the message, in UNIX local
- time.
- */
- Message *createMessage(const std::string &path, time_t idate = 0);
-
- /*!
- Commits all newly created messages in a Maildir. These messages
- recide in tmp/, and after this function has been called, they
- will have shortly visited new/ before being moved to
- cur/. Returns true if the commit succeeded; otherwise returns
- false.
-
- \param path The path to the Maildir in which new messages should
- be committed.
- */
- bool commitNewMessages(const std::string &path);
-
- /*!
- Removes all newly created messages that have not been
- committed. If the rollback failed for any reason, false is
- returned. Otherwise returns true.
- */
+ Message *createMessage(const std::string &mbox, time_t idate = 0);
+ bool commitNewMessages(const std::string &mbox);
bool rollBackNewMessages(void);
-
- /*!
- Attempts to copy a message to a mailbox using a method that is
- faster that copying bytes. Returns true on success, otherwise
- returns false.
- */
+
bool fastCopy(Message &source, Mailbox &desttype, const std::string &destname);
//--
