• Stars
    star
    230
  • Rank 170,134 (Top 4 %)
  • Language
    R
  • License
    Other
  • Created almost 10 years ago
  • Updated 4 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Access the Gmail RESTful API from R.

gmailr

R-CMD-check Codecov test coverage

Exposing the Gmail API from R.

Installation

Install the released version of gmailr from CRAN:

install.packages("gmailr")

Or install the development version from GitHub with:

# install.packages("pak")
pak::pak("r-lib/gmailr")

Setup

In order to use gmailr, you will need to create your own OAuth client. This is documented in the article Set up an OAuth client.

After successful setup, a typical gmailr-using script should start like this:

library(gmailr)
gm_auth_configure()

# your gmailr code ...

The gm_auth_configure() function will discover and configure the OAuth client. Alternatively, it can also accept an explicit path to the client JSON.

Writing new emails

Create a new email with gm_mime() and the helper functions (gm_from(), gm_to(), etc.). When developing the message, you might want to use gm_create_draft() to verify your email is formatted as you expect. Then you can send the draft with gm_send_draft() or send the original MIME message with gm_send_message().

test_email <-
  gm_mime() |>
  gm_to("PUT_A_VALID_EMAIL_ADDRESS_THAT_YOU_CAN_CHECK_HERE") |>
  gm_from("PUT_THE_GMAIL_ADDRESS_ASSOCIATED_WITH_YOUR_GOOGLE_ACCOUNT_HERE") |>
  gm_subject("this is just a gmailr test") |>
  gm_text_body("Can you hear me now?")

# Verify it looks correct, i.e. look at your Gmail drafts in the browser
d <- gm_create_draft(test_email)

# If all is good with your draft, then you can send the existing draft
gm_send_draft(d)

# or the existing MIME message
gm_send_message(test_email)

You can add a file attachment to your message with gm_attach_file().

write.csv(mtcars,"mtcars.csv")
test_email <- test_email |> gm_attach_file("mtcars.csv")

# Verify it looks correct
d <- gm_create_draft(test_email)

# If so, send it
gm_send_draft(d)

Reading emails

gmail shows you threads of messages in the web UI, you can retrieve all threads with gm_threads(), and retrieve a specific thread with gm_thread()

# view the latest thread
my_threads <- gm_threads(num_results = 10)

# retrieve the latest thread by retrieving the first ID

latest_thread <- gm_thread(gm_id(my_threads)[[1]])

# The messages in the thread will now be in a list
latest_thread$messages

# Retrieve parts of a specific message with the accessors
my_msg <- latest_thread$messages[[1]]

gm_to(my_msg)
gm_from(my_msg)
gm_date(my_msg)
gm_subject(my_msg)
gm_body(my_msg)

# If a message has attachments, download them all locally with `gm_save_attachments()`.
gm_save_attachments(my_msg)

Features

  • retrieve data from your email
    • drafts: my_drafts = gm_drafts()
    • history: my_history = history(start_num)
    • labels: my_labels = gm_labels()
    • messages: my_messages = gm_messages("search query")
    • threads: my_threads = gm_threads("search query")
  • Create and send emails and drafts: see sending_messages vignette
  • manage email labels programmatically: modify_thread(thread_id, add_labels=c("label_1"), remove_labels=c("label_2"))
  • put things in the gmail trash
    • messages: gm_trash_message(message_id)
    • threads: trash_thread(thread_id)
  • take things out of the gmail trash
    • messages: gm_untrash_message(message_id)
    • threads: untrash_thread(thread_id)
  • delete directly without using the trash
    • messages: gm_delete_message(message_id)
    • threads: delete_thread(thread_id)

Using gmailr in deployed applications

If you are using gmailr in a deployed application you will need to copy two pieces to your deployed location.

  1. The JSON for your OAuth client.
  2. The OAuth token cache, by default this is the return value of rappdirs::user_cache_dir("gargle").

The easiest thing to do to ensure you are copying only the gmailr oauth token is to set this explicitly locally, e.g. do the following.

Run locally

# Configure your app
gm_auth_configure(path = "credentials.json")

# Authenticate with the new cache, store tokens in .secret
gm_auth(cache = ".secret")
# Go through the oauth flow

Then copy credentials.json and the .secret directory to your remote location.

Run remotely

# Configure your app
gm_auth_configure(path = "credentials.json")

# Authenticate with the tokens in the copied cache
gm_auth(email = TRUE, cache = ".secret")

There are additional details on dealing with non-interactive auth in the gargle documentation.

Policies

Privacy policy

Community Examples

More Repositories

1

devtools

Tools to make an R developer's life easier
R
2,360
star
2

lintr

Static Code Analysis for R
R
1,159
star
3

httr

httr: a friendly http package for R
R
982
star
4

actions

GitHub Actions for the R community
TypeScript
917
star
5

testthat

An R 📦 to make testing 😀
R
867
star
6

usethis

Set up commonly used 📦 components
R
821
star
7

pkgdown

Generate static html documentation for an R package
R
703
star
8

styler

Non-invasive pretty printing of R code
R
692
star
9

pak

A fresh approach to package installation
C
630
star
10

cli

Tools for making beautiful & useful command line interfaces
R
618
star
11

roxygen2

Generate R package documentation from inline R comments
R
579
star
12

rig

The R Installation Manager
Rust
555
star
13

rlang

Low-level API for programming with R
R
484
star
14

progress

Progress bar in your R terminal
R
457
star
15

R6

Encapsulated object-oriented programming for R
R
402
star
16

here

A simpler way to find your files
R
401
star
17

scales

Tools for ggplot2 scales
R
388
star
18

fs

Provide cross platform file operations based on libuv.
C
361
star
19

