MailTransport::DispatchModeAttribute Class Reference

Attribute determining how and when a message from the outbox should be dispatched. More...

#include <dispatchmodeattribute.h>

Inherits Akonadi::Attribute.

List of all members.

Public Types

enum  DispatchMode { Automatic, Manual }

Public Member Functions

 DispatchModeAttribute (DispatchMode mode=Automatic)
virtual ~DispatchModeAttribute ()
virtual DispatchModeAttributeclone () const
virtual void deserialize (const QByteArray &data)
DispatchMode dispatchMode () const
QDateTime sendAfter () const
virtual QByteArray serialized () const
void setDispatchMode (DispatchMode mode)
void setSendAfter (const QDateTime &date)
virtual QByteArray type () const

Detailed Description

Attribute determining how and when a message from the outbox should be dispatched.

Messages can be sent immediately, sent only when the user explicitly requests it, or sent automatically at a certain date and time.

Author:
Constantin Berzan <exit3219@gmail.com>
Since:
4.4

Definition at line 39 of file dispatchmodeattribute.h.


Member Enumeration Documentation

Determines how the message is sent.

Enumerator:
Automatic 

Send message as soon as possible, but no earlier than specified by setSendAfter().

Manual 

Send message only when the user requests so.

Definition at line 45 of file dispatchmodeattribute.h.


Constructor & Destructor Documentation

DispatchModeAttribute::DispatchModeAttribute ( DispatchMode  mode = Automatic  )  [explicit]

Creates a new DispatchModeAttribute.

Definition at line 36 of file dispatchmodeattribute.cpp.

DispatchModeAttribute::~DispatchModeAttribute (  )  [virtual]

Destroys the DispatchModeAttribute.

Definition at line 42 of file dispatchmodeattribute.cpp.


Member Function Documentation

DispatchModeAttribute::DispatchMode DispatchModeAttribute::dispatchMode (  )  const

Returns the dispatch mode for the message.

See also:
DispatchMode.

Definition at line 95 of file dispatchmodeattribute.cpp.

QDateTime DispatchModeAttribute::sendAfter (  )  const

Returns the date and time when the message should be sent.

Only valid if dispatchMode() is Automatic.

Definition at line 105 of file dispatchmodeattribute.cpp.

void DispatchModeAttribute::setDispatchMode ( DispatchMode  mode  ) 

Sets the dispatch mode for the message.

See also:
DispatchMode.

Definition at line 100 of file dispatchmodeattribute.cpp.

void DispatchModeAttribute::setSendAfter ( const QDateTime &  date  ) 

Sets the date and time when the message should be sent.

See also:
setDispatchMode.

Definition at line 110 of file dispatchmodeattribute.cpp.


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