summaryrefslogtreecommitdiffstats
path: root/kmail/messagesender.h
diff options
context:
space:
mode:
Diffstat (limited to 'kmail/messagesender.h')
-rw-r--r--kmail/messagesender.h97
1 files changed, 97 insertions, 0 deletions
diff --git a/kmail/messagesender.h b/kmail/messagesender.h
new file mode 100644
index 00000000..4f25b378
--- /dev/null
+++ b/kmail/messagesender.h
@@ -0,0 +1,97 @@
+/*
+ messagesender.h
+
+ This file is part of KMail, the KDE mail client
+ Copyright (c) 2005 Klarälvdalens Datakonsult AB
+
+ KMail 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 2 of the License, or
+ (at your option) any later version.
+
+ KMail 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 __KMAIL_MESSAGESENDER_H__
+#define __KMAIL_MESSAGESENDER_H__
+#include <qstring.h>
+
+class KMMessage;
+
+namespace KMail {
+
+class MessageSender {
+protected:
+ virtual ~MessageSender() = 0;
+
+public:
+ enum SendMethod {
+ SendDefault = -1,
+ SendImmediate = true,
+ SendLater = false
+ };
+ /**
+ Send given message.
+
+ The message is either queued (@p method == SendLater) or sent
+ immediately (@p method = SendImmediate). The default behaviour,
+ as selected with setSendImmediate(), can be overwritten with the
+ parameter @p method. The sender takes ownership of the given
+ message on success, so DO NOT DELETE OR MODIFY the message
+ further.
+
+ FIXME: what about send() == false?
+
+ @return true on success.
+ */
+ bool send( KMMessage * msg, SendMethod method=SendDefault ) { return doSend( msg, method ); }
+
+ /**
+ Start sending all queued messages.
+
+ FIXME: what does success mean here, if it's only _start_ sending?
+
+ Optionally a transport can be specified that will be used as the
+ default transport.
+
+ @return true on success.
+ */
+ bool sendQueued( const QString & transport=QString::null ) { return doSendQueued( transport ); }
+
+ virtual void readConfig() = 0;
+ virtual void writeConfig( bool withSync = true ) = 0;
+
+ virtual bool sendImmediate() const = 0;
+ virtual void setSendImmediate( bool immediate ) = 0;
+
+ virtual bool sendQuotedPrintable() const = 0;
+ virtual void setSendQuotedPrintable( bool qp ) = 0;
+protected:
+ virtual bool doSend( KMMessage * msg, short sendNow ) = 0;
+ virtual bool doSendQueued( const QString& transport ) = 0;
+};
+
+inline MessageSender::~MessageSender() {}
+
+}
+
+#endif /* __KMAIL_MESSAGESENDER_H__ */
+