aboutsummaryrefslogtreecommitdiffstats
path: root/src/smtp/smtpclient.h
blob: 29c507dc456f87c287fa5031e580378eeb01022d (plain)
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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
/*
  Copyright (c) 2011-2012 - Tőkés Attila

  This file is part of SmtpClient for Qt.

  This library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Lesser General Public
  License as published by the Free Software Foundation; either
  version 2.1 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
  Lesser General Public License for more details.

  See the LICENSE file for more details.
*/

#ifndef SMTPCLIENT_H
#define SMTPCLIENT_H

#include <QObject>
#include <QtNetwork/QSslSocket>

#include "mimemessage.h"
#include "smtpexports.h"

class SMTP_EXPORT SmtpClient : public QObject {
Q_OBJECT
public:

    /* [0] Enumerations */

    enum AuthMethod {
        AuthPlain,
        AuthLogin
    };

    enum SmtpError {
        ConnectionTimeoutError,
        ResponseTimeoutError,
        SendDataTimeoutError,
        AuthenticationFailedError,
        ServerError,    // 4xx smtp error
        ClientError     // 5xx smtp error
    };

    enum ConnectionType {
        TcpConnection,
        SslConnection,
        TlsConnection       // STARTTLS
    };

    /* [0] --- */


    /* [1] Constructors and Destructors */

    explicit SmtpClient(const QString &host = "localhost", int port = 25, ConnectionType ct = TcpConnection);

    ~SmtpClient() override;

    /* [1] --- */


    /* [2] Getters and Setters */

    [[nodiscard]] const QString &getHost() const;

    void setHost(const QString &host);

    [[nodiscard]] int getPort() const;

    void setPort(int port);

    [[nodiscard]] const QString &getName() const;

    void setName(const QString &name);

    [[nodiscard]] ConnectionType getConnectionType() const;

    void setConnectionType(ConnectionType ct);

    [[nodiscard]] const QString &getUser() const;

    void setUser(const QString &user);

    [[nodiscard]] const QString &getPassword() const;

    void setPassword(const QString &password);

    [[nodiscard]] SmtpClient::AuthMethod getAuthMethod() const;

    void setAuthMethod(AuthMethod method);

    [[nodiscard]] const QString &getResponseText() const;

    [[nodiscard]] int getResponseCode() const;

    [[nodiscard]] int getConnectionTimeout() const;

    void setConnectionTimeout(int msec);

    [[nodiscard]] int getResponseTimeout() const;

    void setResponseTimeout(int msec);

    [[nodiscard]] int getSendMessageTimeout() const;

    void setSendMessageTimeout(int msec);

    QTcpSocket *getSocket();


    /* [2] --- */


    /* [3] Public methods */

    bool connectToHost();

    bool login();

    bool login(const QString &user, const QString &password, AuthMethod method = AuthLogin);

    bool sendMail(MimeMessage &email);

    void quit();


    /* [3] --- */

protected:

    /* [4] Protected members */

    QTcpSocket *socket;

    QString host;
    int port;
    ConnectionType connectionType;
    QString name;

    QString user;
    QString password;
    AuthMethod authMethod;

    int connectionTimeout;
    int responseTimeout;
    int sendMessageTimeout;


    QString responseText;
    int responseCode;


    class ResponseTimeoutException : public std::exception {
    };

    class SendMessageTimeoutException : public std::exception {
    };

    /* [4] --- */


    /* [5] Protected methods */

    void waitForResponse();

    void sendMessage(const QString &text);

    /* [5] --- */

protected slots:

    /* [6] Protected slots */

    void socketStateChanged(QAbstractSocket::SocketState state);

    void socketError(QAbstractSocket::SocketError error);

    void socketReadyRead();

    /* [6] --- */


signals:

    /* [7] Signals */

    void smtpError(SmtpClient::SmtpError e);

    /* [7] --- */

};

#endif // SMTPCLIENT_H