Collect all outbound email messages — outbound_messages

This function retrieves all outbound messages by making multiple API calls as needed. It handles pagination automatically by generating appropriate batches of count and offset values.

Usage

outbound_messages_collect(token = NULL, quiet = TRUE, ...)

Arguments

token: Character string. Your Postmark API token. If NULL (default), the function will attempt to retrieve the token using get_token() POSTMARK_SERVER_TOKEN as an environment variable. Check the Postmark's API documentation on how to get a server token.
quiet: Logical. If FALSE, displays an informational message about the total number of emails. Default is TRUE (no messages).
...: Additional arguments passed to outbound_messages_fetch().

Value

A data frame or tibble (if tibble is installed) containing all retrieved outbound messages.

The function works by first getting an overview of outbound emails to determine the total count. It then divides this into appropriate batches for pagination and makes multiple API calls to retrieve all messages. Results are combined into a single data frame or tibble.

Examples

if (FALSE) { # \dontrun{
# Get all outbound messages with default settings
messages <- outbound_messages_collect()

# Get messages with a specific token and display count information
messages <- outbound_messages_collect(token = "your_api_token", quiet = FALSE)
} # }