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
|
/*
transactionstate.h
This file is part of tdeio_smtp, the KDE SMTP tdeioslave.
Copyright (c) 2003 Marc Mutz <mutz@kde.org>
This program is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License, version 2, as
published by the Free Software Foundation.
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
In addition, as a special exception, the copyright holders give
permission to link the code of this program with any edition of
the Qt library by Trolltech AS, Norway (or with modified versions
of Qt that use the same license as Qt), and distribute linked
combinations including the two. You must obey the GNU General
Public License in all respects for all of the code used other than
Qt. If you modify this file, you may extend this exception to
your version of the file, but you are not obligated to do so. If
you do not wish to do so, delete this exception statement from
your version.
*/
#ifndef __KIOSMTP_TRANSACTIONSTATE_H__
#define __KIOSMTP_TRANSACTIONSTATE_H__
#include "response.h"
#include <tqstring.h>
#include <tqvaluelist.h>
namespace KioSMTP {
/**
@short A class modelling an SMTP transaction's state
This class models SMTP transaction state, ie. the collective
result of the MAIL FROM:, RCPT TO: and DATA commands. This is
needed since e.g. a single failed RCPT TO: command does not
neccessarily fail the whole transaction (servers are free to
accept delivery for some recipients, but not for others).
The class can operate in two modes, which differ in the way
failed recipients are handled. If @p rcptToDenyIsFailure is true
(the default), then any failing RCPT TO: will cause the
transaction to fail. Since at the point of RCPT TO: failure
detection, the DATA command may have already been sent
(pipelining), the only way to cancel the transaction is to take
down the connection hard (ie. without proper quit).
Since that is not very nice behaviour, a second mode that is more
to the spirit of SMTP is provided that can cope with partially
failed RCPT TO: commands.
*/
class TransactionState {
public:
struct RecipientRejection {
RecipientRejection( const TQString & who=TQString::null,
const TQString & why=TQString::null )
: recipient( who ), reason( why ) {}
TQString recipient;
TQString reason;
#ifdef KIOSMTP_COMPARATORS
bool operator==( const RecipientRejection & other ) const {
return recipient == other.recipient && reason == other.reason;
}
#endif
};
typedef TQValueList<RecipientRejection> RejectedRecipientList;
TransactionState( bool rcptToDenyIsFailure=true )
: mErrorCode( 0 ),
mRcptToDenyIsFailure( rcptToDenyIsFailure ),
mAtLeastOneRecipientWasAccepted( false ),
mDataCommandIssued( false ),
mDataCommandSucceeded( false ),
mFailed( false ),
mFailedFatally( false ),
mComplete( false ) {}
/** @return whether the transaction failed (e.g. the server
rejected all recipients. Graceful failure is handled after
transaction ends. */
bool failed() const { return mFailed || mFailedFatally; }
void setFailed() { mFailed = true; }
/** @return whether the failure was so grave that an immediate
untidy connection shutdown is in order (ie. @ref
smtp_close(false)). Fatal failure is handled immediately */
bool failedFatally() const { return mFailedFatally; }
void setFailedFatally( int code=0, const TQString & msg=TQString::null );
/** @return whether the transaction was completed successfully */
bool complete() const { return mComplete; }
void setComplete() { mComplete = true; }
/** @return an appropriate TDEIO error code in case the transaction
failed, or 0 otherwise */
int errorCode() const;
/** @return an appropriate error message in case the transaction
failed or TQString::null otherwise */
TQString errorMessage() const;
void setMailFromFailed( const TQString & addr, const Response & r );
bool dataCommandIssued() const { return mDataCommandIssued; }
void setDataCommandIssued( bool issued ) { mDataCommandIssued = issued; }
bool dataCommandSucceeded() const {
return mDataCommandIssued && mDataCommandSucceeded;
}
void setDataCommandSucceeded( bool succeeded, const Response & r );
Response dataResponse() const {
return mDataResponse;
}
bool atLeastOneRecipientWasAccepted() const {
return mAtLeastOneRecipientWasAccepted;
}
void setRecipientAccepted() {
mAtLeastOneRecipientWasAccepted = true;
}
bool haveRejectedRecipients() const {
return !mRejectedRecipients.empty();
}
RejectedRecipientList rejectedRecipients() const {
return mRejectedRecipients;
}
void addRejectedRecipient( const RecipientRejection & r );
void addRejectedRecipient( const TQString & who, const TQString & why ) {
addRejectedRecipient( RecipientRejection( who, why ) );
}
void clear() {
mRejectedRecipients.clear();
mDataResponse.clear();
mAtLeastOneRecipientWasAccepted
= mDataCommandIssued
= mDataCommandSucceeded
= mFailed = mFailedFatally
= mComplete = false;
}
#ifdef KIOSMTP_COMPARATORS
bool operator==( const TransactionState & other ) const {
return
mAtLeastOneRecipientWasAccepted == other.mAtLeastOneRecipientWasAccepted &&
mDataCommandIssued == other.mDataCommandIssued &&
mDataCommandSucceeded == other.mDataCommandSucceeded &&
mFailed == other.mFailed &&
mFailedFatally == other.mFailedFatally &&
mComplete == other.mComplete &&
mDataResponse.code() == other.mDataResponse.code() &&
mRejectedRecipients == other.mRejectedRecipients;
}
#endif
private:
RejectedRecipientList mRejectedRecipients;
Response mDataResponse;
TQString mErrorMessage;
int mErrorCode;
bool mRcptToDenyIsFailure;
bool mAtLeastOneRecipientWasAccepted;
bool mDataCommandIssued;
bool mDataCommandSucceeded;
bool mFailed;
bool mFailedFatally;
bool mComplete;
};
} // namespace KioSMTP
#endif // __KIOSMTP_TRANSACTIONSTATE_H__
|
