Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rstudio/blastula
Easily send great-looking HTML email messages from R
https://github.com/rstudio/blastula
easy-to-use email html markdown r responsive-email smtp
Last synced: 6 days ago
JSON representation
Easily send great-looking HTML email messages from R
- Host: GitHub
- URL: https://github.com/rstudio/blastula
- Owner: rstudio
- License: other
- Created: 2017-08-13T06:21:56.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-07-10T12:09:17.000Z (6 months ago)
- Last Synced: 2024-12-30T04:00:18.558Z (13 days ago)
- Topics: easy-to-use, email, html, markdown, r, responsive-email, smtp
- Language: R
- Homepage: https://pkgs.rstudio.com/blastula
- Size: 44.6 MB
- Stars: 549
- Watchers: 22
- Forks: 84
- Open Issues: 104
-
Metadata Files:
- Readme: README.md
- Changelog: NEWS.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-shiny-extensions - blastula - Easily send HTML email messages from R. (Backend / Notification Integration)
- jimsghstars - rstudio/blastula - Easily send great-looking HTML email messages from R (R)
README
The **blastula** package makes it easy to produce and send HTML email from **R**. The message can have three content areas (the body, the header, and the footer) and we can insert **Markdown** text, block-based components, and even HTML fragments. The underlying HTML/CSS is meant to display properly across a wide range of email clients and webmail services. The resulting email message is responsive so it’ll look great on both large displays and mobile devices.
### Composing an Email Message
When you compose an email, you can use objects from the global workspace and work them into the message content. Let’s create a nicely formatted date/time string (`date_time`) with the `add_readable_time()` function, and, transform an image on disk to an HTML string object (`img_string`).
```r
# Get a nicely formatted date/time string
date_time <- add_readable_time()
# Create an image string using an on-disk
# image file
img_file_path <-
system.file(
"img", "pexels-photo-267151.jpeg",
package = "blastula"
)
img_string <- add_image(file = img_file_path)
```
Now we use the `compose_email()` function to compose the email. There are three main arguments here: `body`, `header`, and `footer`. You can supply **Markdown** text to any of these content areas to get rendered HTML.
In the example code below, the strings that are part of the email body and the email footer are combined with `glue::glue()` and, since we have Markdown and HTML fragments, we need to use the `md()` function.
```r
email <-
compose_email(
body = md(glue::glue(
"Hello,
This is a *great* picture I found when looking
for sun + cloud photos:
{img_string}
")),
footer = md(glue::glue("Email sent on {date_time}."))
)
```
After creating the email message, we can look at it to ensure that the formatting is as expected. Simply call the object itself and it will be displayed in the Viewer.
```r
# Preview the email
email
```
### Sending an Email Message via SMTP
We can store SMTP email credentials in a file using the `create_smtp_creds_file()` function. There are also other ways to set up SMTP access credentials (like using system-wide key-value store through the `create_smtp_creds_key()` function).
Having generated a credentials file, we can use the `smtp_send()` function (along with the `creds_file()` credentials helper function) to send the email through an SMTP server.
```r
# Sending email by SMTP using a credentials file
email |>
smtp_send(
to = "[email protected]",
from = "[email protected]",
subject = "Testing the `smtp_send()` function",
credentials = creds_file("email_creds")
)
```
### Sending Email Messages through Posit Connect
We can also send email based on **R Markdown** files through **Posit Connect**. The `prepare_rsc_example_files()` function provides .Rmd files that facilitate a main report + email report workflow. The key components are the `blastula::blastula_email` output type for the email report, and the use of `render_connect_email()` and `attach_connect_email()` in the main report.
### Installation
Want to try this out? The **blastula** package is available on **CRAN**:
```r
install.packages("blastula")
```
You can also install the development version of **blastula** from **GitHub**:
```r
devtools::install_github("rstudio/blastula")
```
If you encounter a bug, have usage questions, or want to share ideas to make this package better, feel free to file an [issue](https://github.com/rstudio/blastula/issues).
#### Code of Conduct
Please note that the `rstudio/blastula` project is released with a [contributor code of conduct](https://www.contributor-covenant.org/version/2/1/code_of_conduct.html).
By participating in this project you agree to abide by its terms.
#### 📄 License
**blastula** is licensed under the MIT license. See the [`LICENSE.md`](LICENSE.md) file for more details.
© Posit Software, PBC.
#### 🏛️ Governance
This project is primarily maintained by **Richard Iannone**. Should there also be other authors, they might occasionally assist with some of these duties.