group.h

/***************************************************************************
    copyright            : (C) 2002-2005 by Stefano Barbato
    email                : [email protected]

    $Id: group_8h-source.html,v 1.4 2006-03-12 12:28:31 tat Exp $
 ***************************************************************************/

/***************************************************************************
 *                                                                         *
 *   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 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
#ifndef _MIMETIC_RFC822_GROUP_H_
#define _MIMETIC_RFC822_GROUP_H_
#include <string>
#include <vector>
#include <mimetic/rfc822/mailbox.h>

namespace mimetic
{


/// Represent the \e group type in the RFC822
/**
    Groups class is a container class that stores Rfc822::Mailbox objects.
    Use this class when you need to create or parse rfc822 \e email \e groups

    Parsing:
    \code
    Rfc822::Group grp("drivers: [email protected], [email protected], [email protected];");
    Rfc822::Group::const_iterator bit(grp.begin()), eit(grp.end());
    cout << "Group " << grp.name() << endl;
    for(; bit != eit; ++bit)
        cout << "    " << *bit << endl;
    \endcode

    Building:
    \code
    Rfc822::Group grp;
    grp.push_back("[email protected]");
    grp.push_back(Rfc822::Mailbox("[email protected]"));
    grp.push_back(string("[email protected]"));
    \endcode

    \sa <a href="../RFC/rfc822.txt">RFC822</a>
 */
struct Group: public FieldValue, public std::vector<Mailbox>
{
    Group();
    Group(const char*);
    Group(const std::string&);
    void name(const std::string&);
    std::string name(int bCanonical = 0) const;
    void set(const std::string&);
    std::string str() const;
protected:
    FieldValue* clone() const;
private:
    std::string m_text, m_name;
};


}
#endif