summaryrefslogtreecommitdiffstats
path: root/README.md
blob: f757ae6c8930143466d79157e8eb4c6fbe7a22d4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
mda-rs
======

mda-rs is a Rust library for writing custom Mail Deliver Agents.

![](https://github.com/afrantzis/mda-rs/workflows/build/badge.svg)

### Documentation

The detailed module documentation, including code examples for all features,
can be found at [https://docs.rs/mda](https://docs.rs/mda).

### Usage

Add this to your `Cargo.toml`:

```toml
[dependencies]
mda = "0.1"
```

If you are using Rust 2015 add the following to your crate root file (Rust 2018
doesn't require this):

```rust
extern crate mda;
```

See [examples/personal-mda.rs](examples/personal-mda.rs) for an example that
uses mda-rs.

### License

This project is licensed under the Mozilla Public License Version 2.0
([LICENSE](LICENSE) or https://www.mozilla.org/en-US/MPL/2.0/).