src/Imap/ConnectionState.h

0001 /* Copyright (C) 2006 - 2014 Jan Kundrát <jkt@flaska.net>
0002
0003    This file is part of the Trojita Qt IMAP e-mail client,
0004    http://trojita.flaska.net/
0005
0006    This program is free software; you can redistribute it and/or
0007    modify it under the terms of the GNU General Public License as
0008    published by the Free Software Foundation; either version 2 of
0009    the License or (at your option) version 3 or any later version
0010    accepted by the membership of KDE e.V. (or its successor approved
0011    by the membership of KDE e.V.), which shall act as a proxy
0012    defined in Section 14 of version 3 of the license.
0013
0014    This program is distributed in the hope that it will be useful,
0015    but WITHOUT ANY WARRANTY; without even the implied warranty of
0016    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
0017    GNU General Public License for more details.
0018
0019    You should have received a copy of the GNU General Public License
0020    along with this program.  If not, see <http://www.gnu.org/licenses/>.
0021 */
0022 #ifndef IMAP_CONNECTIONSTATE_H
0023 #define IMAP_CONNECTIONSTATE_H
0024
0025 #include <QString>
0026
0027 namespace Imap
0028 {
0029
0030 /** @short A human-readable state of the connection to the IMAP server */
0031 typedef enum {
0032     CONN_STATE_NONE, /**< @short Initial state */
0033     CONN_STATE_HOST_LOOKUP, /**< @short Resolving hostname */
0034     CONN_STATE_CONNECTING, /**< @short Connecting to the remote host or starting the process */
0035     CONN_STATE_SSL_HANDSHAKE, /**< @short The SSL encryption is starting */
0036     CONN_STATE_SSL_VERIFYING, /**< @short The SSL connection processing is waiting for policy decision about whether to proceed or not */
0037     CONN_STATE_CONNECTED_PRETLS_PRECAPS, /**< @short Connection has been established but there's been no CAPABILITY yet */
0038     CONN_STATE_CONNECTED_PRETLS, /**< @short Connection has been established and capabilities are known but STARTTLS remains to be issued */
0039     CONN_STATE_STARTTLS_ISSUED, /**< @short The STARTTLS command has been sent */
0040     CONN_STATE_STARTTLS_HANDSHAKE, /**< @short The socket is starting encryption */
0041     CONN_STATE_STARTTLS_VERIFYING, /** @short The STARTTLS processing is waiting for policy decision about whether to proceed or not */
0042     CONN_STATE_ESTABLISHED_PRECAPS, /**< @short Waiting for capabilities after the encryption has been set up */
0043     CONN_STATE_LOGIN, /**< @short Performing login */
0044     CONN_STATE_POSTAUTH_PRECAPS, /**< @short Authenticated, but capabilities weren't refreshed yet */
0045     CONN_STATE_COMPRESS_DEFLATE, /**< @short Activating COMPRESS DEFLATE */
0046     CONN_STATE_AUTHENTICATED, /**< @short Logged in */
0047     CONN_STATE_SELECTING_WAIT_FOR_CLOSE, /**< @short Will be selecting another mailbox -- waiting for the CLOSED response code */
0048     CONN_STATE_SELECTING, /**< @short Selecting a mailbox -- waiting for mailbox metadata */
0049     CONN_STATE_SYNCING, /**< @short Selecting a mailbox -- performing synchronization */
0050     CONN_STATE_SELECTED, /**< @short Mailbox is selected and synchronized */
0051     CONN_STATE_FETCHING_PART, /** @short Downloading an actual body part */
0052     CONN_STATE_FETCHING_MSG_METADATA, /** @short Retrieving message metadata */
0053     CONN_STATE_LOGOUT, /**< @short Logging out */
0054 } ConnectionState;
0055
0056 QString connectionStateToString(const ConnectionState state);
0057
0058 }
0059
0060 #endif // IMAP_CONNECTIONSTATE_H