README.Rmd

---
output: github_document
format: gfm
default-image-extension: ""
---

<!-- README.md is generated from README.Rmd. Please edit that file -->

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



# mailmerge <img src='man/figures/logo.png' align="right" height="139" />

<!-- badges: start -->
[![CRAN status](https://www.r-pkg.org/badges/version/mailmerge)](https://CRAN.R-project.org/package=mailmerge)
[![CRAN RStudio mirror downloads](https://cranlogs.r-pkg.org/badges/mailmerge)](https://www.r-pkg.org/package=miniCRAN)
[![R-CMD-check](https://github.com/andrie/mailmerge/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/andrie/mailmerge/actions/workflows/R-CMD-check.yaml)
[![Codecov test coverage](https://codecov.io/gh/andrie/mailmerge/branch/main/graph/badge.svg)](https://app.codecov.io/gh/andrie/mailmerge?branch=main)
[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
<!-- badges: end -->


```{r child="man/fragments/intro_text.Rmd"}
```


## Installation

Install the package from CRAN:

```r
install.packages("mailmerge")
```

Install the dev version from https://github.com/andrie/mailmerge

```r
remotes::install_github("andrie/mailmerge")
```

## Setup

At the moment only gmail is supported as the email back-end, using the `gmailr` package (https://github.com/r-lib/gmailr).

Before you use `mail_merge()` it's important to authenticate against the gmail service, and you should use `gmailr::gm_auth()` to do this.

## Example

```{r child="man/fragments/intro_example.Rmd"}
```


<center>
```{r, echo=FALSE, out.width="80%"}
knitr::include_graphics("man/figures/mail-merge.gif")
```
</center>