postal_api 0.2.0

A Rust implementation for the Postal mail delivery platform.
Documentation 
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
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63

# postal_api
postal_api is an API Wrapper for the [Postal](https://postalserver.io/) Mail delivery service.
It takes inspiration from [postal-node](https://github.com/postalserver/postal-node), trying
to add additional validation into the MessageBuilder where possible.

## Roadmap
- [ ] Messages
    - [ ] Builder for Raw Messages
    - [x] Builder for Messages
    - [ ] Attachments
- [ ] Send Messages
    - [x] Send Message
    - [ ] Send Raw Message
- [ ] Postal API Errors
    - [x] Auth Errors
    - [x] Message Errors
    - [ ] Raw Message Errors

## Installation
just simply run:
```bash
cargo add postal_api
```

or add the following to your Cargo.toml:

```toml
postal_api = "0.2.0"
```

## Usage
Usage is quite simple:
```rust
use postal_api::PostalClient;
use postal_api::message::MessageBuilder;

// create a postal client
let client = PostalClient::new(
    "http://example.com".to_string(),
    "my_super_secret_api_key".to_string()
);

 // set only things we require to send a message at all
let message = MessageBuilder::new()
    .add_to("someone@example.com")
    .unwrap()
    .set_from("me@example2.com")
    .set_plain_body("HELLO WORLD!")
    .build()
    .unwrap();

client.send_message(message);
```

## License

This project is licensed under the MIT license.

### Contribution

Unless you explicitly state otherwise, any contribution intentionally 
submitted for inclusion in postal_api by you, 
shall be licensed as MIT, without any additional terms or conditions.