imapcommand.h

#ifndef _IMAPCOMMAND_H
#define _IMAPCOMMAND_H
/**********************************************************************
 *
 *   imapcommand.h  - IMAP4rev1 command handler
 *   Copyright (C) 2000 Sven Carstens <s.carstens@gmx.de>
 *
 *   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.
 *
 *   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.
 *
 *   Send comments and bug fixes to
 *
 *********************************************************************/

#include <QStringList>
#include <QString>
#include <QMap>

#include <boost/shared_ptr.hpp>

class imapCommand;
typedef boost::shared_ptr<imapCommand> CommandPtr;

class imapCommand
{
public:

  imapCommand ();
  imapCommand (const QString & command, const QString & parameter);
  bool isComplete ();
  const QString & result ();
  const QString & resultInfo ();
  const QString & parameter ();
  const QString & command ();
  const QString & id ();

  void setId (const QString &);
  void setComplete ();
  void setResult (const QString &);
  void setResultInfo (const QString &);
  void setCommand (const QString &);
  void setParameter (const QString &);
  const QString getStr ();

  static CommandPtr clientNoop ();
  static CommandPtr clientFetch (ulong uid, const QString & fields,
                                 bool nouid = false);
  static CommandPtr clientFetch (ulong fromUid, ulong toUid,
                                 const QString & fields, bool nouid =
                                 false);
  static CommandPtr clientFetch (const QString & sequence,
                                 const QString & fields, bool nouid =
                                 false);
  static CommandPtr clientList (const QString & reference,
                                const QString & path, bool lsub = false);
  static CommandPtr clientSelect (const QString & path, bool examine =
                                  false);
  static CommandPtr clientClose();
  static CommandPtr clientStatus (const QString & path,
                                  const QString & parameters);
  static CommandPtr clientCopy (const QString & box,
                                const QString & sequence, bool nouid =
                                false);
  static CommandPtr clientAppend (const QString & box,
                                  const QString & flags, ulong size);
  static CommandPtr clientCreate (const QString & path);
  static CommandPtr clientDelete (const QString & path);
  static CommandPtr clientSubscribe (const QString & path);
  static CommandPtr clientUnsubscribe (const QString & path);
  static CommandPtr clientExpunge ();
  static CommandPtr clientRename (const QString & src,
                                  const QString & dest);
  static CommandPtr clientSearch (const QString & search, bool nouid =
                                  false);
  static CommandPtr clientStore (const QString & set, const QString & item,
                                 const QString & data, bool nouid = false);
  static CommandPtr clientLogout ();
  static CommandPtr clientStartTLS ();


  static CommandPtr clientSetACL ( const QString& box, const QString& user, const QString& acl );

  static CommandPtr clientDeleteACL ( const QString& box, const QString& user );

  static CommandPtr clientGetACL ( const QString& box );

  static CommandPtr clientListRights ( const QString& box, const QString& user );

  static CommandPtr clientMyRights ( const QString& box );


  static CommandPtr clientSetAnnotation ( const QString& box, const QString& entry, const QMap<QString, QString>& attributes );

  static CommandPtr clientGetAnnotation ( const QString& box, const QString& entry, const QStringList& attributeNames );

  static CommandPtr clientNamespace ();

  static CommandPtr clientGetQuotaroot ( const QString& box );

  static CommandPtr clientCustom ( const QString& command, const QString& arguments );

protected:
  QString aCommand;
  QString mId;
  bool mComplete;
  QString aParameter;
  QString mResult;
  QString mResultInfo;

private:
  imapCommand & operator = (const imapCommand &);
};

#endif