Data

Tools

Indexes

Applications

Experiments

Open Source Science

sendgridr

Mail Sender Using SendGrid mail API

https://github.com/mrchypark/sendgridr

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.5%) to scientific vocabulary

Keywords

hacktoberfest hacktoberfest2021 mail mailer package r sendgrid

Keywords from Contributors

degoogle
Last synced: 6 months ago · JSON representation

Repository

Mail Sender Using SendGrid mail API

Basic Info
Statistics
  • Stars: 24
  • Watchers: 2
  • Forks: 7
  • Open Issues: 6
  • Releases: 4
Topics
hacktoberfest hacktoberfest2021 mail mailer package r sendgrid
Created over 7 years ago · Last pushed 9 months ago
Metadata Files
Readme Changelog Contributing Funding License Code of conduct Support

README.Rmd 

---
output: github_document
---



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

# sendgridr 


[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
[![R-CMD-check](https://github.com/mrchypark/sendgridr/workflows/R-CMD-check/badge.svg)](https://github.com/mrchypark/sendgridr/actions)
[![send-test](https://github.com/mrchypark/sendgridr/actions/workflows/send-test.yaml/badge.svg)](https://github.com/mrchypark/sendgridr/actions/workflows/send-test.yaml)
[![CRAN status](https://www.r-pkg.org/badges/version/sendgridr)](https://CRAN.R-project.org/package=sendgridr)
[![runiverse-name](https://mrchypark.r-universe.dev/badges/:name)](https://mrchypark.r-universe.dev/)
[![runiverse-package](https://mrchypark.r-universe.dev/badges/sendgridr)](https://mrchypark.r-universe.dev/packages)
[![metacran downloads](https://cranlogs.r-pkg.org/badges/sendgridr)](https://cran.r-project.org/package=sendgridr)
[![Downloads](https://cranlogs.r-pkg.org/badges/grand-total/sendgridr)](https://CRAN.R-project.org/package=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()
```

### Using with Shiny Apps

For non-interactive environments like Shiny, you can provide the SendGrid API key via the `SENDGRID_API_KEY` environment variable. For example:

```
Sys.setenv(SENDGRID_API_KEY = "YOUR_API_KEY")
library(sendgridr)
```

## Send mail

### Example code

Please replace your conditions.

```
mail() |>
  from("example1@mail.com", "example name for display") |>
  to("example2@mail.com", "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.

```{r}
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.

```{r}
library(sendgridr)
mail() |>
  from("example1@mail.com", "toexam@mail.com") |>
  to("toexam1@mail.com", "1 exam") |>
  to("toexam2@mail.com", "2 exam") |>
  to("toexam3@mail.com", "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](https://mrchypark.github.io/sendgridr/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms.

Owner

  • Name: ChanYub Park
  • Login: mrchypark
  • Kind: user
  • Location: Seoul, South Korea

Tool maker with R, Go & Docker/k8s enthusiast

GitHub Events

Total
  • Watch event: 1
  • Issue comment event: 1
  • Push event: 1
  • Pull request event: 1
  • Create event: 1
Last Year
  • Watch event: 1
  • Issue comment event: 1
  • Push event: 1
  • Pull request event: 1
  • Create event: 1

Committers

Last synced: 8 months ago

All Time
  • Total Commits: 253
  • Total Committers: 8
  • Avg Commits per committer: 31.625
  • Development Distribution Score (DDS): 0.134
Past Year
  • Commits: 1
  • Committers: 1
  • Avg Commits per committer: 1.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
chanyub Park m****k@g****m 219
allcontributors[bot] 4****] 22
Amanda Dobbyn a****n@g****m 5
vincent guyader v****t@g****o 3
olivroy 5****y 1
google-labs-jules[bot] 1****] 1
ALanguillaume a****e@g****m 1
Emanuele Guidotti e****i@u****h 1
Committer Domains (Top 20 + Academic)
unine.ch: 1 guyader.pro: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 32
  • Total pull requests: 30
  • Average time to close issues: 3 months
  • Average time to close pull requests: 11 days
  • Total issue authors: 12
  • Total pull request authors: 7
  • Average comments per issue: 3.16
  • Average comments per pull request: 0.83
  • Merged pull requests: 28
  • Bot issues: 0
  • Bot pull requests: 13
Past Year
  • Issues: 0
  • Pull requests: 1
  • Average time to close issues: N/A
  • Average time to close pull requests: 1 minute
  • Issue authors: 0
  • Pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • mrchypark (18)
  • peter-bastian (3)
  • CurtisPetersen (2)
  • jinseob2kim (1)
  • vituri (1)
  • mscbuck (1)
  • eguidotti (1)
  • cardiomoon (1)
  • botan (1)
  • ALanguillaume (1)
  • agronomofiorentini (1)
  • carlganz (1)
Pull Request Authors
  • mrchypark (13)
  • allcontributors[bot] (13)
  • ALanguillaume (2)
  • VincentGuyader (2)
  • olivroy (2)
  • aedobbyn (1)
  • eguidotti (1)
Top Labels
Issue Labels
enhancement (1)
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • cran 351 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 6
  • Total maintainers: 1
cran.r-project.org: sendgridr

Mail Sender Using 'Sendgrid' Service

  • Versions: 6
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 351 Last month
Rankings
Stargazers count: 11.6%
Forks count: 12.8%
Average: 26.9%
Dependent packages count: 29.8%
Dependent repos count: 35.5%
Downloads: 44.9%
Maintainers (1)
mrchypark@gmail.com
Last synced: 6 months ago

Dependencies

DESCRIPTION cran
  • R >= 3.4 depends
  • base64enc * imports
  • cli * imports
  • emayili >= 0.7 imports
  • httr * imports
  • jsonlite * imports
  • keyring * imports
  • magrittr * imports
  • usethis * imports
  • covr * suggests
  • testthat * suggests
.github/workflows/check-standard.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/checkout 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/send-test.yaml actions
  • actions/checkout v2 composite
  • r-lib/actions/setup-pandoc v2 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite