Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ropensci-archive/ponyexpress

:no_entry: ARCHIVED :no_entry: Automate sending email with 'Gmail'
https://github.com/ropensci-archive/ponyexpress

r r-package rstats unconf unconf17

Last synced: 3 months ago
JSON representation

:no_entry: ARCHIVED :no_entry: Automate sending email with 'Gmail'

Host: GitHub
URL: https://github.com/ropensci-archive/ponyexpress
Owner: ropensci-archive
License: other
Archived: true
Created: 2017-05-25T19:16:50.000Z (over 7 years ago)
Default Branch: master
Last Pushed: 2022-05-10T14:00:12.000Z (over 2 years ago)
Last Synced: 2024-05-21T02:54:30.685Z (6 months ago)
Topics: r, r-package, rstats, unconf, unconf17
Language: R
Homepage:
Size: 2.39 MB
Stars: 36
Watchers: 5
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README-NOT.md
- License: LICENSE

Awesome Lists containing this project

README

        [![Project Status: Abandoned – Initial development has started, but there has not yet been a stable, usable release; the project has been abandoned and the author(s) do not intend on continuing development.](https://www.repostatus.org/badges/latest/abandoned.svg)](https://www.repostatus.org/#abandoned)

[![Coverage Status](https://img.shields.io/codecov/c/github/ropenscilabs/ponyexpress/master.svg)](https://codecov.io/github/ropenscilabs/ponyexpress?branch=master)

ponyexpress 🐴

=============

This package builds on the `gmailr` package and code from Jenny Bryan to automate sending Gmail from R with data from a spreadsheet (local csv, Excel sheet, or a Google sheet). With nothing more than a list of names and email addresses, you can send templated emails (grades, conference acceptances etc)

Install

-------

``` r

# Obtain the the development version from GitHub:

# install.packages("devtools")

devtools::install_github("ropenscilabs/ponyexpress")

```

Functionality

-------------

-   `parcel_create(df, sender_name, sender_email, subject, template)` - Creates a template of the messages that need to be sent.

-   `parcel_preview()` - will preview the emails

-   `parcel_send()` - Send the emails

![](http://rs181.pbsrc.com/albums/x148/brandi47_2007/4942733.gif~c200)

Example

-------

**1. Read in data frame**

``` r

 df <- data.frame(

    name = c("Lucy", "Karthik"),

    email = c("[email protected]", "[email protected]")

  )

  df

```

    ##      name                     email

    ## 1    Lucy [email protected]

    ## 2 Karthik         [email protected]

**2. Template up**

``` r

library(ponyexpress)

template <- "Dear {name},

   This is a friendly email from me.

  XO,

   Lucy"

 # Or write a rich template!

rich_template <- "Dear {name},

   This is a friendly email from me.

  \\

   XO,

   Lucy"

 

 # Or use one of our templates!

 # Save your text as an object named "body"

 # then use glue!

body <- "Dear {name},

   This is a friendly email from me.

  \\

   XO,

   Lucy"

our_template <- glue::glue(glitter_template)

```

**3. Parcel & Preview**

``` r

  parcel <- parcel_create(df,

              sender_name = "Lucy",

              sender_email = "[email protected]",

              subject = "Happy email!",

              template = rich_template)

 parcel_preview(parcel)            

```

**4. Send**

``` r

parcel_send(parcel)

```

![](https://i.imgur.com/Ij60FhR.gif)

![](ponies.png)