diff options
Diffstat (limited to 'doc/html/classConfigElem.html')
| -rw-r--r-- | doc/html/classConfigElem.html | 46 |
1 files changed, 23 insertions, 23 deletions
diff --git a/doc/html/classConfigElem.html b/doc/html/classConfigElem.html index caf3a02..15cac66 100644 --- a/doc/html/classConfigElem.html +++ b/doc/html/classConfigElem.html @@ -429,7 +429,7 @@ Destructor Does nothing. <div class="memdoc"> <p> -Returns whether the account is active. <dl class="return" compact><dt><b>Returns:</b></dt><dd>TRUE - account is active; FALSE - account is not active </dd></dl> +Returns whether the account is active. <dl class="return" compact><dt><b>Returns:</b></dt><dd>true - account is active; false - account is not active </dd></dl> </div> </div><p> @@ -452,7 +452,7 @@ Returns whether the account is active. <dl class="return" compact><dt><b>Returns <p> Sets the account active. <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> - <tr><td valign="top"></td><td valign="top"><em>active</em> </td><td>TRUE - active account; FALSE - deactivate account </td></tr> + <tr><td valign="top"></td><td valign="top"><em>active</em> </td><td>true - active account; false - deactivate account </td></tr> </table> </dl> @@ -564,7 +564,7 @@ Sets the account password. To save it in the configuration file call <a class="e <div class="memdoc"> <p> -Returns whether a password is stored. <dl class="return" compact><dt><b>Returns:</b></dt><dd>TRUE - there is password stored; FALSE - no password stored </dd></dl> +Returns whether a password is stored. <dl class="return" compact><dt><b>Returns:</b></dt><dd>true - there is password stored; false - no password stored </dd></dl> </div> </div><p> @@ -651,8 +651,8 @@ Returns the pointer to the account list view item. <dl class="see" compact><dt>< <div class="memdoc"> <p> -Returns TRUE, if the appropriate list view item is selected. <dl class="return" compact><dt><b>Returns:</b></dt><dd>TRUE - list view item is selected <p> -FALSE - list view item is not selected </dd></dl> +Returns true, if the appropriate list view item is selected. <dl class="return" compact><dt><b>Returns:</b></dt><dd>true - list view item is selected <p> +false - list view item is not selected </dd></dl> </div> </div><p> @@ -764,7 +764,7 @@ Sets the protocol. <dl compact><dt><b>Parameters:</b></dt><dd> <p> Returns the protocol. <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> - <tr><td valign="top"></td><td valign="top"><em>upperCase</em> </td><td>TRUE - transforms the protocol string to upper case </td></tr> + <tr><td valign="top"></td><td valign="top"><em>upperCase</em> </td><td>true - transforms the protocol string to upper case </td></tr> </table> </dl> <dl class="return" compact><dt><b>Returns:</b></dt><dd>protocol </dd></dl> @@ -790,7 +790,7 @@ Returns the protocol. <dl compact><dt><b>Parameters:</b></dt><dd> <p> Enable or disable TLS. <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> - <tr><td valign="top"></td><td valign="top"><em>tls</em> </td><td>TRUE: use TLS; FALSE: don't use TLS </td></tr> + <tr><td valign="top"></td><td valign="top"><em>tls</em> </td><td>true: use TLS; false: don't use TLS </td></tr> </table> </dl> @@ -812,8 +812,8 @@ Enable or disable TLS. <dl compact><dt><b>Parameters:</b></dt><dd> <div class="memdoc"> <p> -Returns whether TLS is enabled. <dl class="return" compact><dt><b>Returns:</b></dt><dd>TRUE: TLS is enabled <p> -FALSE: TLS is disabled </dd></dl> +Returns whether TLS is enabled. <dl class="return" compact><dt><b>Returns:</b></dt><dd>true: TLS is enabled <p> +false: TLS is disabled </dd></dl> </div> </div><p> @@ -1092,8 +1092,8 @@ Opens a dialog to ask for a password, stores it temporarily in the account setti <tr><td valign="top"></td><td valign="top"><em>force</em> </td><td>ask for a new password even if a password is stored </td></tr> </table> </dl> -<dl class="return" compact><dt><b>Returns:</b></dt><dd>TRUE - a password is available <p> -FALSE - no password is available </dd></dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>true - a password is available <p> +false - no password is available </dd></dl> </div> </div><p> @@ -1153,8 +1153,8 @@ Returns the subjects of the selected mails. <dl class="return" compact><dt><b>Re <div class="memdoc"> <p> -Returns whether there are mails in the list that are selected in the list view. <dl class="return" compact><dt><b>Returns:</b></dt><dd>TRUE - there are selected mails <p> -FALSE - there aren't selected mails </dd></dl> +Returns whether there are mails in the list that are selected in the list view. <dl class="return" compact><dt><b>Returns:</b></dt><dd>true - there are selected mails <p> +false - there aren't selected mails </dd></dl> </div> </div><p> @@ -1626,7 +1626,7 @@ Fourth step of the refresh cycle. Copies the known headers of the old mails from <div class="memdoc"> <p> -Sixth step of the refresh cycle. Applies the filters to the mails in the mail list. Invoked by <a class="el" href="classConfigElem.html#91365e361149fd5d564b99a4b7182fc3">swapMailLists()</a>. This methode maybe starts a new refresh cycle because after a deletion or moving we need a actual list of mails on the server. To avoid a never-ending loop you must not call this methode during the second refresh cycle. Therefore it sets filterApplied to TRUE. <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classConfigElem.html#1c5b6fd53a5dfbe13c8d9ef2f3b97608">filterApplied</a> <p> +Sixth step of the refresh cycle. Applies the filters to the mails in the mail list. Invoked by <a class="el" href="classConfigElem.html#91365e361149fd5d564b99a4b7182fc3">swapMailLists()</a>. This methode maybe starts a new refresh cycle because after a deletion or moving we need a actual list of mails on the server. To avoid a never-ending loop you must not call this methode during the second refresh cycle. Therefore it sets filterApplied to true. <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classConfigElem.html#1c5b6fd53a5dfbe13c8d9ef2f3b97608">filterApplied</a> <p> <a class="el" href="classConfigElem.html#6a1f1cb81c4bcca055e0b98bd9fb0cf7">applyFiltersDeleted()</a> </dd></dl> </div> @@ -1647,7 +1647,7 @@ Sixth step of the refresh cycle. Applies the filters to the mails in the mail li <div class="memdoc"> <p> -If there are mails to delete by filters applyFilters will call the regular deletion cycle of this class with set byFilter-flag. Therefore the deletion will not branch to <a class="el" href="classConfigElem.html#f4e51ff42a86a9d5a6ed0f361069d242">commitDeletion()</a> but to this methode. This performs a second refresh cycle to get an effective mail list from the server. This new cycle will not apply the filters again, because the flag filterApplied is set to TRUE. <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classConfigElem.html#f4206aa01f491b7a7e2c57682fe10b31">applyFilters()</a> <p> +If there are mails to delete by filters applyFilters will call the regular deletion cycle of this class with set byFilter-flag. Therefore the deletion will not branch to <a class="el" href="classConfigElem.html#f4e51ff42a86a9d5a6ed0f361069d242">commitDeletion()</a> but to this methode. This performs a second refresh cycle to get an effective mail list from the server. This new cycle will not apply the filters again, because the flag filterApplied is set to true. <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classConfigElem.html#f4206aa01f491b7a7e2c57682fe10b31">applyFilters()</a> <p> <a class="el" href="classConfigElem.html#1c5b6fd53a5dfbe13c8d9ef2f3b97608">filterApplied</a> </dd></dl> </div> @@ -1708,7 +1708,7 @@ Commits the refresh. Starts a pop3 job that will do the commit. Its signal resul <div class="memdoc"> <p> -Fifth step of the refresh cycle. Copies the pointer to the temporary list to m_pshowrecord. Invoked by <a class="el" href="classConfigElem.html#4c8bf2c5e048a2c18048a3444841a668">copyHeaders()</a> and <a class="el" href="classConfigElem.html#5ba4833fd4b897bb21fa31dff2cf5750">slotUIDsReceived()</a>. The temporary list will be the current mail list. At the end it invokes <a class="el" href="classConfigElem.html#3691ecff2aab23143072b434fd304c45">commitRefresh()</a> if the filters were applied (filterApplied == TRUE) or deactive or it invokes <a class="el" href="classConfigElem.html#f4206aa01f491b7a7e2c57682fe10b31">applyFilters()</a> if the filters were not applied (filterApplied == FALSE). <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classConfigElem.html#9724726ea014cf6d22a413d266ca69d2">m_pshowrecord</a> <p> +Fifth step of the refresh cycle. Copies the pointer to the temporary list to m_pshowrecord. Invoked by <a class="el" href="classConfigElem.html#4c8bf2c5e048a2c18048a3444841a668">copyHeaders()</a> and <a class="el" href="classConfigElem.html#5ba4833fd4b897bb21fa31dff2cf5750">slotUIDsReceived()</a>. The temporary list will be the current mail list. At the end it invokes <a class="el" href="classConfigElem.html#3691ecff2aab23143072b434fd304c45">commitRefresh()</a> if the filters were applied (filterApplied == true) or deactive or it invokes <a class="el" href="classConfigElem.html#f4206aa01f491b7a7e2c57682fe10b31">applyFilters()</a> if the filters were not applied (filterApplied == false). <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classConfigElem.html#9724726ea014cf6d22a413d266ca69d2">m_pshowrecord</a> <p> <a class="el" href="classConfigElem.html#4c8bf2c5e048a2c18048a3444841a668">copyHeaders()</a> <p> <a class="el" href="classConfigElem.html#5ba4833fd4b897bb21fa31dff2cf5750">slotUIDsReceived()</a> <p> <a class="el" href="classConfigElem.html#3691ecff2aab23143072b434fd304c45">commitRefresh()</a> <p> @@ -1778,7 +1778,7 @@ Returns whether the given directory is a maildir directory <dl compact><dt><b>Pa <tr><td valign="top"></td><td valign="top"><em>path</em> </td><td>the directory for test </td></tr> </table> </dl> -<dl class="return" compact><dt><b>Returns:</b></dt><dd>TRUE - directory is a maildir directory </dd></dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>true - directory is a maildir directory </dd></dl> </div> </div><p> @@ -1814,7 +1814,7 @@ Writes the given mail into the mailbox. <dl compact><dt><b>Parameters:</b></dt>< <tr><td valign="top"></td><td valign="top"><em>box</em> </td><td>path to the mailbox </td></tr> </table> </dl> -<dl class="return" compact><dt><b>Returns:</b></dt><dd>TRUE - Writing was succesful </dd></dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>true - Writing was succesful </dd></dl> </div> </div><p> @@ -2361,7 +2361,7 @@ Forwards the given mail to SpamAssassin and returns the test result <dl compact> <tr><td valign="top"></td><td valign="top"><em>mail</em> </td><td>the mail to test </td></tr> </table> </dl> -<dl class="return" compact><dt><b>Returns:</b></dt><dd>TRUE - mail is spam </dd></dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>true - mail is spam </dd></dl> </div> </div><p> @@ -2381,7 +2381,7 @@ Forwards the given mail to SpamAssassin and returns the test result <dl compact> <div class="memdoc"> <p> -Looks for a running spamd daemon of SpamAssassin. <dl class="return" compact><dt><b>Returns:</b></dt><dd>TRUE - SpamAssassin is running </dd></dl> +Looks for a running spamd daemon of SpamAssassin. <dl class="return" compact><dt><b>Returns:</b></dt><dd>true - SpamAssassin is running </dd></dl> </div> </div><p> @@ -2490,7 +2490,7 @@ Type of password storage. valid values are: CONFIG_VALUE_ACCOUNT_PASSWORD_DONT_S <div class="memdoc"> <p> -TRUE - account is active; FALSE - account is not active +true - account is active; false - account is not active </div> </div><p> <a class="anchor" name="52f6b77b64915aeadf30cf2e550da876"></a><!-- doxytag: member="ConfigElem::m_strAccount" ref="52f6b77b64915aeadf30cf2e550da876" args="" --> @@ -2783,7 +2783,7 @@ Every account has is own header filter instance. <div class="memdoc"> <p> -This is a flag whether the filters was applied during a refresh cycle. If the some mails was deleted (recommend by the filter), we need a actual list of mails from the server. Therefore a second refresh cycle will be started. To avoid a never-ending loop this flag will be set to TRUE by <a class="el" href="classConfigElem.html#f4206aa01f491b7a7e2c57682fe10b31">applyFilters()</a>. If the second refresh is running this one will not invoke the filters. +This is a flag whether the filters was applied during a refresh cycle. If the some mails was deleted (recommend by the filter), we need a actual list of mails from the server. Therefore a second refresh cycle will be started. To avoid a never-ending loop this flag will be set to true by <a class="el" href="classConfigElem.html#f4206aa01f491b7a7e2c57682fe10b31">applyFilters()</a>. If the second refresh is running this one will not invoke the filters. </div> </div><p> <a class="anchor" name="c3a6aea2718324eba83d02f6e5828fa5"></a><!-- doxytag: member="ConfigElem::deletionPerformedByFilters" ref="c3a6aea2718324eba83d02f6e5828fa5" args="" --> @@ -2828,7 +2828,7 @@ This flag is set by <a class="el" href="classConfigElem.html#6a1f1cb81c4bcca055e <div class="memdoc"> <p> -This flag is set to TRUE by <a class="el" href="classConfigElem.html#f4206aa01f491b7a7e2c57682fe10b31">applyFilters()</a> to indicate the mailbodies are downloading and writing to the mailboxes or spam checking. When this is ended, <a class="el" href="classConfigElem.html#f4206aa01f491b7a7e2c57682fe10b31">applyFilters()</a> will be called again and it reset this flag +This flag is set to true by <a class="el" href="classConfigElem.html#f4206aa01f491b7a7e2c57682fe10b31">applyFilters()</a> to indicate the mailbodies are downloading and writing to the mailboxes or spam checking. When this is ended, <a class="el" href="classConfigElem.html#f4206aa01f491b7a7e2c57682fe10b31">applyFilters()</a> will be called again and it reset this flag </div> </div><p> <a class="anchor" name="30203c10e9c6b563ee9c454269cad8d1"></a><!-- doxytag: member="ConfigElem::moveCounter" ref="30203c10e9c6b563ee9c454269cad8d1" args="" --> |