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

KIMAP Library

  • sources
  • kde-4.14
  • kdepimlibs
  • kimap
session.h
1 /*
2  Copyright (c) 2009 Kevin Ottens <ervin@kde.org>
3 
4  This library is free software; you can redistribute it and/or modify it
5  under the terms of the GNU Library General Public License as published by
6  the Free Software Foundation; either version 2 of the License, or (at your
7  option) any later version.
8 
9  This library is distributed in the hope that it will be useful, but WITHOUT
10  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11  FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public
12  License for more details.
13 
14  You should have received a copy of the GNU Library General Public License
15  along with this library; see the file COPYING.LIB. If not, write to the
16  Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
17  02110-1301, USA.
18 */
19 
20 #ifndef KIMAP_SESSION_H
21 #define KIMAP_SESSION_H
22 
23 #include "kimap_export.h"
24 
25 #include <QtCore/QObject>
26 
27 #include "sessionuiproxy.h"
28 
29 class KSslErrorUiData;
30 
31 namespace KIMAP {
32 
33 class SessionPrivate;
34 class JobPrivate;
35 struct Message;
36 
37 class KIMAP_EXPORT Session : public QObject
38 {
39  Q_OBJECT
40  Q_ENUMS( State )
41 
42  friend class JobPrivate;
43 
44  public:
45  enum State { Disconnected = 0, NotAuthenticated, Authenticated, Selected };
46 
47  Session( const QString &hostName, quint16 port, QObject *parent=0 );
48  ~Session();
49 
50  QString hostName() const;
51  quint16 port() const;
52  State state() const;
53 
60  QString userName() const;
61 
62  QByteArray serverGreeting() const;
63 
68  void setUiProxy(SessionUiProxy::Ptr proxy);
69 
75  KIMAP_DEPRECATED void setUiProxy(SessionUiProxy *proxy);
76 
82  void setTimeout( int timeout );
83 
88  int timeout() const;
89 
94  QString selectedMailBox() const;
95 
96  int jobQueueSize() const;
97 
98  void close();
99 
100  Q_SIGNALS:
101  void jobQueueSizeChanged( int queueSize );
102 
115  KIMAP_DEPRECATED void connectionLost();
116 
128  void connectionFailed();
129 
141  void stateChanged(KIMAP::Session::State newState, KIMAP::Session::State oldState);
142 
143  private:
144  friend class SessionPrivate;
145  SessionPrivate *const d;
146 };
147 
148 }
149 
150 #endif
QByteArray
QObject
QString
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Mon Jun 22 2020 13:37:03 by doxygen 1.8.7 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 API Reference

Skip menu "kdepimlibs API Reference"
  • akonadi
  •   contact
  •   kmime
  •   socialutils
  • kabc
  • kalarmcal
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2

Search



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