Internal helper function for checking arguments used in search functions.
check_args_search_string(imapconf, section_or_field, string, negate, by,
esearch, return_imapconf, retries)An object of class imapconf generated with
configure_imap and with a mbox item added after a
mailbox selection with select_mailbox.
A mandatory character string specifying in which message's Section or Header Field to search for the provided string. For some available options, see section_or_field_options.
A character string specifying the word or expression to search for in messages.
If TRUE, negates the search and seeks for
"NOT search_criterion". Default is FALSE.
Which id (MSN or UID) to use when searching for
messages. "MSN" or message squence number is a message's relative
position to the older message in the mailbox. It may change after deleting
or moving messages. For instance, if a message is deleted, message sequence
numbers are reordered to fill the gap. "UID" or unique identifier
is always the same during the life cycle of a message. Default is
"MSN".
A logical. Default is FALSE. If the IMAP server has
ESEARCH capability, it can be used to optimize search results. It
allows to condense results to message sets to cut down on transmission
costs, e.g. 1:5 instead of writing ids individually such as
1,2,3,4,5. It can be used along with buffersize to avoid results
stripping. Check if your IMAP server supports SEARCH with
list_server_capabilities.
A logical. If TRUE, the function returns a
list of length 2, containing the imapconf object
(IMAP settings) and the search results as message ids ("MSN" or
"UID"). If FALSE, returns only the message ids as a numeric
vector. Default is TRUE.
Number of attempts to connect and execute the command. Default
is 2.
NULL if arguments are correct.
Other search helper: check_args_custom_search,
check_args_search_date,
check_args_search_flag,
check_args_search_period,
check_args_search_size,
check_args_search_within,
define_searchrequest_custom,
define_searchrequest_date,
define_searchrequest_flag,
define_searchrequest_period,
define_searchrequest_size,
define_searchrequest_string,
define_searchrequest_within,
fix_search_stripping
Other check args: check_args_add_replace_flags,
check_args_copy_msg,
check_args_custom_search,
check_args_delete_msg,
check_args_expunge,
check_args_fetch_full_msg,
check_args_fetch_msg_header,
check_args_fetch_msg_metadata,
check_args_fetch_msg_text,
check_args_get_attachments,
check_args_get_max_min_id,
check_args_list_attachments,
check_args_move_msg,
check_args_remove_flags,
check_args_search_date,
check_args_search_flag,
check_args_search_period,
check_args_search_size,
check_args_search_within