Learn R Programming

mRpostman (version 0.3.1)

define_searchrequest_size: Size Search Request

Description

Internal helper function for defining curl custom request to be used with each search function

Usage

define_searchrequest_size(operation, size, negate, by, flag, esearch,
  handle)

Arguments

operation

A character indicating which custom operation to execute.

size

An integer specifying the size (in number of characters) of message to be used as search criterion.

negate

If TRUE, negates the search and seeks for "NOT search_criterion". Default is FALSE.

by

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".

flag

Optional parameter that adds a flag filter to the search. Use flag_options to list the common flags used by IMAP servers. Default is NULL.

esearch

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.

handle

A curl handle object.

Value

A curl handle object containing the custom request.

See Also

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_flag, define_searchrequest_period, define_searchrequest_string, define_searchrequest_within, fix_search_stripping

Other define searchrequest: define_searchrequest_custom, define_searchrequest_date, define_searchrequest_flag, define_searchrequest_period, define_searchrequest_string, define_searchrequest_within