You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
tdebase/tdeioslave/smtp/smtp.h

149 lines
5.2 KiB

/*
* Copyright (c) 2000, 2001 Alex Zepeda <zipzippy@sonic.net>
* Copyright (c) 2001 Michael H<EFBFBD>ckel <Michael@Haeckel.Net>
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*
*/
#ifndef _SMTP_H
#define _SMTP_H
#include <tdeio/tcpslavebase.h>
#include "capabilities.h"
#include <tqstring.h>
#include <tqptrqueue.h>
class KURL;
class TQCString;
template <typename T> class TQMemArray;
#ifdef USE_QT3
typedef TQMemArray<char> TQByteArray;
#endif // USE_QT3
namespace KioSMTP {
class Response;
class TransactionState;
class Command;
}
class SMTPProtocol : public TDEIO::TCPSlaveBase {
friend class KioSMTP::Command;
public:
SMTPProtocol(const TQCString & pool, const TQCString & app, bool useSSL);
virtual ~ SMTPProtocol();
virtual void setHost(const TQString & host, int port,
const TQString & user, const TQString & pass);
virtual void special(const TQByteArray & aData);
virtual void put(const KURL & url, int permissions, bool overwrite,
bool resume);
virtual void stat(const KURL & url);
virtual void openConnection();
virtual void closeConnection();
protected:
bool smtp_open(const TQString& fakeHostname = TQString::null);
/** Closes the connection. If @p nice is true (default), then QUIT
is sent and it's reponse waited for. */
void smtp_close( bool nice=true );
/** Execute command @p cmd */
bool execute( KioSMTP::Command * cmd, KioSMTP::TransactionState * ts=0 );
/** Execute a command of type @p type */
bool execute( int type, KioSMTP::TransactionState * ts=0 );
/** Execute the queued commands. If something goes horribly wrong
(sending command oline fails, getting response fails or some
command raises the failedFatally() flag in @p ts, shuts down the
connection with <code>smtp_close( false )</code>. If The
transaction fails gracefully (<code>ts->failed()</code> is
true), issues a RSET command.
@return true if transaction succeeded, false otherwise.
**/
bool executeQueuedCommands( KioSMTP::TransactionState * ts );
/** Parse a single response from the server. Single- vs. multiline
responses are correctly detected.
@param ok if not 0, returns whether response parsing was
successful. Don't confuse this with negative responses
(e.g. 5xx), which you can check for using
@ref Response::isNegative()
@return the @ref Response object representing the server response.
**/
KioSMTP::Response getResponse( bool * ok );
bool authenticate();
void parseFeatures( const KioSMTP::Response & ehloResponse );
bool sendCommandLine( const TQCString & cmd );
TQCString collectPipelineCommands( KioSMTP::TransactionState * ts );
bool batchProcessResponses( KioSMTP::TransactionState * ts );
/** This is a pure convenience wrapper around
@ref KioSMTP::Capabilities::have() */
bool haveCapability( const char * cap ) const {
return mCapabilities.have( cap );
}
/** @return true is pipelining is available and allowed by metadata */
bool canPipelineCommands() const {
return haveCapability("PIPELINING") && metaData("pipelining") != "off" ;
}
/** Wrapper around getsockopt(..., SO_SNDBUF,...) */
unsigned int sendBufferSize() const;
/** This is a pure convenience wrapper around
@ref KioSMTP::Capabilities::createSpecialResponse */
TQString createSpecialResponse() const {
return mCapabilities.createSpecialResponse( usingTLS() || haveCapability( "STARTTLS" ) );
}
void queueCommand( KioSMTP::Command * command ) {
mPendingCommandQueue.enqueue( command );
}
void queueCommand( int type );
unsigned short m_iOldPort;
bool m_opened;
TQString m_sServer, m_sOldServer;
TQString m_sUser, m_sOldUser;
TQString m_sPass, m_sOldPass;
TQString m_hostname;
KioSMTP::Capabilities mCapabilities;
typedef TQPtrQueue<KioSMTP::Command> CommandQueue;
CommandQueue mPendingCommandQueue;
CommandQueue mSentCommandQueue;
};
#endif // _SMTP_H