From 6d1638620f3da1664aa3b86c46852515fc78707c Mon Sep 17 00:00:00 2001 From: Michele Calgaro Date: Sat, 22 Mar 2025 13:58:57 +0900 Subject: Replace TRUE/FALSE with boolean values true/false Signed-off-by: Michele Calgaro --- doc/html/classConfigElem.html | 46 +++++++++++++++++++++---------------------- 1 file changed, 23 insertions(+), 23 deletions(-) (limited to 'doc/html/classConfigElem.html') 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.

-Returns whether the account is active.

Returns:
TRUE - account is active; FALSE - account is not active
+Returns whether the account is active.
Returns:
true - account is active; false - account is not active

@@ -452,7 +452,7 @@ Returns whether the account is active.

Returns

Sets the account active.

Parameters:
- +
active TRUE - active account; FALSE - deactivate account
active true - active account; false - deactivate account
@@ -564,7 +564,7 @@ Sets the account password. To save it in the configuration file call

-Returns whether a password is stored.

Returns:
TRUE - there is password stored; FALSE - no password stored
+Returns whether a password is stored.
Returns:
true - there is password stored; false - no password stored

@@ -651,8 +651,8 @@ Returns the pointer to the account list view item.

<

-Returns TRUE, if the appropriate list view item is selected.

Returns:
TRUE - list view item is selected

-FALSE - list view item is not selected

+Returns true, if the appropriate list view item is selected.
Returns:
true - list view item is selected

+false - list view item is not selected

@@ -764,7 +764,7 @@ Sets the protocol.

Parameters:

Returns the protocol.

Parameters:
- +
upperCase TRUE - transforms the protocol string to upper case
upperCase true - transforms the protocol string to upper case
Returns:
protocol
@@ -790,7 +790,7 @@ Returns the protocol.
Parameters:

Enable or disable TLS.

Parameters:
- +
tls TRUE: use TLS; FALSE: don't use TLS
tls true: use TLS; false: don't use TLS
@@ -812,8 +812,8 @@ Enable or disable TLS.
Parameters:

-Returns whether TLS is enabled.

Returns:
TRUE: TLS is enabled

-FALSE: TLS is disabled

+Returns whether TLS is enabled.
Returns:
true: TLS is enabled

+false: TLS is disabled

@@ -1092,8 +1092,8 @@ Opens a dialog to ask for a password, stores it temporarily in the account setti force ask for a new password even if a password is stored

-
Returns:
TRUE - a password is available

-FALSE - no password is available

+
Returns:
true - a password is available

+false - no password is available

@@ -1153,8 +1153,8 @@ Returns the subjects of the selected mails.

Re

-Returns whether there are mails in the list that are selected in the list view.

Returns:
TRUE - there are selected mails

-FALSE - there aren't selected mails

+Returns whether there are mails in the list that are selected in the list view.
Returns:
true - there are selected mails

+false - there aren't selected mails

@@ -1626,7 +1626,7 @@ Fourth step of the refresh cycle. Copies the known headers of the old mails from

-Sixth step of the refresh cycle. Applies the filters to the mails in the mail list. Invoked by swapMailLists(). 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.

See also:
filterApplied

+Sixth step of the refresh cycle. Applies the filters to the mails in the mail list. Invoked by swapMailLists(). 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.

See also:
filterApplied

applyFiltersDeleted()

@@ -1647,7 +1647,7 @@ Sixth step of the refresh cycle. Applies the filters to the mails in the mail li

-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 commitDeletion() 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.

See also:
applyFilters()

+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 commitDeletion() 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.

See also:
applyFilters()

filterApplied

@@ -1708,7 +1708,7 @@ Commits the refresh. Starts a pop3 job that will do the commit. Its signal resul

-Fifth step of the refresh cycle. Copies the pointer to the temporary list to m_pshowrecord. Invoked by copyHeaders() and slotUIDsReceived(). The temporary list will be the current mail list. At the end it invokes commitRefresh() if the filters were applied (filterApplied == TRUE) or deactive or it invokes applyFilters() if the filters were not applied (filterApplied == FALSE).

See also:
m_pshowrecord

+Fifth step of the refresh cycle. Copies the pointer to the temporary list to m_pshowrecord. Invoked by copyHeaders() and slotUIDsReceived(). The temporary list will be the current mail list. At the end it invokes commitRefresh() if the filters were applied (filterApplied == true) or deactive or it invokes applyFilters() if the filters were not applied (filterApplied == false).

See also:
m_pshowrecord

copyHeaders()

slotUIDsReceived()

commitRefresh()

@@ -1778,7 +1778,7 @@ Returns whether the given directory is a maildir directory

Pa path the directory for test
-
Returns:
TRUE - directory is a maildir directory
+
Returns:
true - directory is a maildir directory

@@ -1814,7 +1814,7 @@ Writes the given mail into the mailbox.

Parameters:
< box path to the mailbox
-
Returns:
TRUE - Writing was succesful
+
Returns:
true - Writing was succesful

@@ -2361,7 +2361,7 @@ Forwards the given mail to SpamAssassin and returns the test result

mail the mail to test
-
Returns:
TRUE - mail is spam
+
Returns:
true - mail is spam

@@ -2381,7 +2381,7 @@ Forwards the given mail to SpamAssassin and returns the test result

-Looks for a running spamd daemon of SpamAssassin.

Returns:
TRUE - SpamAssassin is running
+Looks for a running spamd daemon of SpamAssassin.
Returns:
true - SpamAssassin is running

@@ -2490,7 +2490,7 @@ Type of password storage. valid values are: CONFIG_VALUE_ACCOUNT_PASSWORD_DONT_S

-TRUE - account is active; FALSE - account is not active +true - account is active; false - account is not active

@@ -2783,7 +2783,7 @@ Every account has is own header filter instance.

-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 applyFilters(). 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 applyFilters(). If the second refresh is running this one will not invoke the filters.

@@ -2828,7 +2828,7 @@ This flag is set by

-This flag is set to TRUE by applyFilters() to indicate the mailbodies are downloading and writing to the mailboxes or spam checking. When this is ended, applyFilters() will be called again and it reset this flag +This flag is set to true by applyFilters() to indicate the mailbodies are downloading and writing to the mailboxes or spam checking. When this is ended, applyFilters() will be called again and it reset this flag

-- cgit v1.2.3