diff options
author | Don Sanders <don.sanders@nokia.com> | 2010-07-30 23:31:01 +1000 |
---|---|---|
committer | Don Sanders <don.sanders@nokia.com> | 2010-07-30 23:31:01 +1000 |
commit | b99c911eeec8a9bb0788b08731369395b90a4c5c (patch) | |
tree | 5bd4ac04dffd2bd32365f19bc907b12daabfe879 /doc | |
parent | 814db25480894c42ac105a8bc31f3671cf908d57 (diff) |
Update doc.
Diffstat (limited to 'doc')
-rw-r--r-- | doc/html/changes-qtopiamail.html | 5 | ||||
-rw-r--r-- | doc/html/qmaildisconnected-members.html | 1 | ||||
-rw-r--r-- | doc/html/qmaildisconnected.html | 8 | ||||
-rw-r--r-- | doc/html/qmailretrievalaction-members.html | 2 | ||||
-rw-r--r-- | doc/html/qmailretrievalaction.html | 4 | ||||
-rw-r--r-- | doc/html/qmf.qhp | 3 | ||||
-rw-r--r-- | doc/html/qt-messaging-framework.dcf | 3 | ||||
-rw-r--r-- | doc/html/qt-messaging-framework.index | 5 |
8 files changed, 23 insertions, 8 deletions
diff --git a/doc/html/changes-qtopiamail.html b/doc/html/changes-qtopiamail.html index 2ccfc14d..265a073a 100644 --- a/doc/html/changes-qtopiamail.html +++ b/doc/html/changes-qtopiamail.html @@ -247,6 +247,11 @@ 33. Added QMailDisconnected class. + 34. Changed 'QMailRetrievalAction::synchronize(const QMailAccountId &accountId)' to + 'QMailRetrievalAction::synchronizeAll(const QMailAccountId &accountId)' + + 35. Added 'QMailDisconnected::destinationKey(const QMailFolderId &)' + *****************************************************************************</pre> <p /><address><hr /><div align="center"> <table width="100%" cellspacing="0" border="0"><tr class="address"> diff --git a/doc/html/qmaildisconnected-members.html b/doc/html/qmaildisconnected-members.html index b6328f0a..0d69e935 100644 --- a/doc/html/qmaildisconnected-members.html +++ b/doc/html/qmaildisconnected-members.html @@ -19,6 +19,7 @@ <li><div class="fn"><b><a href="qmaildisconnected.html#copyPreviousFolder">copyPreviousFolder</a></b> ( const QMailMessageMetaData &, QMailMessageMetaData * )</div></li> <li><div class="fn"><b><a href="qmaildisconnected.html#copyToFolder">copyToFolder</a></b> ( const QMailMessageIdList &, const QMailFolderId & )</div></li> <li><div class="fn"><b><a href="qmaildisconnected.html#copyToStandardFolder">copyToStandardFolder</a></b> ( const QMailMessageIdList &, QMailFolder::StandardFolder )</div></li> +<li><div class="fn"><b><a href="qmaildisconnected.html#destinationKey">destinationKey</a></b> ( const QMailFolderId & ) : QMailMessageKey</div></li> <li><div class="fn"><b><a href="qmaildisconnected.html#flagMessage">flagMessage</a></b> ( const QMailMessageId &, quint64, quint64, const QString & )</div></li> <li><div class="fn"><b><a href="qmaildisconnected.html#flagMessages">flagMessages</a></b> ( const QMailMessageIdList &, quint64, quint64, const QString & )</div></li> <li><div class="fn"><b><a href="qmaildisconnected.html#moveToFolder">moveToFolder</a></b> ( const QMailMessageIdList &, const QMailFolderId & )</div></li> diff --git a/doc/html/qmaildisconnected.html b/doc/html/qmaildisconnected.html index f008fd13..416860cb 100644 --- a/doc/html/qmaildisconnected.html +++ b/doc/html/qmaildisconnected.html @@ -26,6 +26,7 @@ <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qmaildisconnected.html#copyPreviousFolder">copyPreviousFolder</a></b> ( const QMailMessageMetaData & <i>source</i>, QMailMessageMetaData * <i>dest</i> )</td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qmaildisconnected.html#copyToFolder">copyToFolder</a></b> ( const QMailMessageIdList & <i>ids</i>, const QMailFolderId & <i>folderId</i> )</td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qmaildisconnected.html#copyToStandardFolder">copyToStandardFolder</a></b> ( const QMailMessageIdList & <i>ids</i>, QMailFolder::StandardFolder <i>standardFolder</i> )</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">QMailMessageKey </td><td class="memItemRight" valign="bottom"><b><a href="qmaildisconnected.html#destinationKey">destinationKey</a></b> ( const QMailFolderId & <i>folderId</i> )</td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qmaildisconnected.html#flagMessage">flagMessage</a></b> ( const QMailMessageId & <i>id</i>, quint64 <i>setMask</i>, quint64 <i>unsetMask</i>, const QString & <i>description</i> )</td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qmaildisconnected.html#flagMessages">flagMessages</a></b> ( const QMailMessageIdList & <i>ids</i>, quint64 <i>setMask</i>, quint64 <i>unsetMask</i>, const QString & <i>description</i> )</td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qmaildisconnected.html#moveToFolder">moveToFolder</a></b> ( const QMailMessageIdList & <i>ids</i>, const QMailFolderId & <i>folderId</i> )</td></tr> @@ -61,6 +62,9 @@ <p>The copy operation will be propagated to the server by a successful call to <a href="qmailretrievalaction.html#exportUpdates">QMailRetrievalAction::exportUpdates</a>().</p> <p>This function must only be used on messages for which the entire content of the message and all parts of the message is available in the message store; otherwise the behavior is undefined.</p> <p>See also <a href="qmailmessagepartcontainer.html#contentAvailable">QMailMessagePartContainer::contentAvailable</a>().</p> +<h3 class="fn"><a name="destinationKey"></a><a href="qmailmessagekey.html">QMailMessageKey</a> QMailDisconnected::destinationKey ( const <a href="qmailfolderid.html">QMailFolderId</a> & <i>folderId</i> ) <tt> [static]</tt></h3> +<p>Returns a key matching messages that are scheduled to be moved into the folder identified by <i>folderId</i>, when the next synchronization of the account containing that folder occurs.</p> +<p>See also <a href="qmailretrievalaction.html#exportUpdates">QMailRetrievalAction::exportUpdates</a>().</p> <h3 class="fn"><a name="flagMessage"></a>void QMailDisconnected::flagMessage ( const <a href="qmailmessageid.html">QMailMessageId</a> & <i>id</i>, <a href="http://doc.trolltech.com/4.5/qtglobal.html#quint64-typedef">quint64</a> <i>setMask</i>, <a href="http://doc.trolltech.com/4.5/qtglobal.html#quint64-typedef">quint64</a> <i>unsetMask</i>, const <a href="http://doc.trolltech.com/4.5/qstring.html">QString</a> & <i>description</i> ) <tt> [static]</tt></h3> <p>Disconnected flags the list a message identified by <i>id</i>, setting the flags specified by the bit mask <i>setMask</i> to on and setting the flags set by the bit mask <i>unsetMask</i> to off.</p> <p>For example this function may be used to mark a message as important or 'move to trash' a message.</p> @@ -86,10 +90,10 @@ <p>Rolls back all disconnected move and copy operations that have been applied to the message store since the most recent synchronization of the message with the account specified by <i>mailAccountId</i>.</p> <p>See also <a href="qmaildisconnected.html#updatesOutstanding">updatesOutstanding</a>().</p> <h3 class="fn"><a name="sourceFolderId"></a><a href="qmailfolderid.html">QMailFolderId</a> QMailDisconnected::sourceFolderId ( const <a href="qmailmessagemetadata.html">QMailMessageMetaData</a> & <i>metaData</i> ) <tt> [static]</tt></h3> -<p>Return the <a href="qmailfolderid.html">QMailFolderId</a> of the folder that contained the message <i>metaData</i> at the time the most recent synchronization of the message with the external server occurred.</p> +<p>Return the <a href="qmailfolderid.html">QMailFolderId</a> of the folder that contained the message <i>metaData</i> at the time the most recent synchronization of the message with the originating external server occurred.</p> <p>See also <a href="qmailmessagemetadata.html#parentFolderId">QMailMessageMetaData::parentFolderId</a>().</p> <h3 class="fn"><a name="sourceKey"></a><a href="qmailmessagekey.html">QMailMessageKey</a> QMailDisconnected::sourceKey ( const <a href="qmailfolderid.html">QMailFolderId</a> & <i>folderId</i> ) <tt> [static]</tt></h3> -<p>Returns a key matching messages who parent folder's identifier was equal to <i>folderId</i>, at the time the most recent synchronization of the message with the external server occurred.</p> +<p>Returns a key matching messages whose parent folder's identifier was equal to <i>folderId</i>, at the time the most recent synchronization of the message with the originating external server occurred.</p> <p>See also <a href="qmailmessagekey.html#parentFolderId">QMailMessageKey::parentFolderId</a>().</p> <h3 class="fn"><a name="updatesOutstanding"></a>bool QMailDisconnected::updatesOutstanding ( const <a href="qmailaccountid.html">QMailAccountId</a> & <i>mailAccountId</i> ) <tt> [static]</tt></h3> <p>Returns true if disconnected operations have been applied to the message store since the most recent synchronization with the account specified by <i>mailAccountId</i>.</p> diff --git a/doc/html/qmailretrievalaction-members.html b/doc/html/qmailretrievalaction-members.html index 909377dc..efe90e17 100644 --- a/doc/html/qmailretrievalaction-members.html +++ b/doc/html/qmailretrievalaction-members.html @@ -82,7 +82,7 @@ <li><div class="fn"><b><a href="http://doc.trolltech.com/4.5/qobject.html#staticQtMetaObject-var">staticQtMetaObject</a></b> : </div></li> <li><div class="fn"><b><a href="qmailserviceaction.html#status">status</a></b> () const : const Status</div></li> <li><div class="fn"><b><a href="qmailserviceaction.html#statusChanged">statusChanged</a></b> ( const QMailServiceAction::Status & )</div></li> -<li><div class="fn"><b><a href="qmailretrievalaction.html#synchronize">synchronize</a></b> ( const QMailAccountId & )</div></li> +<li><div class="fn"><b><a href="qmailretrievalaction.html#synchronizeAll">synchronizeAll</a></b> ( const QMailAccountId & )</div></li> <li><div class="fn"><b><a href="http://doc.trolltech.com/4.5/qobject.html#thread">thread</a></b> () const</div></li> <li><div class="fn"><b><a href="http://doc.trolltech.com/4.5/qobject.html#timerEvent">timerEvent</a></b> ( QTimerEvent * )</div></li> <li><div class="fn"><b><a href="http://doc.trolltech.com/4.5/qobject.html#tr">tr</a></b> ( const char *, const char *, int )</div></li> diff --git a/doc/html/qmailretrievalaction.html b/doc/html/qmailretrievalaction.html index 285f204d..985554dd 100644 --- a/doc/html/qmailretrievalaction.html +++ b/doc/html/qmailretrievalaction.html @@ -47,7 +47,7 @@ <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qmailretrievalaction.html#retrieveMessagePartRange">retrieveMessagePartRange</a></b> ( const QMailMessagePart::Location & <i>partLocation</i>, uint <i>minimum</i> )</td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qmailretrievalaction.html#retrieveMessageRange">retrieveMessageRange</a></b> ( const QMailMessageId & <i>messageId</i>, uint <i>minimum</i> )</td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qmailretrievalaction.html#retrieveMessages">retrieveMessages</a></b> ( const QMailMessageIdList & <i>messageIds</i>, RetrievalSpecification <i>spec</i> = MetaData )</td></tr> -<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qmailretrievalaction.html#synchronize">synchronize</a></b> ( const QMailAccountId & <i>accountId</i> ) <tt> (deprecated)</tt></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qmailretrievalaction.html#synchronizeAll">synchronizeAll</a></b> ( const QMailAccountId & <i>accountId</i> ) <tt> (deprecated)</tt></td></tr> </table> <ul> <li><div bar="2" class="fn"></div>1 public slot inherited from <a href="qmailserviceaction.html#public-slots">QMailServiceAction</a></li> @@ -123,7 +123,7 @@ <p>If <i>spec</i> is <a href="qmailretrievalaction.html#RetrievalSpecification-enum">QMailRetrievalAction::MetaData</a>, then the message server should retrieve the meta data of the each message listed in <i>messageIds</i>.</p> <p>If <i>spec</i> is <a href="qmailretrievalaction.html#RetrievalSpecification-enum">QMailRetrievalAction::Content</a>, then the message server should retrieve the entirety of each message listed in <i>messageIds</i>.</p> <p>The <a href="qmailfolder.html#serverCount">QMailFolder::serverCount</a>(), <a href="qmailfolder.html#serverUnreadCount">QMailFolder::serverUnreadCount</a>() and <a href="qmailfolder.html#serverUndiscoveredCount">QMailFolder::serverUndiscoveredCount</a>() properties will be updated for each folder from which messages are retrieved.</p> -<h3 class="fn"><a name="synchronize"></a>void QMailRetrievalAction::synchronize ( const <a href="qmailaccountid.html">QMailAccountId</a> & <i>accountId</i> ) <tt> [slot]</tt></h3> +<h3 class="fn"><a name="synchronizeAll"></a>void QMailRetrievalAction::synchronizeAll ( const <a href="qmailaccountid.html">QMailAccountId</a> & <i>accountId</i> ) <tt> [slot]</tt></h3> <p>This function is deprecated.</p> <p>Requests that the message server synchronize the set of known folder and message identifiers with those currently available for the account identified by <i>accountId</i>. Newly discovered messages should have their meta data retrieved, messages that have been removed locally using the <a href="qmailstore.html#MessageRemovalOption-enum">QMailStore::CreateRemovalRecord</a> option should be removed from the external server.</p> <p>Changes to the <a href="qmailmessagemetadata.html#Read-var">QMailMessage::Read</a>, and <a href="qmailmessagemetadata.html#Important-var">QMailMessage::Important</a> status flags of a message should be exported to the external server, and the status flags of the message should be updated to reflect any changes to the message on the external server.</p> diff --git a/doc/html/qmf.qhp b/doc/html/qmf.qhp index 52ec17d2..0823719d 100644 --- a/doc/html/qmf.qhp +++ b/doc/html/qmf.qhp @@ -529,6 +529,7 @@ <keyword name="copyPreviousFolder" id="QMailDisconnected::copyPreviousFolder" ref="qmaildisconnected.html#copyPreviousFolder"/> <keyword name="copyToFolder" id="QMailDisconnected::copyToFolder" ref="qmaildisconnected.html#copyToFolder"/> <keyword name="copyToStandardFolder" id="QMailDisconnected::copyToStandardFolder" ref="qmaildisconnected.html#copyToStandardFolder"/> + <keyword name="destinationKey" id="QMailDisconnected::destinationKey" ref="qmaildisconnected.html#destinationKey"/> <keyword name="flagMessage" id="QMailDisconnected::flagMessage" ref="qmaildisconnected.html#flagMessage"/> <keyword name="flagMessages" id="QMailDisconnected::flagMessages" ref="qmaildisconnected.html#flagMessages"/> <keyword name="moveToFolder" id="QMailDisconnected::moveToFolder" ref="qmaildisconnected.html#moveToFolder"/> @@ -1331,7 +1332,7 @@ <keyword name="retrieveMessagePartRange" id="QMailRetrievalAction::retrieveMessagePartRange" ref="qmailretrievalaction.html#retrieveMessagePartRange"/> <keyword name="retrieveMessageRange" id="QMailRetrievalAction::retrieveMessageRange" ref="qmailretrievalaction.html#retrieveMessageRange"/> <keyword name="retrieveMessages" id="QMailRetrievalAction::retrieveMessages" ref="qmailretrievalaction.html#retrieveMessages"/> - <keyword name="synchronize" id="QMailRetrievalAction::synchronize" ref="qmailretrievalaction.html#synchronize"/> + <keyword name="synchronizeAll" id="QMailRetrievalAction::synchronizeAll" ref="qmailretrievalaction.html#synchronizeAll"/> <keyword name="QMailSearchAction" id="QMailSearchAction" ref="qmailsearchaction.html"/> <keyword name="QMailSearchAction::SearchSpecification" id="QMailSearchAction::SearchSpecification" ref="qmailsearchaction.html#SearchSpecification-enum"/> <keyword name="QMailSearchAction::Local" id="QMailSearchAction::Local" ref="qmailsearchaction.html#SearchSpecification-enum"/> diff --git a/doc/html/qt-messaging-framework.dcf b/doc/html/qt-messaging-framework.dcf index 7d0e98a2..32d1bc2f 100644 --- a/doc/html/qt-messaging-framework.dcf +++ b/doc/html/qt-messaging-framework.dcf @@ -303,6 +303,7 @@ <keyword ref="qmaildisconnected.html#copyPreviousFolder">copyPreviousFolder</keyword> <keyword ref="qmaildisconnected.html#copyToFolder">copyToFolder</keyword> <keyword ref="qmaildisconnected.html#copyToStandardFolder">copyToStandardFolder</keyword> + <keyword ref="qmaildisconnected.html#destinationKey">destinationKey</keyword> <keyword ref="qmaildisconnected.html#flagMessage">flagMessage</keyword> <keyword ref="qmaildisconnected.html#flagMessages">flagMessages</keyword> <keyword ref="qmaildisconnected.html#moveToFolder">moveToFolder</keyword> @@ -1280,7 +1281,7 @@ <keyword ref="qmailretrievalaction.html#retrieveMessagePartRange">retrieveMessagePartRange</keyword> <keyword ref="qmailretrievalaction.html#retrieveMessageRange">retrieveMessageRange</keyword> <keyword ref="qmailretrievalaction.html#retrieveMessages">retrieveMessages</keyword> - <keyword ref="qmailretrievalaction.html#synchronize">synchronize</keyword> + <keyword ref="qmailretrievalaction.html#synchronizeAll">synchronizeAll</keyword> <section ref="qmailretrievalaction-members.html" title="List of all members"/> </section> <section ref="qmailsearchaction.html" title="QMailSearchAction Class Reference"> diff --git a/doc/html/qt-messaging-framework.index b/doc/html/qt-messaging-framework.index index 8cccb429..ec570ff0 100644 --- a/doc/html/qt-messaging-framework.index +++ b/doc/html/qt-messaging-framework.index @@ -2663,7 +2663,7 @@ <function access="public" threadsafety="unspecified" status="commendable" name="exportUpdates" fullname="QMailRetrievalAction::exportUpdates" href="qmailretrievalaction.html#exportUpdates" location="qmailserviceaction.h" virtual="non" meta="slot" const="false" static="false" overload="false" type="void" signature="exportUpdates(const QMailAccountId & accountId)"> <parameter left="const QMailAccountId &" right="" name="accountId" default=""/> </function> - <function access="public" threadsafety="unspecified" status="deprecated" name="synchronize" fullname="QMailRetrievalAction::synchronize" href="qmailretrievalaction.html#synchronize" location="qmailserviceaction.h" virtual="non" meta="slot" const="false" static="false" overload="false" type="void" signature="synchronize(const QMailAccountId & accountId)"> + <function access="public" threadsafety="unspecified" status="deprecated" name="synchronizeAll" fullname="QMailRetrievalAction::synchronizeAll" href="qmailretrievalaction.html#synchronizeAll" location="qmailserviceaction.h" virtual="non" meta="slot" const="false" static="false" overload="false" type="void" signature="synchronizeAll(const QMailAccountId & accountId)"> <parameter left="const QMailAccountId &" right="" name="accountId" default=""/> </function> </class> @@ -3000,6 +3000,9 @@ <function access="public" threadsafety="unspecified" status="commendable" name="messageRemovalRecordsRemoved" fullname="QMailStoreAccountFilter::messageRemovalRecordsRemoved" href="qmailstoreaccountfilter.html#messageRemovalRecordsRemoved" location="qmailstoreaccountfilter.h" virtual="non" meta="signal" const="false" static="false" overload="false" type="void" signature="messageRemovalRecordsRemoved()"/> </class> <class access="public" threadsafety="unspecified" status="preliminary" name="QMailDisconnected" href="qmaildisconnected.html" location="qmaildisconnected.h" bases="" module=""> + <function access="public" threadsafety="unspecified" status="commendable" name="destinationKey" fullname="QMailDisconnected::destinationKey" href="qmaildisconnected.html#destinationKey" location="qmaildisconnected.h" virtual="non" meta="plain" const="false" static="true" overload="false" type="QMailMessageKey" signature="destinationKey(const QMailFolderId & folderId)"> + <parameter left="const QMailFolderId &" right="" name="folderId" default=""/> + </function> <function access="public" threadsafety="unspecified" status="commendable" name="sourceKey" fullname="QMailDisconnected::sourceKey" href="qmaildisconnected.html#sourceKey" location="qmaildisconnected.h" virtual="non" meta="plain" const="false" static="true" overload="false" type="QMailMessageKey" signature="sourceKey(const QMailFolderId & folderId)"> <parameter left="const QMailFolderId &" right="" name="folderId" default=""/> </function> |