mailbox.h

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

    $Id: mailbox_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_MAILBOX_H_
#define _MIMETIC_RFC822_MAILBOX_H_
#include <string>
#include <mimetic/rfc822/fieldvalue.h>
namespace mimetic
{



/// Represents a \e mailbox email address as defined in the RFC822
/**
    Use this class if you want to build or parse email addresses. Each email address
    as defined by RFC822 have a mailbox std::string, a domain name, a sourceroute and
    a label. Note that just mailbox and domain are mandatory.
    Mailboxes can be represented in different ways, can contain rfc822 comments and
    blank spaces, can be double-quoted and contain source route. Please read the
    RFC822 for details.

    Parsing:
    \code
    Mailbox mbx("Mario (Spider)Rossi <@[email protected]:[email protected]>");
    cout << mbx.mailbox() << endl;
    cout << mbx.domain() << endl;
    cout << mbx.label() << endl;
    cout << mbx.sourceroute() << endl;
    cout << mbx.text() << endl;
    \endcode

    Building:
    \code
    Mailbox mbx;
    mbx.mailbox("mrossi");
    mbx.domain("dom.it");
    mbx.label("Mario (Spider)Rossi");
    mbx.sourceroute("@[email protected]");
    \endcode

    \sa <a href="../RFC/rfc822.txt">RFC822</a>
 */
struct Mailbox: public FieldValue
{
    Mailbox();
    Mailbox(const char*);
    Mailbox(const std::string&);
    void mailbox(const std::string&);
    void domain(const std::string&);    
    void label(const std::string&);
    void sourceroute(const std::string&);
    std::string mailbox(int bCanonical = 1) const;
    std::string domain(int bCanonical = 1) const;    
    std::string label(int bCanonical = 0) const;
    std::string sourceroute(int bCanonical = 1) const;
    bool operator==(const Mailbox&) const;
    bool operator!=(const Mailbox&) const;
    void set(const std::string&);
    std::string str() const;
protected:
    FieldValue* clone() const;
private:
    std::string m_mailbox, m_domain, m_label, m_route;
};


}

#endif