Package: mRpostman 3.0.0

mRpostman: An IMAP Client for R

A session-based IMAP client that implements the full command sets of the IMAP4rev2 (RFC 9051) and IMAP4rev1 (RFC 3501) protocols, along with the optional extensions registered with the Internet Assigned Numbers Authority, allowing virtually all e-mail operations to be performed from within R, paving the way for e-mail data analysis.

Authors:Allan Quadros [aut, cre], Paul Smith [ctb], Kurt Hornik [ctb]

mRpostman_3.0.0.tar.gz
mRpostman_3.0.0.zip(r-4.7-x86_64)mRpostman_3.0.0.zip(r-4.7-arm64)mRpostman_3.0.0.zip(r-4.6-x86_64)mRpostman_3.0.0.zip(r-4.6-arm64)mRpostman_3.0.0.zip(r-4.5-x86_64)
mRpostman_3.0.0.tgz(r-4.6-x86_64)mRpostman_3.0.0.tgz(r-4.6-arm64)mRpostman_3.0.0.tgz(r-4.5-x86_64)mRpostman_3.0.0.tgz(r-4.5-arm64)
mRpostman_3.0.0.tar.gz(r-4.7-arm64)mRpostman_3.0.0.tar.gz(r-4.7-x86_64)mRpostman_3.0.0.tar.gz(r-4.6-arm64)mRpostman_3.0.0.tar.gz(r-4.6-x86_64)
mRpostman_3.0.0.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
DESCRIPTION
card.svg |card.png
mRpostman/json (API)

# Install 'mRpostman' in R:
install.packages('mRpostman', repos = c('https://allanvc.r-universe.dev', 'https://cloud.r-project.org'))

Bug tracker:https://github.com/allanvc/mrpostman/issues

Pkgdown/docs site:https://allanvc.github.io

Uses libs:
  • curl– Easy-to-use client-side URL transfer library
  • zlib– Compression library

On CRAN:

Conda:

curlzlib

7.13 score 32 stars 32 scripts 1.5k downloads 39 exports 25 dependencies

Last updated from:49b5fb7d69. Checks:15 OK. Indexed: yes.

TargetResultTimeFilesSyslog
linux-devel-arm64OK113
linux-devel-x86_64OK132
source / vignettesOK194
linux-release-arm64OK114
linux-release-x86_64OK129
macos-release-arm64OK119
macos-release-x86_64OK165
macos-oldrel-arm64OK93
macos-oldrel-x86_64OK178
windows-devel-arm64OK252
windows-devel-x86_64OK220
windows-release-arm64OK216
windows-release-x86_64OK184
windows-oldrel-x86_64OK186
wasm-releaseOK101

Exports:%>%ANDbeforeclean_msg_textconfigure_imapdecode_mime_headerdecode_mime_textenron_sandboxextract_attachmentsfilter_storedflagfuzzyimap_urlimap_utf7_decodeimap_utf7_encodeImapConingest_maildirlarger_thanlist_attachmentsmetadata_optionsmodseqolder_thanonORparse_bodystructureparse_envelopepopulate_sandboxsandbox_corpussaved_beforesaved_onsaved_sincesent_beforesent_onsent_sincesincesmaller_thanstringverbatimyounger_than

Dependencies:askpassassertthatbase64encclicurlgluehttrjsonlitelifecyclemagrittrmimeopensslpillarpkgconfigR6rlangrvestselectrstringistringrsystibbleutf8vctrsxml2

mRpostman basics
Introduction | Providers and their IMAP urls | Package Structure | 1) How do I start? (Connection configuration) | 2) Server capabilities | 3) Mailbox commands | 3.1) Listing folders | 3.2) Creating a new folder | 3.3) Selecting a folder | 3.4) Examining a folder | 3.5) Renaming a folder | 3.6) Flags listing | 3.7) Deleting a folder | 3.8) Subscribing to a folder | 3.9) Unsubscribing from a folder | 3.10) Listing subscribed folders | 3.11) Folder status | 3.12) Listing special-use folders | 3.13) Server namespaces | 3.14) Folder quota | 3.15) Closing a folder | 3.16) Client/server identification | 4) Single-search (deprecated spellings) | 4.1) Search by date | 4.1.1) By internal date | 4.1.1.1) Before a date | 4.1.1.2) Since a date | 4.1.1.3) By period | 4.1.1.4) On a specific date | 4.1.2) By origination date | 4.1.2.1) Sent before a date | 4.1.2.2) Sent since a date | 4.1.2.3) Sent by period | 4.1.2.4) Sent On a specific date | 4.2) Search by string | 4.3) Search by flag | 4.4) Search by size | 4.4.1) Smaller than | 4.4.1) Larger than | 4.5) Search by within extension | 4.5.1) Younger than | 4.5.2) Older than | 4.6) Server-side sort (SORT) | 4.7) Server-side thread (THREAD) | 5) Custom-search | 6) Fetch | 6.1) Fetch body | 6.2) Fetch header | 6.3) Fetch text | 6.4) Fetch metadata | 7) Attachments | 7.1) Listing attachments without downloading | 7.2) Downloading attachments | 7.3) Extracting from already-fetched messages (offline) | 8) Complementary operations | 8.1) Copy message(s) | 8.2) Get minimum message id | 8.3) Get maximum message id | 8.4) Count messages | 8.5) Delete message(s) | 8.6) Expunge | 8.7) Add/Remove/Replace flags | 8.7.1) Add flags | 8.7.2) Replace flags | 8.7.3) Remove flags | 8.8) Move message(s) | 8.9) Keep-alive (NOOP) | 8.10) Appending a message | 9) The query language (canonical since 3.0.0) | 10) Protocol extensions (since 1.5.0) | 10.1) UIDPLUS: UIDs of appended and copied messages | 10.2) Folder listings in one round trip | 10.3) Saved search results (SEARCHRES) | 10.4) Server-side previews, saved dates, and change tracking | 10.5) Sorting with server-side aggregates (ESORT) | 10.6) Access control lists and quota limits | 11) A second connection for IDLE and MULTIAPPEND (since 2.0.0) | References

