mailtransport
MailTransport::MessageQueueJob Class Reference
Provides an interface for sending email. More...
#include <messagequeuejob.h>
Inherits KCompositeJob.
Public Member Functions | |
MessageQueueJob (QObject *parent=0) | |
virtual | ~MessageQueueJob () |
Akonadi::AddressAttribute & | addressAttribute () |
DispatchModeAttribute & | dispatchModeAttribute () |
KMime::Message::Ptr | message () const |
SentBehaviourAttribute & | sentBehaviourAttribute () |
void | setMessage (KMime::Message::Ptr message) |
virtual void | start () |
TransportAttribute & | transportAttribute () |
Protected Slots | |
virtual void | slotResult (KJob *) |
Detailed Description
Provides an interface for sending email.
This class takes a KMime::Message and some related info such as sender and recipient addresses, and places the message in the outbox. The mail dispatcher agent will then take it from there and send it.
This is the preferred way for applications to send email.
This job requires some options to be set before being started. Modify the attributes of this job to change these options.
You need to set the transport of the transport attribute, the from address of the address attribute and one of the to, cc or bcc addresses of the address attribute. Also, you need to call setMessage(). Optionally, you can change the dispatch mode attribute or the sent behaviour attribute.
Example:
MessageQueueJob *job = new MessageQueueJob( this ); job->setMessage( msg ); // msg is a Message::Ptr job->transportAttribute().setTransportId( TransportManager::self()->defaultTransportId() ); // Use the default dispatch mode. // Use the default sent-behaviour. job->addressAttribute().setFrom( from ); // from is a QString job->addressAttribute().setTo( to ); // to is a QStringList connect( job, SIGNAL(result(KJob*)), this, SLOT(jobResult(KJob*)) ); job->start();
- See also:
- DispatchModeAttribute
- SentBehaviourAttribute
- TransportAttribute
- AddressAttribute
- Since:
- 4.4
Definition at line 84 of file messagequeuejob.h.
Constructor & Destructor Documentation
MessageQueueJob::MessageQueueJob | ( | QObject * | parent = 0 |
) | [explicit] |
Creates a new MessageQueueJob.
This is not an autostarting job; you need to call start() yourself.
Definition at line 151 of file messagequeuejob.cpp.
MessageQueueJob::~MessageQueueJob | ( | ) | [virtual] |
Destroys the MessageQueueJob.
This job deletes itself after finishing.
Definition at line 156 of file messagequeuejob.cpp.
Member Function Documentation
AddressAttribute & MessageQueueJob::addressAttribute | ( | ) |
Returns a reference to the address attribue for this message.
Modify the returned attribute to change the receivers or the from address.
Definition at line 171 of file messagequeuejob.cpp.
DispatchModeAttribute & MessageQueueJob::dispatchModeAttribute | ( | ) |
Returns a reference to the dispatch mode attribue for this message.
Modify the returned attribute to change the dispatch mode.
Definition at line 166 of file messagequeuejob.cpp.
Message::Ptr MessageQueueJob::message | ( | ) | const |
Returns the message to be sent.
Definition at line 161 of file messagequeuejob.cpp.
SentBehaviourAttribute & MessageQueueJob::sentBehaviourAttribute | ( | ) |
Returns a reference to the sent behaviour attribue for this message.
Modify the returned attribute to change the sent behaviour.
Definition at line 181 of file messagequeuejob.cpp.
void MailTransport::MessageQueueJob::setMessage | ( | KMime::Message::Ptr | message | ) |
Sets the message to be sent.
void MessageQueueJob::slotResult | ( | KJob * | job | ) | [protected, virtual, slot] |
Called when the ItemCreateJob subjob finishes.
(reimplemented from KCompositeJob)
Definition at line 199 of file messagequeuejob.cpp.
void MessageQueueJob::start | ( | ) | [virtual] |
Creates the item and places it in the outbox.
It is now queued for sending by the mail dispatcher agent.
Definition at line 191 of file messagequeuejob.cpp.
TransportAttribute & MessageQueueJob::transportAttribute | ( | ) |
Returns a reference to the transport attribue for this message.
Modify the returned attribute to change the transport used for sending the mail.
Definition at line 176 of file messagequeuejob.cpp.
The documentation for this class was generated from the following files: