#include <nmapimailboxlisting.h>

#include <QObject>

#include <nmapimailbox.h>

   \class Class for creating list of all mailboxes

   Constructor of class. It set start values.

NmApiMailboxListing::NmApiMailboxListing(QObject *parent) :

    NmApiMessageTask(parent)

    mNmApiMailboxListingPrivate = new NmApiMailboxListingPrivate(this);

    mNmApiMailboxListingPrivate->mIsRunning = false;

   Destructor of class. It release engine to be safe if manual releasing won't work.

NmApiMailboxListing::~NmApiMailboxListing()

    if (mNmApiMailboxListingPrivate->mIsRunning) {

        mNmApiMailboxListingPrivate->releaseEngine();

   \brief Returns results after mailboxesListed signal is received.

    Caller gets ownership of messages. Returns true if results were available.

    It clears list of mailboxes (in private members) after be called.

    It also at start clear inputlist of NmApiMailbox.

    \return Return true if results were avaible

    \param mailboxes List of mailboxes to filled. On start is cleared. 

bool NmApiMailboxListing::getMailboxes(QList<EmailClientApi::NmApiMailbox> &mailboxes)

    if (!mNmApiMailboxListingPrivate->mIsRunning) {

        if (mNmApiMailboxListingPrivate->mMailboxes.isEmpty()) {

            mailboxes = mNmApiMailboxListingPrivate->mMailboxes;

            mNmApiMailboxListingPrivate->mMailboxes.clear();

   \brief Starts gathering mailbox list.

   In first turn it will get whole mailboxlist. 

   Then it initialize core arguments and emits signal when ready.

   To asynchronous operation can be used \sa QTimer::singleShot on this method.

   Example:

   <code> 

   QTimer::singleShot(0,nmMailboxListing,SLOT(start());

   </code>

   \return Return true if everything go good and core of listing works good.

bool NmApiMailboxListing::start()

    if (mNmApiMailboxListingPrivate->mIsRunning) {

        if (!mNmApiMailboxListingPrivate->initializeEngine()) {

            qint32 mailboxCount = mNmApiMailboxListingPrivate->grabMailboxes();

            mNmApiMailboxListingPrivate->mIsRunning = true;

   \brief Stop gathering mailbox list.

   In first it change state of listing.

   Then it release engine.

   On end it clears list of mailboxes and emits \sa NmApiMessageTask::canceled() signal.

void NmApiMailboxListing::cancel()

    if (mNmApiMailboxListingPrivate->mIsRunning) {

        mNmApiMailboxListingPrivate->mIsRunning = false;

        mNmApiMailboxListingPrivate->releaseEngine();

        mNmApiMailboxListingPrivate->mMailboxes.clear();

   \brief Return info if listing is running

   \return Return true if listing is running

bool NmApiMailboxListing::isRunning() const

    return mNmApiMailboxListingPrivate->mIsRunning;