Internal helper function for checking arguments used in fetch functions.
check_args_fetch_full_msg(imapconf, msg_id, by, peek, partial,
write_to_disk, keep_in_mem, retries)
An object of class imapconf
generated with
configure_imap and with a mbox
item added after a
mailbox selection with select_mailbox.
A numeric vetor containing one or more messages ids.
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"
.
If TRUE
, it does not mark messages as "read" after
fetching. Default is TRUE
.
NULL
or a character string with format
"startchar.endchar" indicating the size (in characters) of a message slice
to fetch. Default is NULL
, which fetchs the full specified content.
If TRUE
writes fetch content of each message
to the disk as a text file in the working directory. Default is FALSE
.
If TRUE
keeps a copy of fetch results as an
list in the R session when write_to_disk = TRUE
. Default is
TRUE
. It can only be set FALSE
when
write_to_disk = TRUE
.
Number of attempts to connect and execute the command. Default
is 2
.
NULL
if arguments are correct.
Other fetch helper: check_args_fetch_msg_header
,
check_args_fetch_msg_metadata
,
check_args_fetch_msg_text
,
clean_fetch_results
,
decode_base64_text_if_needed
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_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_string
,
check_args_search_within