In mrchypark/sendgridr: Mail Sender Using 'Sendgrid' Service

knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
library(sendgridr)

sendgridr

The goal of sendgridr is to mail using r with sendgrid service that provides free 100 mail per day forever.

Installation

# CRAN version
install.packages("sendgridr")

# Dev version
install.packages("sendgridr", repos = "https://mrchypark.r-universe.dev")

Set API key for authentication

You can set api key using auth_set() function. Also auth_check() function check api key works.

auth_check()
auth_set()

Send mail

Example code

Please replace your conditions.

mail() |>
  from("[e-mail]", "example name for display") |>
  to("[e-mail]", "example name for display 2") |>
  subject("test mail title") |>
  body("hello world!")  |>
  ## attachments is optional
  attachments("report.html") |>
  send()

sg_mail class

mail() function create sg_mail class object and also list. sg_mail class only has print method.

sendproject1 <- mail()
class(sendproject1)
sendproject1

to, from, subject, body are required. cc, bcc, attachments are optional.

multi- setting using inline

to, cc, bcc, attachments functions are able to set multi values.

library(sendgridr)
mail() |>
  from("[e-mail]", "[e-mail]") |>
  to("[e-mail]", "1 exam") |>
  to("[e-mail]", "2 exam") |>
  to("[e-mail]", "3 exam") |>
  subject("test mail title") |>
  body("hello world!")

Code of Conduct

Please note that the sendgridr project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.

mrchypark/sendgridr documentation built on Feb. 15, 2024, 9:33 p.m.