Learn R Programming

mRpostman (version 0.3.1)

check_args_move_msg: Move Message Arguments Check

Description

Internal helper function for checking the arguments used in move_msg function.

Usage

check_args_move_msg(imapconf, msg_id, by, to_mbox, retries)

Arguments

imapconf

An object of class imapconf generated with configure_imap and with a mbox item added after a mailbox selection with select_mailbox.

msg_id

A numeric vetor containing one or more messages ids.

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

to_mbox

A character string specifying the mailbox to which messages will be moved to.

retries

Number of attempts to connect and execute the command. Default is 2.

reselect_mbox

If TRUE, calls select_mailbox(mbox = to_mbox) before returning the output. Default is FALSE for moving and copying operations, whereas it is TRUE for renaming mailboxes.

Value

NULL if arguments are correct.

See Also

Other miscellaneous helpers: check_args_remove_flags

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_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