/*
    kmime_newsarticle.h

    KMime, the KDE Internet mail/usenet news message library.
    Copyright (c) 2001 the KMime authors.
    See file AUTHORS for details

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.

    This library 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
    Library General Public License for more details.

    You should have received a copy of the GNU Library General Public License
    along with this library; see the file COPYING.LIB.  If not, write to
    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
    Boston, MA 02110-1301, USA.
*/
#ifndef __KMIME_NEWSARTICLE_H__
#define __KMIME_NEWSARTICLE_H__

#include "kmime_export.h"
#include "kmime_message.h"
#include <kpimutils/supertrait.h>

namespace KMime {

class NewsArticlePrivate;

class KMIME_EXPORT NewsArticle : public Message
{
  public:
    /**
      A shared pointer to a news article.
    */
    typedef boost::shared_ptr<NewsArticle> Ptr;

    /**
      Creates a NewsArticle object.
    */
    NewsArticle();

    /**
      Destroys this NewsArticle.
    */
    ~NewsArticle();

    /* reimpl */
    virtual void parse();

    /* reimpl */
    virtual void clear();

    /* reimpl */
    virtual KMIME_DEPRECATED KMime::Headers::Base * getHeaderByType( const char *type );

    /* reimpl */
    virtual KMime::Headers::Base * headerByType( const char *type );

    /* reimpl */
    virtual void setHeader( KMime::Headers::Base *h );

    /* reimpl */
    virtual bool removeHeader( const char *type );

    /**
      Returns the Control header.
      @param create If true, create the header if it doesn't exist yet.
    */
    virtual KMime::Headers::Control *control( bool create = true );

    /**
      Returns the Supersedes header.
      @param create If true, create the header if it doesn't exist yet.
    */
    virtual KMime::Headers::Supersedes *supersedes( bool create = true );

    /**
      Returns the Mail-Copies-To header.
      @param create If true, create the header if it doesn't exist yet.
    */
    virtual KMime::Headers::MailCopiesTo *mailCopiesTo( bool create = true );

    /**
      Returns the Newsgroups header.
      @param create If true, create the header if it doesn't exist yet.
    */
    virtual KMime::Headers::Newsgroups *newsgroups( bool create = true );

    /**
      Returns the Follow-Up-To header.
      @param create If true, create the header if it doesn't exist yet.
    */
    virtual KMime::Headers::FollowUpTo *followUpTo( bool create = true );

    /**
      Returns the Lines header.
      @param create If true, create the header if it doesn't exist yet.
    */
    virtual KMime::Headers::Lines *lines( bool create = true );

  protected:
    /* reimpl */
    virtual QByteArray assembleHeaders();

  private:
    Q_DECLARE_PRIVATE( NewsArticle )

}; // class NewsArticle

} // namespace KMime


//@cond PRIVATE
// super class trait specialization
namespace KPIMUtils {
  template <> struct SuperClass<KMime::NewsArticle> : public SuperClassTrait<KMime::Message>{};
}
//@endcond

#endif // __KMIME_NEWSARTICLE_H__