MailTransport::DispatchModeAttribute

MailTransport::DispatchModeAttribute Class Reference

#include <dispatchmodeattribute.h>

Inheritance diagram for MailTransport::DispatchModeAttribute:

Public Types

enum  DispatchMode { Automatic, Manual }
 
- Public Types inherited from Akonadi::Attribute
typedef QList< Attribute * > List
 

Public Member Functions

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

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 exit3[email protected][email protected][email protected]gmail[email protected].com
Since
4.4

Definition at line 25 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.

Manual 

specified by setSendAfter()

Send message only when the user requests so.

Definition at line 31 of file dispatchmodeattribute.h.

Constructor & Destructor Documentation

DispatchModeAttribute::DispatchModeAttribute ( DispatchMode  mode = Automatic)
explicit

Creates a new DispatchModeAttribute.

Definition at line 23 of file dispatchmodeattribute.cpp.

DispatchModeAttribute::~DispatchModeAttribute ( )
override

Destroys the DispatchModeAttribute.

Definition at line 29 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 80 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 90 of file dispatchmodeattribute.cpp.

void DispatchModeAttribute::setDispatchMode ( DispatchMode  mode)

Sets the dispatch mode for the message.

Parameters
modethe dispatch mode to set
See also
DispatchMode.

Definition at line 85 of file dispatchmodeattribute.cpp.

void DispatchModeAttribute::setSendAfter ( const QDateTime date)

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

Parameters
datethe date and time to set
See also
setDispatchMode.

Definition at line 95 of file dispatchmodeattribute.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Sat Jul 11 2020 23:17:56 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.