Data

Tools

Indexes

Applications

Experiments

Open Source Science

blastula

Easily send great-looking HTML email messages from R

https://github.com/rstudio/blastula

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Committers with academic emails
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (16.2%) to scientific vocabulary

Keywords

easy-to-use email html markdown r responsive-email smtp

Keywords from Contributors

rmarkdown latex shiny book bookdown documentation-tool web-app web-development epub gitbook
Last synced: 6 months ago · JSON representation

Repository

Easily send great-looking HTML email messages from R

Basic Info
Statistics
  • Stars: 559
  • Watchers: 20
  • Forks: 85
  • Open Issues: 106
  • Releases: 10
Topics
easy-to-use email html markdown r responsive-email smtp
Created over 8 years ago · Last pushed 11 months ago
Metadata Files
Readme Changelog License Code of conduct

README.md


CRAN status License: MIT R build status Coverage status The project has reached a stable, usable state and is being actively developed. Monthly Downloads Total Downloads Contributor Covenant

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

datetime <- addreadable_time()

Create an image string using an on-disk

image file

imgfilepath <- system.file( "img", "pexels-photo-267151.jpeg", package = "blastula" )

imgstring <- addimage(file = imgfilepath) ```

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:

{imgstring} ")), footer = md(glue::glue("Email sent on {datetime}.")) ) ```

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 |> smtpsend( to = "janedoe@example.com", from = "joepublic@example.net", subject = "Testing the `smtpsend()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.

Code of Conduct

Please note that the rstudio/blastula project is released with a contributor code of conduct.
By participating in this project you agree to abide by its terms.

📄 License

blastula is licensed under the MIT license. See the 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.

Owner

  • Name: RStudio
  • Login: rstudio
  • Kind: organization
  • Email: info@rstudio.org
  • Location: Boston, MA

GitHub Events

Total
  • Issues event: 9
  • Watch event: 17
  • Delete event: 1
  • Issue comment event: 18
  • Push event: 9
  • Pull request event: 2
  • Fork event: 1
  • Create event: 1
Last Year
  • Issues event: 9
  • Watch event: 17
  • Delete event: 1
  • Issue comment event: 18
  • Push event: 9
  • Pull request event: 2
  • Fork event: 1
  • Create event: 1

Committers

Last synced: 11 months ago

All Time
  • Total Commits: 1,159
  • Total Committers: 19
  • Avg Commits per committer: 61.0
  • Development Distribution Score (DDS): 0.043
Past Year
  • Commits: 4
  • Committers: 3
  • Avg Commits per committer: 1.333
  • Development Distribution Score (DDS): 0.5
Top Committers
Name Email Commits
Richard Iannone r****e@m****m 1,109
Joe Cheng j****e@r****m 31
Neal Richardson n****n@g****m 2
Vincent C Fulco v****1@g****m 2
Adam T Austin a****n@g****m 1
Alison Presmanes Hill a****n@r****m 1
Alternikaner A****r 1
Andy Merlino a****o@t****m 1
Angela 5****i 1
Aron Atkins a****n@p****o 1
Emily Riederer e****r@g****m 1
François Michonneau f****u@g****m 1
Gus Lipkin g****n@g****m 1
Jacqueline Nolis j****s 1
Jon Calder j****r@g****m 1
Salim B s****m@p****e 1
Xianying Tan s****n@1****m 1
olivroy 5****y 1
pabecer p****r@g****m 1
Committer Domains (Top 20 + Academic)
rstudio.com: 2 126.com: 1 posteo.de: 1 posit.co: 1 tychobra.com: 1 me.com: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 87
  • Total pull requests: 33
  • Average time to close issues: 7 months
  • Average time to close pull requests: 8 months
  • Total issue authors: 80
  • Total pull request authors: 16
  • Average comments per issue: 1.93
  • Average comments per pull request: 0.64
  • Merged pull requests: 23
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 7
  • Pull requests: 2
  • Average time to close issues: 20 days
  • Average time to close pull requests: about 17 hours
  • Issue authors: 7
  • Pull request authors: 1
  • Average comments per issue: 0.14
  • Average comments per pull request: 0.0
  • Merged pull requests: 2
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • rich-iannone (6)
  • chuxinyuan (2)
  • algo-se (2)
  • BlueyCoder (1)
  • kmasiello (1)
  • leungi (1)
  • caldwellst (1)
  • j450h1 (1)
  • jorgesinval (1)
  • asadow (1)
  • TenshiChiyo (1)
  • Leprechault (1)
  • wfmackey (1)
  • ScaonE (1)
  • agronomofiorentini (1)
Pull Request Authors
  • rich-iannone (16)
  • nealrichardson (3)
  • shrektan (2)
  • aronatkins (2)
  • ASBecker (2)
  • pabecer (2)
  • cderv (2)
  • wkmor1 (1)
  • apreshill (1)
  • guslipkin (1)
  • jnolis (1)
  • dave-lanigan (1)
  • jeroen (1)
  • ataustin (1)
  • aalucaci (1)
Top Labels
Issue Labels
Type: ⁇ Question (9) Priority: [3] High (7) Difficulty: [2] Intermediate (7) Effort: [2] Medium (6) Type: ☹︎ Bug (4) Effort: [3] High (3) Type: ★ Enhancement (3) Type: ✎ Docs (2) Priority: ♨︎ Critical (2) Difficulty: [3] Advanced (1) Difficulty: [1] Novice (1) rendering-issues (1)
Pull Request Labels

Packages

  • Total packages: 2
  • Total downloads:
    • cran 7,190 last-month
  • Total docker downloads: 53,342
  • Total dependent packages: 3
    (may contain duplicates)
  • Total dependent repositories: 18
    (may contain duplicates)
  • Total versions: 19
  • Total maintainers: 1
proxy.golang.org: github.com/rstudio/blastula
  • Versions: 9
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 5.4%
Average: 5.6%
Dependent repos count: 5.8%
Last synced: 6 months ago
cran.r-project.org: blastula

Easily Send HTML Email Messages

  • Versions: 10
  • Dependent Packages: 3
  • Dependent Repositories: 18
  • Downloads: 7,190 Last month
  • Docker Downloads: 53,342
Rankings
Stargazers count: 0.7%
Forks count: 0.9%
Downloads: 6.1%
Dependent repos count: 6.7%
Average: 9.0%
Dependent packages count: 13.6%
Docker downloads count: 26.1%
Maintainers (1)
rich@posit.co
Last synced: 6 months ago

Dependencies

DESCRIPTION cran
  • R >= 3.2.1 depends
  • base64enc >= 0.1 imports
  • commonmark >= 1.7 imports
  • curl >= 4.3 imports
  • digest * imports
  • dplyr >= 0.8.3 imports
  • fs >= 1.3.1 imports
  • getPass >= 0.2 imports
  • here >= 0.1 imports
  • htmltools >= 0.4.0 imports
  • httr >= 1.4.0 imports
  • jsonlite >= 1.6 imports
  • magrittr >= 1.5 imports
  • mime >= 0.6 imports
  • rlang >= 0.4.1 imports
  • rmarkdown * imports
  • stringr >= 1.4.0 imports
  • uuid >= 0.1 imports
  • covr * suggests
  • ggplot2 * suggests
  • glue * suggests
  • keyring * suggests
  • knitr * suggests
  • spelling * suggests
  • testthat >= 3.0.0 suggests
  • xml2 * suggests
.github/workflows/R-CMD-check.yaml actions
  • actions/checkout v2 composite
  • r-lib/actions/check-r-package v2 composite
  • r-lib/actions/setup-pandoc v2 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
.github/workflows/pkgdown.yaml actions
  • actions/cache v2 composite
  • actions/checkout v2 composite
  • nwtgck/actions-netlify v1.1 composite
  • r-lib/actions/setup-pandoc v1 composite
  • r-lib/actions/setup-r v1 composite