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
|
//
// VMime library (http://www.vmime.org)
// Copyright (C) 2002 Vincent Richard <vincent@vmime.org>
//
// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU General Public License as
// published by the Free Software Foundation; either version 3 of
// the License, or (at your option) any later version.
//
// This program 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
// General Public License for more details.
//
// You should have received a copy of the GNU General Public License along
// with this program; if not, write to the Free Software Foundation, Inc.,
// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
//
// Linking this library statically or dynamically with other modules is making
// a combined work based on this library. Thus, the terms and conditions of
// the GNU General Public License cover the whole combination.
//
#ifndef VMIME_NET_SMTP_POP3RESPONSE_HPP_INCLUDED
#define VMIME_NET_SMTP_POP3RESPONSE_HPP_INCLUDED
#include "vmime/config.hpp"
#if VMIME_HAVE_MESSAGING_FEATURES && VMIME_HAVE_MESSAGING_PROTO_POP3
#include "vmime/object.hpp"
#include "vmime/base.hpp"
#include "vmime/utility/outputStream.hpp"
#include "vmime/utility/progressListener.hpp"
#include "vmime/net/socket.hpp"
#include "vmime/net/tracer.hpp"
namespace vmime {
namespace net {
class timeoutHandler;
namespace pop3 {
class POP3Connection;
/** A POP3 response, as sent by the server.
*/
class VMIME_EXPORT POP3Response : public object {
public:
/** Possible response codes. */
enum ResponseCode {
CODE_OK = 0,
CODE_READY,
CODE_ERR
};
/** Receive and parse a POP3 response from the
* specified connection.
*
* @param conn connection from which to read
* @return POP3 response
* @throws exceptions::operation_timed_out if no data
* has been received within the granted time
*/
static shared_ptr <POP3Response> readResponse(const shared_ptr <POP3Connection>& conn);
/** Receive and parse a multiline POP3 response from
* the specified connection.
*
* @param conn connection from which to read
* @return POP3 response
* @throws exceptions::operation_timed_out if no data
* has been received within the granted time
*/
static shared_ptr <POP3Response> readMultilineResponse(const shared_ptr <POP3Connection>& conn);
/** Receive and parse a large POP3 response (eg. message data)
* from the specified connection.
*
* @param conn connection from which to read
* @param os output stream to which response data will be written
* @param progress progress listener (can be NULL)
* @param predictedSize estimated size of response data (in bytes)
* @return POP3 response
* @throws exceptions::operation_timed_out if no data
* has been received within the granted time
*/
static shared_ptr <POP3Response> readLargeResponse(
const shared_ptr <POP3Connection>& conn,
utility::outputStream& os,
utility::progressListener* progress,
const size_t predictedSize
);
/** Returns whether the response is successful ("OK").
*
* @return true if the response if successful, false otherwise
*/
bool isSuccess() const;
/** Return the POP3 response code.
*
* @return response code
*/
ResponseCode getCode() const;
/** Return the POP3 response text (first line).
*
* @return response text
*/
const string getText() const;
/** Return the first POP3 response line.
*
* @return first response line
*/
const string getFirstLine() const;
/** Return the response line at the specified position.
*
* @param pos line index
* @return line at the specified index
*/
const string getLineAt(const size_t pos) const;
/** Return the number of lines in the response.
*
* @return number of lines in the response
*/
size_t getLineCount() const;
private:
POP3Response(
const shared_ptr <socket>& sok,
const shared_ptr <timeoutHandler>& toh,
const shared_ptr <tracer>& tracer
);
void readResponseImpl(string& buffer, const bool multiLine);
size_t readResponseImpl(
string& firstLine,
utility::outputStream& os,
utility::progressListener* progress,
const size_t predictedSize
);
static bool stripFirstLine(const string& buffer, string& result, string* firstLine);
static ResponseCode getResponseCode(const string& buffer);
static void stripResponseCode(const string& buffer, string& result);
static bool checkTerminator(string& buffer, const bool multiLine);
static bool checkOneTerminator(string& buffer, const string& term);
shared_ptr <socket> m_socket;
shared_ptr <timeoutHandler> m_timeoutHandler;
shared_ptr <tracer> m_tracer;
string m_firstLine;
ResponseCode m_code;
string m_text;
std::vector <string> m_lines;
};
} // pop3
} // net
} // vmime
#endif // VMIME_HAVE_MESSAGING_FEATURES && VMIME_HAVE_MESSAGING_PROTO_POP3
#endif // VMIME_NET_SMTP_POP3RESPONSE_HPP_INCLUDED
|
