21 #include <QtCore>

    21 #include <nmapimessagetask.h>

    22 #include "nmapimessagetask.h"

    22 #include <nmapidef.h>

    23 #include "nmenginedef.h"

    23 #include <nmapicommon.h>

    24 #include "nmcommon_api.h"

    30 class NmEventNotifierPrivate;

    29 class NmApiEventNotifierPrivate;

    32 /*

    31 /*!

    33  * Notifier for mailbox and message events

    32    Notifier for mailbox and message events

    34  * 

    33    

    35  * Example of use:

    34    Example of use:

    36  * NmEventNotifier *notifier = new NmEventNotifier(this);

    35    \code

    37  * notifier->start();

    36    NmApiEventNotifier *notifier = new NmApiEventNotifier(this);

    38  * connect(notifier,SIGNAL(messageEvent(MessageEvent,quint64,quint64,QList<quint64>)),this,

    37    notifier->start();

    39  *                  SLOT(processMessage(MessageEvent,quint64,quint64,QList<quint64>)),Qt::QueuedConnection);

    38    connect(notifier,SIGNAL(messageEvent(MessageEvent,quint64,quint64,QList<quint64>)),this,

    40  * 

    39                     SLOT(processMessage(MessageEvent,quint64,quint64,QList<quint64>)),Qt::QueuedConnection);

    41  * And then when want to end need to do:

    40    \endcode

    42  * notifier->cancel();

    41    And then when want to end need to do:

    43  * delete notifier; // or notifier->deleteLater();

    42    \code

    43    notifier->cancel();

    44    delete notifier; // or notifier->deleteLater();

    45    \endcode

    45 class NMENGINE_EXPORT NmEventNotifier : public NmMessageTask

    47 class NMAPI_EXPORT NmApiEventNotifier : public NmApiMessageTask

    50      * Constructor

    52        Constructor

    52     NmEventNotifier(QObject *parent);

    54     NmApiEventNotifier(QObject *parent);

    55      * Destructor

    57        Destructor

    57     virtual ~NmEventNotifier();

    59     virtual ~NmApiEventNotifier();

    60      * Start monitoring email events

    62        Start monitoring email events

    61      * 

    63        

    62      * Return value tells about monitoring system running

    64        Return value informs if monitoring system is up

    67      * Cancels monitoring.

    69        Cancels monitoring.

    68      * 

    70        

    69      * In user responsibility is to cancel monitoring.

    71        In user responsibility is to cancel monitoring.

    70      * On end it clear buffer events and emits \sa NmMessageTask::canceled() signal.

    72        On end it clear buffer events and emits \sa NmApiMessageTask::canceled() signal.

    75      * It check if if event notifier is running.

    77        Checks if event notifier is running.

    81      * This signal is emited when buffer of maiblox events is ready to send. Buffer is list of mailbox events with id.

    83        This signal is emited when buffer of mailbox events is ready to send. Buffer is list of mailbox events with id.

    82      * 

    84        

    83      * 

    85        

    84      * It emits signals grouped by events. So there will be as much signals as much there are events.

    86        It emits signals grouped by events. So there will be as much signals as much there are events.

    85      * For safety when connect it need to use \sa Qt::QueuedConnection.

    87        For safety when connect it need to use \sa Qt::QueuedConnection.

    86      * After that use \sa EmailClientApi::NmEmailService::getMailbox to get object.

    88        After that use \sa EmailClientApi::NmEmailService::getMailbox to get object.

    87      * \arg Event of mailbox

    89        \param event Event of mailbox

    88      * \arg List of mailbox ids where event occur.

    90        \param id List of mailbox ids where event occur.

    90     void mailboxEvent(MailboxEvent event,QList<quint64> id);

    92     void mailboxEvent(EmailClientApi::NmApiMailboxEvent event, QList<quint64> id);

    93      * This signal is emited when buffer of messages events is ready to send. Buffer is list of messages events with id.

    95        This signal is emited when buffer of messages events is ready to send. Buffer is list of messages events with id.

    95      * It emits signals grouped by events, mailbox and folder. So there will be as much signals as much there are events.

    97        It emits signals grouped by events, mailbox and folder. So there will be as much signals as much there are events.

    96      * For safety when connect it need to use \sa Qt::QueuedConnection.

    98        For safety when connect it need to use \sa Qt::QueuedConnection.

    97      * After that use \sa EmailClientApi::NmEmailService::getEnvelope to get object.

    99        After that use \sa EmailClientApi::NmApiEmailService::getEnvelope to get object.

    98      * 

   100        

    99      * \arg Event of messages

   101        \param event Event of messages

   100      * \arg Message mailbox

   102        \param mailboxId Message mailbox

   101      * \arg Message folder

   103        \param folderId Message folder

   102      * \arg List of messages ids where event occur

   104        \param envelopeIdList List of messages ids where event occur

   104     void messageEvent(MessageEvent event,quint64 mailboxId,quint64 folderId,QList<quint64> envelopeIdList);

   106     void messageEvent(EmailClientApi::NmApiMessageEvent event, quint64 mailboxId, quint64 folderId, QList<quint64> envelopeIdList);

   108      * It check each object in buffer and emit signal with it.

   110        It check each object in buffer and emit signal with it.

   109      * 

   111        

   110      * After end of work of this function buffer is empty.

   112        After end of work of this function buffer is empty.

   111      * It is called by timeout signal from timer.

   113        It is called by timeout signal from timer.

   116     NmEventNotifierPrivate *mNmEventNotifierPrivate;

   118     NmApiEventNotifierPrivate *mNmApiEventNotifierPrivate;