First we will construct a simple text only message
text_msg <- gm_mime() |> gm_to("[email protected]") |> gm_from("[email protected]") |> gm_text_body("Gmailr is a very handy package!")
You can convert the message to a properly formatted MIME message
strwrap(as.character(text_msg)) #>  "MIME-Version: 1.0\r Date: Fri, 30 Jun 2023 05:00:28 GMT\r To:" #>  "[email protected]\r From: [email protected]\r Content-Type:" #>  "multipart/mixed; boundary=1783116a34f2b4e46fabff23476bb1be\r" #>  "--1783116a34f2b4e46fabff23476bb1be\r MIME-Version: 1.0\r Date: Fri, 30 Jun" #>  "2023 05:00:28 GMT\r Content-Type: text/plain; charset=utf-8;" #>  "format=flowed\r Content-Transfer-Encoding: quoted-printable\r Gmailr is a" #>  "very handy package!\r --1783116a34f2b4e46fabff23476bb1be--\r"
You can also construct html messages. It is customary to provide a text only message along with the html message, but with modern email clients this is not strictly necessary.
You can add attachments to your message in two ways.
gm_attach_file(). The mime type is automatically guessed by
mime::guess_type, or you can specify it yourself with the
gm_attach_part()to attach the binary data to your file.
You can also add use attached images in HTML by setting the Content
ID feature of mime emails. This can be done by referencing the image via
<img src=cid:xyz> tag using the
send_file(). The tag value can by any unique
identifier. E.g. here is an example of including a ggplot2 image
# First create a plot to send, and save it to mtcars.png mtcars$gear <- as.factor(mtcars$gear) png("mtcars.png", width = 400, height = 400, pointsize = 12) with( mtcars, plot(hp, mpg, col = as.factor(gear), pch = 19, xlab = "Horsepower", ylab = "Miles / gallon" ) ) legend("topright", title = "# gears", pch = 19, col = seq_along(levels(mtcars$gear)), legend = levels(mtcars$gear) ) dev.off() #> quartz_off_screen #> 2 # Next create an HTML email that references the plot as 'foobar' email <- gm_mime() |> gm_to("[email protected]") |> gm_from("[email protected]") |> gm_subject("Cars report") |> gm_html_body( '<h1>A plot of <b>MotorTrend</b> data <i>(1974)</i></h1> <br><img src="cid:foobar">' ) |> gm_attach_file("mtcars.png", id = "foobar")
You can upload any mime message into your gmail drafts using
gm_create_draft(). Be sure to give yourself at least
compose permissions first.
This inserts the message directly into your mailbox, bypassing gmail’s default scanning and classification algorithms.
gm_send_draft() sends an email using the
draft_id of an existing draft (possibly created with
It is possible to have a high-functioning Google account that does
not have Gmail enabled. For example, your account might be fully
operational with respect to Google Drive and yet have no mail
capabilities. Such an account cannot be used with the Gmail API and
gmailr. However, you will still be able to
gmailr authorization process via
gm_auth(). The problem will only reveal itself upon the
first attempt to use the API and it will look something like this:
Error in gmailr_POST(c("messages", "send"), user_id, class = "gmail_message", : Gmail API error: 400 Mail service not enabled
You can confirm the account’s lack of mail capability by visiting
https://mail.google.com/mail/ while logged in. If you don’t
already have Gmail, this link gives you the option of adding mail to
your existing account or creating a new, mail-capable account.