transport.h

/*
    Copyright (c) 2006 - 2007 Volker Krause <vkrause@kde.org>

    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 MAILTRANSPORT_TRANSPORT_H
#define MAILTRANSPORT_TRANSPORT_H

#include <mailtransport/mailtransport_export.h>
#include <mailtransport/transportbase.h>
#include <mailtransport/transporttype.h>

class TransportPrivate;

namespace MailTransport {

class TransportType;

// TODO KDE5: Do something about the kcfg-generated TransportBase.
// Currently it has the config stuff as private members, which means it is
// utterly inextensible.  Also the sendmail and akonadi-type transports use
// the "host" setting for keeping the location of the sendmail executable and
// the resource id, respectively.  This is a hack; they should have separate
// config options... (cberzan)
class MAILTRANSPORT_EXPORT Transport : public TransportBase
{
  Q_OBJECT
  friend class TransportManager;
  friend class TransportManagerPrivate;

  public:
    virtual ~Transport();

    typedef QList<Transport*> List;

    bool isValid() const;

    QString password();

    void setPassword( const QString &passwd );

    void forceUniqueName();

    void updatePasswordState();

    bool isComplete() const;

    QString authenticationTypeString() const;

    static QString authenticationTypeString( int type );

    Transport *clone() const;

    TransportType transportType() const;

    void setTransportType( const TransportType &type );

  protected:
    Transport( const QString &cfgGroup );

    virtual void usrReadConfig();
    virtual void usrWriteConfig();

    bool needsWalletMigration() const;

    void migrateToWallet();

  private Q_SLOTS:

    // Used by our friend, TransportManager
    void readPassword();

  private:
    TransportPrivate *const d;
};

} // namespace MailTransport

#endif // MAILTRANSPORT_TRANSPORT_H