rex

Friendly regular expressions for R.
R
331
star
20

covr

Test coverage reports for R
R
329
star
21

crayon

🖍️ R package for colored terminal output — now superseded by cli
R
322
star
22

remotes

Install R packages from GitHub, GitLab, Bitbucket, git, svn repositories, URLs
R
321
star
23

memoise

Easy memoisation for R
R
314
star
24

lobstr

Understanding complex R objects with tools similar to str()
R
296
star
25

slider

Sliding Window Functions
R
290
star
26

callr

Call R from R
R
289
star
27

vctrs

Generic programming with typed R vectors
C
280
star
28

waldo

Find differences between R objects
R
275
star
29

zeallot

Variable assignment with zeal! (or multiple, unpacking, and destructuring assignment in R)
R
250
star
30

conflicted

An alternative conflict resolution strategy for R
R
243
star
31

bench

High Precision Timing of R Expressions
R
242
star
32

processx

Execute and Control Subprocesses from R
R
227
star
33

httr2

Make HTTP requests and process their responses. A modern reimagining of httr.
R
223
star
34

asciicast

Turn R scripts into terminal screencasts
R
223
star
35

xml2

Bindings to libxml2
R
218
star
36

gh

Minimalistic GitHub API client in R
R
217
star
37

cpp11

cpp11 helps you to interact with R objects using C++ code.
C++
192
star
38

keyring

🔐 Access the system credential store from R
R
188
star
39

vdiffr

Visual regression testing and graphical diffing with testthat
C++
181
star
40

svglite

A lightweight svg graphics device for R
C++
178
star
41

pillar

Format columns with colour
R
173
star
42

ragg

Graphic Devices Based on AGG
C++
170
star
43

withr

Methods For Temporarily Modifying Global State
R
169
star
44

hugodown

Make websites with hugo and RMarkdown
R
165
star
45

ymlthis

write YAML for R Markdown, bookdown, blogdown, and more
R
163
star
46

coro

Coroutines for R
R
150
star
47

rprojroot

Finding files in project subdirectories
R
147
star
48

debugme

Easy and efficient debugging for R packages
R
145
star
49

available

Check if a package name is available to use
R
142
star
50

archive

R bindings to libarchive, supporting a large variety of archive formats
C++
141
star
51

ellipsis

Tools for Working with ...
R
139
star
52

later

Schedule an R function or formula to run after a specified period of time.
C++
136
star
53

gert

Simple git client for R
C
136
star
54

itdepends

R
133
star
55

rray

Simple Arrays
R
130
star
56

isoband

isoband: An R package to generate contour lines and polygons.
C++
130
star
57

prettyunits

Pretty, human readable formatting of quantities
JavaScript
128
star
58

fastmap

Fast map implementation for R
C++
127
star
59

desc

Manipulate DESCRIPTION files
R
121
star
60

tidyselect

A backend for functions taking tidyverse selections
R
121
star
61

gargle

Infrastructure for calling Google APIs from R, including auth
R
113
star
62

rcmdcheck

Run R CMD check from R and collect the results
R
109
star
63

evaluate

A version of eval for R that returns more information about what happened
R
108
star
64

prettycode

Syntax highlight R code in the terminal
R
100
star
65

revdepcheck

R package reverse dependency checking
R
99
star
66

sloop

S language OOP ⛵️
R
99
star
67

mockery

A mocking library for R.
R
98
star
68

tree-sitter-r

C
95
star
69

clock

A Date-Time Library for R
R
95
star
70

pkgdepends

R Package Dependency Resolution
R
93
star
71

systemfonts

System Native Font Handling in R
C++
91
star
72

lifecycle

Manage the life cycle of your exported functions and arguments
R
90
star
73

gtable

The layout packages that powers ggplot2
R
85
star
74

askpass

Password Entry for R, Git, and SSH
R
83
star
75

commonmark

High Performance CommonMark and Github Markdown Rendering in R
C
83
star
76

zip

Platform independent zip compression via miniz
C
82
star
77

rappdirs

Find OS-specific directories to store data, caches, and logs. A port of python's AppDirs
R
81
star
78

downlit

Syntax Highlighting and Automatic Linking
R
81
star
79

clisymbols

Unicode symbols for CLI applications, with fallbacks
R
76
star
80

ps

R package to query, list, manipulate system processes
C
72
star
81

sessioninfo

Print Session Information
R
72
star
82

pkgapi

Create a map of functions for an R package - WORK IN PROGRESS!
R
70
star
83

credentials

Tools for Managing SSH and Git Credentials
R
70
star
84

sodium

R bindings to libsodium
R
68
star
85

roxygen2md

Convert elements of roxygen documentation to markdown
R
67
star
86

backports

Reimplementations of Functions Introduced Since R-3.0.0
R
65
star
87

pkgbuild

Find tools needed to build R packages
R
65
star
88

webfakes

Fake web apps for HTTP testing R packages
C
61
star
89

cliapp

Rich Command Line Applications
R
60
star
90

generics

Common generic methods
R
59
star
91

diffviewer

HTML widget to visually compare files
JavaScript
57
star
92

liteq

Serverless R message queue using SQLite
R
56
star
93

pkgload

Simulate installing and loading a package
R
54
star
94

cachem

Key-value caches for R
R
53
star
95

carrier

Create standalone functions for remote execution
R
50
star
96

brio

Basic R Input Output
R
50
star
97

marquee

Markdown Parser and Renderer for R Graphics
C
49
star
98

jose

Javascript Object Signing and Encryption for R
R
48
star
99

urlchecker

Run CRAN URL checks from older versions of R
R
45
star
100

pkgconfig

Private configuration for R packages
R
41
star