summaryrefslogtreecommitdiff
path: root/kimap/loginjob.h
diff options
context:
space:
mode:
authorChristian Mollekopf <chrigi_1@fastmail.fm>2012-06-25 23:43:13 (GMT)
committerChristian Mollekopf <chrigi_1@fastmail.fm>2012-06-25 23:43:13 (GMT)
commite21e62c14f5aae99d46643065fcb86e2e3abe230 (patch)
tree71d79d2de0b0f82f8b0a6ca3b8b09308d198ed33 /kimap/loginjob.h
parent172803b38237e38a494aca62fffda918e5799d20 (diff)
downloadlibcalendaring-e21e62c14f5aae99d46643065fcb86e2e3abe230.tar.gz
initial import of kimap from
commit b54a325116b194da090f900c9a538710759eb303 Author: Stephen Kelly <steveire@gmail.com> Date: Sun May 6 20:44:53 2012 +0200 Revert "Port to const QRegExp API." This reverts commit 0ca0dfc7e0ca8095efd0b060d1d5e26ac9ceb379. The qtbase commit requiring this was reverted.
Diffstat (limited to 'kimap/loginjob.h')
-rw-r--r--kimap/loginjob.h113
1 files changed, 113 insertions, 0 deletions
diff --git a/kimap/loginjob.h b/kimap/loginjob.h
new file mode 100644
index 0000000..0967348
--- /dev/null
+++ b/kimap/loginjob.h
@@ -0,0 +1,113 @@
+/*
+ Copyright (c) 2009 Kevin Ottens <ervin@kde.org>
+ Copyright (c) 2009 Andras Mantia <amantia@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 KIMAP_LOGINJOB_H
+#define KIMAP_LOGINJOB_H
+
+#include "kimap_export.h"
+
+#include "job.h"
+
+namespace KIMAP {
+
+class Session;
+struct Message;
+class LoginJobPrivate;
+
+class KIMAP_EXPORT LoginJob : public Job
+{
+ Q_OBJECT
+ Q_DECLARE_PRIVATE(LoginJob)
+
+ friend class SessionPrivate;
+
+ public:
+ enum EncryptionMode {
+ Unencrypted = 0,
+ TlsV1,
+ SslV2,
+ SslV3,
+ SslV3_1,
+ AnySslVersion
+ };
+
+ enum AuthenticationMode {
+ ClearText = 0,
+ Login,
+ Plain,
+ CramMD5,
+ DigestMD5,
+ NTLM,
+ GSSAPI,
+ Anonymous
+ };
+
+ enum ErrorCode {
+ ERR_COULD_NOT_CONNECT = KJob::UserDefinedError + 23 // same as in kio
+ };
+
+ explicit LoginJob( Session *session );
+ virtual ~LoginJob();
+
+ QString userName() const;
+ void setUserName( const QString &userName );
+
+ QString password() const;
+ void setPassword( const QString &password );
+
+ /**
+ * Returns the server greeting, in case of a successful login.
+ * If the login wasn't successful, this method returns an empty string. Use errorString() to
+ * get the error message in this case.
+ *
+ * Note that the content of this response is not defined by the IMAP protocol and is
+ * implementation-dependent.
+ * @since 4.7
+ */
+ QString serverGreeting() const;
+
+ /**
+ * Set the encryption mode for the connection. In case an encryption mode is set, the caller
+ * MUST check the encryptionMode() result after executing the job, to see if the connection is
+ * encrypted or not (e.g handshaking failed).
+ * @param mode the encryption mode, see EncryptionModes
+ */
+ void setEncryptionMode(EncryptionMode mode);
+
+ /**
+ Get the encryption mode.
+ @return the currently active encryption mode
+ */
+ EncryptionMode encryptionMode();
+
+ void setAuthenticationMode( AuthenticationMode mode );
+
+ protected:
+ virtual void doStart();
+ virtual void handleResponse( const Message &response );
+ virtual void connectionLost();
+
+ private:
+ Q_PRIVATE_SLOT( d_func(), void sslResponse(bool) )
+};
+
+}
+
+#endif