emailservices/nmclientapi/src/nmapimailboxsettings.cpp
changeset 74 6c59112cfd31
parent 48 10eaf342f539
equal deleted inserted replaced
69:4e54af54a4a1 74:6c59112cfd31
    32 {
    32 {
    33     delete d;
    33     delete d;
    34 }
    34 }
    35 
    35 
    36 /*!
    36 /*!
       
    37  Lists ids of mailboxes
       
    38 
    37  \fn listMailboxIds
    39  \fn listMailboxIds
    38  \param idList - QList consists of ids as quint64.
    40  \param idList - QList consists of ids as quint64.
    39  \return true is successful, otherwise return false
    41  \return true is successful, otherwise return false
    40 
       
    41  Lists ids of mailboxes
       
    42  */
    42  */
    43 bool NmApiMailboxSettings::listMailboxIds(QList<quint64> &idList)
    43 bool NmApiMailboxSettings::listMailboxIds(QList<quint64> &idList)
    44 {
    44 {
    45     return d->listMailboxIds(idList);
    45     return d->listMailboxIds(idList);
    46 }
    46 }
    47 
    47 
       
    48 /*!
       
    49  Returns the type of mailbox for mailboxId
       
    50 
       
    51  \fn getMailboxType
       
    52  \param mailboxId - id of mailbox as quint64. A list of mailbox ids can be received via
       
    53  listMailboxIds
       
    54  \return mailbox type on success, NULL QString on failure
       
    55  */
       
    56 QString NmApiMailboxSettings::getMailboxType(quint64 mailboxId)
       
    57 {
       
    58     return d->getMailboxType(mailboxId);
       
    59 }
       
    60 
       
    61 /*!
       
    62  Loads mailbox settings from central repository for mailboxId into data structure
       
    63 
       
    64  \fn loadSettings
       
    65  \param mailboxId - id of mailbox as quint64. A list of mailbox ids can be received via
       
    66  listMailboxIds
       
    67  \param data - NmApiMailboxSettingsData& class to load mailbox settings to.
       
    68  \return true is successful, otherwise return false
       
    69  */
    48 bool NmApiMailboxSettings::loadSettings(quint64 mailboxId, NmApiMailboxSettingsData &data)
    70 bool NmApiMailboxSettings::loadSettings(quint64 mailboxId, NmApiMailboxSettingsData &data)
    49 {
    71 {
    50 	return d->loadSettings(mailboxId, data);
    72 	return d->loadSettings(mailboxId, data);
    51 }
    73 }
    52 
    74 
       
    75 /*!
       
    76  Saves mailbox settings to central repository
       
    77 
       
    78  \fn saveSettings
       
    79  \param data - NmApiMailboxSettingsData& class containing mailbox settings.
       
    80  \return true is successful, otherwise return false
       
    81  */
    53 bool NmApiMailboxSettings::saveSettings(const NmApiMailboxSettingsData &data)
    82 bool NmApiMailboxSettings::saveSettings(const NmApiMailboxSettingsData &data)
    54 {
    83 {
    55 	return d->saveSettings(data);
    84 	return d->saveSettings(data);
    56 }
    85 }
    57 
    86 
    58 /*!
    87 /*!
       
    88  Creates a mailbox
       
    89 
    59  \fn createMailbox
    90  \fn createMailbox
    60  \param mailboxType - mailbox type as QString
    91  \param mailboxType - mailbox type as QString
    61  \param data - mailbox settings data
    92  \param data - mailbox settings data
    62 
    93  \return true is successful, otherwise return false
    63  Creates a mailbox
       
    64  */
    94  */
    65 bool NmApiMailboxSettings::createMailbox(const QString &mailboxType, NmApiMailboxSettingsData &data)
    95 bool NmApiMailboxSettings::createMailbox(const QString &mailboxType, NmApiMailboxSettingsData &data)
    66 {
    96 {
    67     return d->createMailbox(mailboxType, data);
    97     return d->createMailbox(mailboxType, data);
    68 }
    98 }
    69 
    99 
    70 /*!
   100 /*!
       
   101  Deletes mailbox with specific id.
       
   102 
    71  \fn deleteMailbox
   103  \fn deleteMailbox
    72  \param mailboxId - mailbox id.
   104  \param mailboxId - mailbox id
    73  \return quint64 - the mailbox id.
   105  \return quint32 - nmailclient API wide error
    74  
       
    75  Deletes mailbox with specific id.
       
    76  */
   106  */
    77 bool NmApiMailboxSettings::deleteMailbox(quint64 mailboxId)
   107 bool NmApiMailboxSettings::deleteMailbox(quint64 mailboxId)
    78 {
   108 {
    79     return d->deleteMailbox(mailboxId);
   109     return d->deleteMailbox(mailboxId);
    80 }
   110 }
    81 
   111 
    82 /*!
   112 /*!
       
   113  Populates NmApiMailboxSettingsData with protocol specific settings data.
       
   114 
    83  \fn populateDefaultSettings
   115  \fn populateDefaultSettings
    84  \param mailboxType - mailbox type as QString
   116  \param mailboxType - mailbox type as QString
    85  \param data - mailbox settings data, on return contains dafault settings for mailbox protocol
   117  \param data - mailbox settings data, on return contains dafault settings for mailbox protocol
    86  \return true if default settings are set, otherwise false
   118  \return true if default settings are set, otherwise false
    87  
       
    88  Populates NmApiMailboxSettingsData with protocol specific settings data.
       
    89  */
   119  */
    90 bool NmApiMailboxSettings::populateDefaultSettings(const QString &mailboxType, NmApiMailboxSettingsData &data)
   120 bool NmApiMailboxSettings::populateDefaultSettings(const QString &mailboxType, NmApiMailboxSettingsData &data)
    91 {
   121 {
    92     return d->populateDefaultSettings(mailboxType, data);
   122     return d->populateDefaultSettings(mailboxType, data);
    93 }
   123 }