kmail

KMail::MessageSender Class Reference

Inheritance diagram for KMail::MessageSender:

KMSender List of all members.

Detailed Description

Definition at line 41 of file messagesender.h.


Public Types

enum  SendMethod { SendDefault = -1, SendImmediate = true, SendLater = false }

Public Member Functions

bool send (KMMessage *msg, SendMethod method=SendDefault)
bool sendQueued (const QString &transport=QString::null)
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 Member Functions

virtual ~MessageSender ()=0
virtual bool doSend (KMMessage *msg, short sendNow)=0
virtual bool doSendQueued (const QString &transport)=0

Member Function Documentation

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.

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.


The documentation for this class was generated from the following file:
KDE Home | KDE Accessibility Home | Description of Access Keys