aboutsummaryrefslogtreecommitdiff
path: root/vmime-master/src/vmime/mailboxList.hpp
diff options
context:
space:
mode:
Diffstat (limited to 'vmime-master/src/vmime/mailboxList.hpp')
-rw-r--r--vmime-master/src/vmime/mailboxList.hpp184
1 files changed, 184 insertions, 0 deletions
diff --git a/vmime-master/src/vmime/mailboxList.hpp b/vmime-master/src/vmime/mailboxList.hpp
new file mode 100644
index 0000000..8d799d2
--- /dev/null
+++ b/vmime-master/src/vmime/mailboxList.hpp
@@ -0,0 +1,184 @@
+//
+// VMime library (http://www.vmime.org)
+// Copyright (C) 2002 Vincent Richard <vincent@vmime.org>
+//
+// This program is free software; you can redistribute it and/or
+// modify it under the terms of the GNU General Public License as
+// published by the Free Software Foundation; either version 3 of
+// the License, or (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+// General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License along
+// with this program; if not, write to the Free Software Foundation, Inc.,
+// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+//
+// Linking this library statically or dynamically with other modules is making
+// a combined work based on this library. Thus, the terms and conditions of
+// the GNU General Public License cover the whole combination.
+//
+
+#ifndef VMIME_MAILBOXLIST_HPP_INCLUDED
+#define VMIME_MAILBOXLIST_HPP_INCLUDED
+
+
+#include "vmime/addressList.hpp"
+#include "vmime/mailbox.hpp"
+
+
+namespace vmime {
+
+
+/** A list of mailboxes (basic type).
+ *
+ * This class works exactly like 'addressList' except it prevents user
+ * from inserting mailbox groups where it is not allowed by the RFC.
+ */
+class VMIME_EXPORT mailboxList : public headerFieldValue {
+
+public:
+
+ mailboxList();
+ mailboxList(const mailboxList& mboxList);
+
+
+ shared_ptr <component> clone() const;
+ void copyFrom(const component& other);
+ mailboxList& operator=(const mailboxList& other);
+
+ const std::vector <shared_ptr <component> > getChildComponents();
+
+ /** Add a mailbox at the end of the list.
+ *
+ * @param mbox mailbox to append
+ */
+ void appendMailbox(const shared_ptr <mailbox>& mbox);
+
+ /** Insert a new mailbox before the specified mailbox.
+ *
+ * @param beforeMailbox mailbox before which the new mailbox will be inserted
+ * @param mbox mailbox to insert
+ * @throw std::out_of_range if the mailbox is not in the list
+ */
+ void insertMailboxBefore(const shared_ptr <mailbox>& beforeMailbox, const shared_ptr <mailbox>& mbox);
+
+ /** Insert a new mailbox before the specified position.
+ *
+ * @param pos position at which to insert the new mailbox (0 to insert at
+ * the beginning of the list)
+ * @param mbox mailbox to insert
+ * @throw std::out_of_range if the position is out of range
+ */
+ void insertMailboxBefore(const size_t pos, const shared_ptr <mailbox>& mbox);
+
+ /** Insert a new mailbox after the specified mailbox.
+ *
+ * @param afterMailbox mailbox after which the new mailbox will be inserted
+ * @param mbox mailbox to insert
+ * @throw std::out_of_range if the mailbox is not in the list
+ */
+ void insertMailboxAfter(const shared_ptr <mailbox>& afterMailbox, const shared_ptr <mailbox>& mbox);
+
+ /** Insert a new mailbox after the specified position.
+ *
+ * @param pos position of the mailbox before the new mailbox
+ * @param mbox mailbox to insert
+ * @throw std::out_of_range if the position is out of range
+ */
+ void insertMailboxAfter(const size_t pos, const shared_ptr <mailbox>& mbox);
+
+ /** Remove the specified mailbox from the list.
+ *
+ * @param mbox mailbox to remove
+ * @throw std::out_of_range if the mailbox is not in the list
+ */
+ void removeMailbox(const shared_ptr <mailbox>& mbox);
+
+ /** Remove the mailbox at the specified position.
+ *
+ * @param pos position of the mailbox to remove
+ * @throw std::out_of_range if the position is out of range
+ */
+ void removeMailbox(const size_t pos);
+
+ /** Remove all mailboxes from the list.
+ */
+ void removeAllMailboxes();
+
+ /** Return the number of mailboxes in the list.
+ *
+ * @return number of mailboxes
+ */
+ size_t getMailboxCount() const;
+
+ /** Tests whether the list of mailboxes is empty.
+ *
+ * @return true if there is no mailbox, false otherwise
+ */
+ bool isEmpty() const;
+
+ /** Return the mailbox at the specified position.
+ *
+ * @param pos position
+ * @return mailbox at position 'pos'
+ * @throw std::out_of_range if the position is out of range
+ */
+ shared_ptr <mailbox> getMailboxAt(const size_t pos);
+
+ /** Return the mailbox at the specified position.
+ *
+ * @param pos position
+ * @return mailbox at position 'pos'
+ * @throw std::out_of_range if the position is out of range
+ */
+ const shared_ptr <const mailbox> getMailboxAt(const size_t pos) const;
+
+ /** Return the mailbox list.
+ *
+ * @return list of mailboxes
+ */
+ const std::vector <shared_ptr <const mailbox> > getMailboxList() const;
+
+ /** Return the mailbox list.
+ *
+ * @return list of mailboxes
+ */
+ const std::vector <shared_ptr <mailbox> > getMailboxList();
+
+ /** Return a list of addresses.
+ *
+ * @return list of addresses
+ */
+ shared_ptr <addressList> toAddressList() const;
+
+private:
+
+ addressList m_list;
+
+protected:
+
+ // Component parsing & assembling
+ void parseImpl(
+ const parsingContext& ctx,
+ const string& buffer,
+ const size_t position,
+ const size_t end,
+ size_t* newPosition = NULL
+ );
+
+ void generateImpl(
+ const generationContext& ctx,
+ utility::outputStream& os,
+ const size_t curLinePos = 0,
+ size_t* newLinePos = NULL
+ ) const;
+};
+
+
+} // vmime
+
+
+#endif // VMIME_MAILBOXLIST_HPP_INCLUDED