recipes/aws-workmail/README.md


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

# franz-aws-workmail-plugin

[![GitHub release](https://img.shields.io/github/release/yoavmmn/franz-aws-workmail-plugin.svg)](https://github.com/yoavmmn/franz-aws-workmail-plugin/releases/latest)
[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/yoavmmn/franz-aws-workmail-plugin/master/LICENSE)

The minimum required version of Franz to run custom integrations is 4.0.0. You can download the latest version of Franz [here](http://meetfranz.com/#download_all).

## Installation
1. To install this plugin, use one of the following methods to clone the repository:
    * Download the zip file from the [latest release](https://github.com/yoavmmn/franz-aws-workmail-plugin/releases/latest)
    * git: `git clone https://github.com/yoavmmn/franz-aws-workmail-plugin.git`
    * wget: `wget https://github.com/yoavmmn/franz-aws-workmail-plugin/archive/master.zip`
2. Open the Franz Plugins folder on your machine:
    * Linux: `~/.config/Franz/Plugins`
    * Mac: `~/Library/Application\ Support/Franz/Plugins/`
    * Windows: `%appdata%/Franz/Plugins`
    * _Alternatively: Go to your Franz settings page, scroll down to the bottom and you will see an option to "Open the Franz plugin directory"_
3. Copy the `franz-aws-workmail-plugin` folder into the plugins directory
4. Restart Franz

Thats it. Enjoy.