README.Rmd

---
output: rmarkdown::github_document
---
[![Build Status](https://travis-ci.org/hrbrmstr/msgxtractr.svg?branch=master)](https://travis-ci.org/hrbrmstr/msgxtractr)
[![AppVeyor Build Status](https://ci.appveyor.com/api/projects/status/github/hrbrmstr/msgxtractr?branch=master&svg=true)](https://ci.appveyor.com/project/hrbrmstr/msgxtractr)
[![codecov](https://codecov.io/gh/hrbrmstr/msgxtractr/branch/master/graph/badge.svg)](https://codecov.io/gh/hrbrmstr/msgxtractr)

`msgxtractr` : Read Outlook '.msg' Files

'Microsoft' 'Outlook' messages can be saved in '.msg' files. Tools are provided that enable extraction of metadata, envelope, headers, body and attachments from these files.

The following functions are implemented:

- `read_msg`:	Read in an Outlook '.msg' file
- `save_attachments`:	Save all attachments from a 'msg' object
- `tidy_msg`:	Turn a 'msg' object into a 'tibble'

### Installation

```{r eval=FALSE}
devtools::install_github("hrbrmstr/msgxtractr")
```

```{r message=FALSE, warning=FALSE, error=FALSE, include=FALSE}
options(width=120)
```

### Usage

```{r message=FALSE, warning=FALSE, error=FALSE}
library(msgxtractr)

# current version
packageVersion("msgxtractr")

str(msg1 <- read_msg(system.file("extdata/unicode.msg", package="msgxtractr")))

print(msg1)

str(msg2 <- read_msg(system.file("extdata/TestMessage-ansi.msg", package="msgxtractr")))

str(msg3 <- read_msg(system.file("extdata/TestMessage-default.msg", package="msgxtractr")))

str(msg4 <- read_msg(system.file("extdata/TestMessage-unicode.msg", package="msgxtractr")))

str(tidy_msg(msg1), 2)
str(tidy_msg(msg2), 2)
str(tidy_msg(msg3), 2)
str(tidy_msg(msg4), 2)
```

### Code of Conduct

Please note that this project is released with a [Contributor Code of Conduct](CONDUCT.md). By participating in this project you agree to abide by its terms.