--- a/emailservices/nmclientapi/src/nmapimailboxsettings.cpp Wed Sep 15 17:47:19 2010 +0300
+++ b/emailservices/nmclientapi/src/nmapimailboxsettings.cpp Thu Sep 30 11:43:07 2010 +0300
@@ -34,33 +34,63 @@
}
/*!
+ Lists ids of mailboxes
+
\fn listMailboxIds
\param idList - QList consists of ids as quint64.
\return true is successful, otherwise return false
-
- Lists ids of mailboxes
*/
bool NmApiMailboxSettings::listMailboxIds(QList<quint64> &idList)
{
return d->listMailboxIds(idList);
}
+/*!
+ Returns the type of mailbox for mailboxId
+
+ \fn getMailboxType
+ \param mailboxId - id of mailbox as quint64. A list of mailbox ids can be received via
+ listMailboxIds
+ \return mailbox type on success, NULL QString on failure
+ */
+QString NmApiMailboxSettings::getMailboxType(quint64 mailboxId)
+{
+ return d->getMailboxType(mailboxId);
+}
+
+/*!
+ Loads mailbox settings from central repository for mailboxId into data structure
+
+ \fn loadSettings
+ \param mailboxId - id of mailbox as quint64. A list of mailbox ids can be received via
+ listMailboxIds
+ \param data - NmApiMailboxSettingsData& class to load mailbox settings to.
+ \return true is successful, otherwise return false
+ */
bool NmApiMailboxSettings::loadSettings(quint64 mailboxId, NmApiMailboxSettingsData &data)
{
return d->loadSettings(mailboxId, data);
}
+/*!
+ Saves mailbox settings to central repository
+
+ \fn saveSettings
+ \param data - NmApiMailboxSettingsData& class containing mailbox settings.
+ \return true is successful, otherwise return false
+ */
bool NmApiMailboxSettings::saveSettings(const NmApiMailboxSettingsData &data)
{
return d->saveSettings(data);
}
/*!
+ Creates a mailbox
+
\fn createMailbox
\param mailboxType - mailbox type as QString
\param data - mailbox settings data
-
- Creates a mailbox
+ \return true is successful, otherwise return false
*/
bool NmApiMailboxSettings::createMailbox(const QString &mailboxType, NmApiMailboxSettingsData &data)
{
@@ -68,11 +98,11 @@
}
/*!
+ Deletes mailbox with specific id.
+
\fn deleteMailbox
- \param mailboxId - mailbox id.
- \return quint64 - the mailbox id.
-
- Deletes mailbox with specific id.
+ \param mailboxId - mailbox id
+ \return quint32 - nmailclient API wide error
*/
bool NmApiMailboxSettings::deleteMailbox(quint64 mailboxId)
{
@@ -80,12 +110,12 @@
}
/*!
+ Populates NmApiMailboxSettingsData with protocol specific settings data.
+
\fn populateDefaultSettings
\param mailboxType - mailbox type as QString
\param data - mailbox settings data, on return contains dafault settings for mailbox protocol
\return true if default settings are set, otherwise false
-
- Populates NmApiMailboxSettingsData with protocol specific settings data.
*/
bool NmApiMailboxSettings::populateDefaultSettings(const QString &mailboxType, NmApiMailboxSettingsData &data)
{