postmark 1.0.0

Postmark rust client
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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111

# Postmark

[![ci](https://github.com/pastjean/postmark-rs/actions/workflows/ci.yml/badge.svg)](https://github.com/pastjean/postmark-rs/actions/workflows/ci.yml)
[![crates.io](https://img.shields.io/crates/v/postmark.svg)](https://crates.io/crates/postmark)
[![Documentation](https://docs.rs/postmark/badge.svg)](https://docs.rs/postmark)
[![License](https://img.shields.io/crates/l/postmark.svg)](#license)

A rust library to query Postmark API.

# Usage

Add the crate dependency to your Cargo.toml:

```toml
[dependencies]
postmark = "x.y.z"
```

And use it, see documentation at: https://docs.rs/postmark.

```rust
use postmark::api::email::SendEmailRequest;
use postmark::api::Body;
use postmark::reqwest::PostmarkClient;
use postmark::Query;

async fn send_email(){
  let client = PostmarkClient::builder()
   .server_token("<sometoken>")
   .build();

  let req = SendEmailRequest::builder()
    .from("me@example.com")
    .to("you@example.com")
    .body(Body::text("it's me, Mario!".to_string()))
    .build();
  let resp = req.execute(&client).await;
}
```

Messages example:

```rust
use postmark::api::messages::OutboundSearchRequest;
use postmark::reqwest::PostmarkClient;
use postmark::Query;

async fn list_messages() {
  let client = PostmarkClient::builder()
    .server_token("<sometoken>")
    .build();

  let request = OutboundSearchRequest::builder().build();
  let response = request.execute(&client).await;
}
```

# API coverage

Detailed endpoint matrix and examples:

- `docs/api/postmark-endpoints.md`
- `docs/api/examples/`
- `docs/api/compatibility.md`

Current high-level status:

| Section | Status |
|---|---|
| Email | implemented |
| Bulk | implemented |
| Bounce | implemented |
| Templates | implemented |
| Server | implemented |
| Servers | implemented |
| Message Streams | implemented |
| Domains | implemented |
| Sender Signatures | implemented (non-deprecated) |
| Stats | implemented |
| Triggers: Inbound rules | implemented |
| Webhooks | implemented |
| Suppressions | implemented |
| Data Removal | implemented |
| Messages | implemented |

# Releasing a new version

Prerequisite:

```sh
cargo install cargo-release
```

On Release:

```sh
cargo release --dry-run
# check it does the good thing
cargo release
```

# Thanks

This crate's API design is heavily inspired by the article ["Designing Rust bindings for REST APIs](https://plume.benboeckel.net/~/JustAnotherBlog/designing-rust-bindings-for-rest-ap-is) by Ben Boeckel.

# License

postmark-rs is dual-licensed under either:

- MIT License ([LICENSE-MIT](LICENSE-MIT))
- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE))