1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
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
|