Last update: 2026-09-09
Started: 2019-08-14

IMAP OAuth2.0 authentication in mRpostman
Introduction | Step 1 - Create a Google Cloud project | Step 2 - Configure the OAuth consent screen | Step 3 - Create the OAuth client credentials | Step 4 - Obtain an access token | Option A - httr2's built-in flow (recommended) | Option B - Manual loopback flow (no local server) | Step 5 - Open the IMAP connection | Step 6 - Refresh the token | Troubleshooting

Last update: 2026-08-30
Started: 2020-09-08

A reproducible IMAP sandbox with Docker
Introduction | Starting the server | Connecting | Populating the mailbox | A note on dates | Ingesting real data: maildirs and the Enron corpus | A guided tour | Mailbox structure | Searching | Fetching and decoding | Attachments | Server-side sorting and threading | Flags and mailbox management | Protocol extensions | Resetting and tearing down

Last update: 2026-08-29
Started: 2026-07-12

Readme and manuals

Help Manual

Help pageTopics
An IMAP client for RmRpostman-package mRpostman
Relational-operator-function to construct a custom search statementAND
Criterion constructor function to be combined in a custom search statementbefore
Extract text from MIME levelclean_msg_text
IMAP Connection Configurationconfigure_imap
Decode RFC 2047 quoted-printable and base64 MIME headers and stringsdecode_mime_header
Decode RFC 2047 quoted-printable and base64 MIME encoded textdecode_mime_text
Populate a Mailbox with a Subset of the Enron Corpusenron_sandbox
Extract attachments from already-fetched messagesextract_attachments
Criterion constructor referencing a filter stored on the serverfilter_stored
Criterion constructor function to be combined in a custom search statementflag
Criterion modifier for fuzzy (approximate) matching in a custom searchfuzzy
An IMAP URL naming a message, or a part of it, for CATENATE (RFC 5092)imap_url
Encode and decode mailbox names in IMAP modified UTF-7imap_utf7_decode imap_utf7_encode
An IMAP Connection ClassImapCon
Ingest a Local Maildir into an IMAP Folderingest_maildir
Criterion constructor function to be combined in a custom search statementlarger_than
List attachments and content-disposition typeslist_attachments
Message Metadata Optionsmetadata_options
Criterion constructor function for the CONDSTORE extension (RFC 7162)modseq
Criterion constructor function to be combined in a custom search statementolder_than
Criterion constructor function to be combined in a custom search statementon
Combine search criteria with R's own operatorsOps.imap_search
Relational-operator-function to construct a custom search statementOR
Parse an IMAP BODYSTRUCTURE into a data frame of MIME partsparse_bodystructure
Parse an IMAP ENVELOPE into a one-row data frameparse_envelope
Populate a Mailbox with the Synthetic Sandbox Corpuspopulate_sandbox
Generate a Deterministic Synthetic Mail Corpussandbox_corpus
Criterion constructor functions for the SAVEDATE extension (RFC 8514)saved_before saved_on saved_since
Criterion constructor function to be combined in a custom search statementsent_before
Criterion constructor function to be combined in a custom search statementsent_on
Criterion constructor function to be combined in a custom search statementsent_since
Criterion constructor function to be combined in a custom search statementsince
Criterion constructor function to be combined in a custom search statementsmaller_than
Criterion constructor function to be combined in a custom search statementstring
Criterion constructor function for a verbatim IMAP search fragmentverbatim
Criterion constructor function to be combined in a custom search statementyounger_than