kmail
KMail::MessageSender Class Reference
#include <messagesender.h>
Public Types | |
| enum | SendMethod { SendDefault = -1, SendImmediate = true, SendLater = false } |
Public Member Functions | |
| virtual void | readConfig ()=0 |
| bool | send (KMMessage *msg, SendMethod method=SendDefault) |
| virtual bool | sendImmediate () const =0 |
| bool | sendQueued (const QString &transport=QString::null) |
| virtual bool | sendQuotedPrintable () const =0 |
| virtual void | setSendImmediate (bool immediate)=0 |
| virtual void | setSendQuotedPrintable (bool qp)=0 |
| virtual void | writeConfig (bool withSync=true)=0 |
Protected Member Functions | |
| virtual bool | doSend (KMMessage *msg, short sendNow)=0 |
| virtual bool | doSendQueued (const QString &transport)=0 |
| virtual | ~MessageSender ()=0 |
Detailed Description
Definition at line 41 of file messagesender.h.
Member Enumeration Documentation
Constructor & Destructor Documentation
| KMail::MessageSender::~MessageSender | ( | ) | [inline, protected, pure virtual] |
Definition at line 92 of file messagesender.h.
Member Function Documentation
| virtual bool KMail::MessageSender::doSend | ( | KMMessage * | msg, | |
| short | sendNow | |||
| ) | [protected, pure virtual] |
Implemented in KMSender.
| virtual bool KMail::MessageSender::doSendQueued | ( | const QString & | transport | ) | [protected, pure virtual] |
Implemented in KMSender.
| virtual void KMail::MessageSender::readConfig | ( | ) | [pure virtual] |
Implemented in KMSender.
| bool KMail::MessageSender::send | ( | KMMessage * | msg, | |
| SendMethod | method = SendDefault | |||
| ) | [inline] |
Send given message.
The message is either queued (method == SendLater) or sent immediately (method = SendImmediate). The default behaviour, as selected with setSendImmediate(), can be overwritten with the parameter 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?
- Returns:
- true on success.
Definition at line 65 of file messagesender.h.
| virtual bool KMail::MessageSender::sendImmediate | ( | ) | const [pure virtual] |
Implemented in KMSender.
| bool KMail::MessageSender::sendQueued | ( | const QString & | transport = QString::null |
) | [inline] |
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.
- Returns:
- true on success.
Definition at line 77 of file messagesender.h.
| virtual bool KMail::MessageSender::sendQuotedPrintable | ( | ) | const [pure virtual] |
Implemented in KMSender.
| virtual void KMail::MessageSender::setSendImmediate | ( | bool | immediate | ) | [pure virtual] |
Implemented in KMSender.
| virtual void KMail::MessageSender::setSendQuotedPrintable | ( | bool | qp | ) | [pure virtual] |
Implemented in KMSender.
| virtual void KMail::MessageSender::writeConfig | ( | bool | withSync = true |
) | [pure virtual] |
Implemented in KMSender.
The documentation for this class was generated from the following file:
