Internal helper function for defining curl custom request to be used with each search function
define_searchrequest_flag(flag, negate, by, esearch, handle)
A string specifying the flag to be used for filtering messages. Use flag_options to list the common flags used by IMAP servers.
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 curl handle object.
A curl handle object containing the custom request.
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_string
,
check_args_search_within
,
define_searchrequest_custom
,
define_searchrequest_date
,
define_searchrequest_period
,
define_searchrequest_size
,
define_searchrequest_string
,
define_searchrequest_within
,
fix_search_stripping
Other define searchrequest: define_searchrequest_custom
,
define_searchrequest_date
,
define_searchrequest_period
,
define_searchrequest_size
,
define_searchrequest_string
,
define_searchrequest_within