ntfy 0.2.0

ntfy rust sdk
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

# Ntfy SDK

## Description

[Ntfy](https://ntfy.sh) client library to send notifications from [Rust](https://rust-lang.org).

## Example

```toml
ntfy = "0.2"
tokio = { version = "1", features = ["full"] }
```

```rust,no_run
use ntfy::{Dispatcher, Payload, Priority, Auth};

#[tokio::main]
async fn main() {
    let auth = Auth::new("username", "password");
    let dispatcher = Dispatcher::new(
        "https://ntfy.sh",
        Some(auth),
        Some("socks5h://127.0.0.1:9050"),
    )
    .unwrap();

    let payload = Payload::new("mytopic", "Hello, World!")
        .title("Alert") // Add optional title
        .priority(Priority::High); // Edit priority

    dispatcher.send(&payload).await.unwrap();
}
```

More examples can be found in the [examples](./examples/) directory.

## Crate Feature Flags

The following crate feature flags are available:

| Feature             | Default | Description                                                                                                                |
| ------------------- | :-----: | -------------------------------------------------------------------------------------------------------------------------- |
| `blocking`          |   No    | Needed if you want to use this library in not async/await context                                                          |
```

## License

This project is distributed under the MIT software license - see the [LICENSE](LICENSE) file for details