• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdepimlibs-4.8.5 API Reference
  • KDE Home
  • Contact Us
 

KIMAP Library

session.h
00001 /*
00002     Copyright (c) 2009 Kevin Ottens <ervin@kde.org>
00003 
00004     This library is free software; you can redistribute it and/or modify it
00005     under the terms of the GNU Library General Public License as published by
00006     the Free Software Foundation; either version 2 of the License, or (at your
00007     option) any later version.
00008 
00009     This library is distributed in the hope that it will be useful, but WITHOUT
00010     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00011     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Library General Public
00012     License for more details.
00013 
00014     You should have received a copy of the GNU Library General Public License
00015     along with this library; see the file COPYING.LIB.  If not, write to the
00016     Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
00017     02110-1301, USA.
00018 */
00019 
00020 #ifndef KIMAP_SESSION_H
00021 #define KIMAP_SESSION_H
00022 
00023 #include "kimap_export.h"
00024 
00025 #include <QtCore/QObject>
00026 
00027 #include "sessionuiproxy.h"
00028 
00029 class KSslErrorUiData;
00030 
00031 namespace KIMAP {
00032 
00033 class SessionPrivate;
00034 class JobPrivate;
00035 struct Message;
00036 
00037 class KIMAP_EXPORT Session : public QObject
00038 {
00039   Q_OBJECT
00040   Q_ENUMS(State)
00041 
00042   friend class JobPrivate;
00043 
00044   public:
00045     enum State { Disconnected = 0, NotAuthenticated, Authenticated, Selected };
00046 
00047     Session( const QString &hostName, quint16 port, QObject *parent=0 );
00048     ~Session();
00049 
00050     QString hostName() const;
00051     quint16 port() const;
00052     State state() const;
00053 
00060     QString userName() const;
00061 
00062     QByteArray serverGreeting() const;
00063 
00068     void setUiProxy(SessionUiProxy::Ptr proxy);
00069 
00075     KDE_DEPRECATED void setUiProxy(SessionUiProxy *proxy);
00076 
00082     void setTimeout( int timeout );
00083 
00088     QString selectedMailBox() const;
00089 
00090     int jobQueueSize() const;
00091 
00092     void close();
00093 
00094   Q_SIGNALS:
00095     void jobQueueSizeChanged( int queueSize );
00096 
00109     KDE_DEPRECATED void connectionLost();
00110 
00122     void connectionFailed();
00123 
00135     void stateChanged(KIMAP::Session::State newState, KIMAP::Session::State oldState);
00136 
00137   private:
00138     Q_PRIVATE_SLOT( d, void doStartNext() )
00139     Q_PRIVATE_SLOT( d, void jobDone( KJob* ) )
00140     Q_PRIVATE_SLOT( d, void jobDestroyed( QObject* ) )
00141     Q_PRIVATE_SLOT( d, void responseReceived( const KIMAP::Message& ) )
00142 
00143     Q_PRIVATE_SLOT( d, void socketConnected() )
00144     Q_PRIVATE_SLOT( d, void socketDisconnected() )
00145     Q_PRIVATE_SLOT( d, void socketError() )
00146     Q_PRIVATE_SLOT( d, void socketActivity() )
00147 
00148     Q_PRIVATE_SLOT( d, void handleSslError( const KSslErrorUiData &errorData ) )
00149 
00150     friend class SessionPrivate;
00151     SessionPrivate *const d;
00152 };
00153 
00154 }
00155 
00156 #endif
This file is part of the KDE documentation.
Documentation copyright © 1996-2012 The KDE developers.
Generated on Thu Aug 2 2012 15:24:24 by doxygen 1.7.5 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

KIMAP Library

Skip menu "KIMAP Library"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • Related Pages

kdepimlibs-4.8.5 API Reference

Skip menu "kdepimlibs-4.8.5 API Reference"
  • akonadi
  •   contact
  •   kmime
  • kabc
  • kalarmcal
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  •   richtextbuilders
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal