README.Rmd

---
output: github_document
---

<!-- 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%"
)
```

# postmarkr <img src="man/figures/logo.png" align="right" height="138" />

<!-- badges: start -->
[![Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public.](https://www.repostatus.org/badges/latest/wip.svg)](https://www.repostatus.org/#wip)
[![R-CMD-check](https://github.com/andreranza/postmarkr/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/andreranza/postmarkr/actions/workflows/R-CMD-check.yaml)
<!-- badges: end -->

The goal of postmarkr is to interact with the [Postmark API](https://postmarkapp.com/developer), from R.

It is an independent, community-developed R package for the [Postmark](https://postmarkapp.com) email service (not created by or affiliated with Postmark).

## Installation

You can install the development version of postmarkr like so:

``` r
pak::pak("andreranza/postmarkr")
```

## Example

This is a basic example which shows you how to solve a common problem:

```{r example, eval=FALSE}
library(postmarkr)
dat <- template_send_email_batch(
  from = "xyz@mail.com",
  to = c( # potentially, a long vector of emails
    "abcd@mail.com",
    "efgh@mail.com"
  ),
  id = 36620093L,
  template_model = list(
    template_var_01 = "nutrivetpet",
    template_var_02 = "www.nutrivetpet.com"
  ),
  msg_stream = "broadcast",
  tag = "test",
  track_opens = TRUE
)
```

## Features

- Send batch emails with template
- Get email delivery logs
- List email templates
- Track email delivery statistics