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

#![deny(missing_docs)]

//! Unofficial Rust library for the SendGrid API.
//!
//! This crate requires Rust 1.15 or higher as it uses a crate that has a custom derive
//! implementation.
//!
//! sendgrid-rs implements all of the functionality of other supported SendGrid client libraries.
//! To use sendgrid-rs you must first create a SendGrid account and generate an API key. To create
//! an API key for your SendGrid account, use the account management interface or see the
//! [SendGrid API Documentation](https://sendgrid.com/docs/API_Reference/Web_API_v3/API_Keys/index.html).
//!
//! sendgrid-rs is available on [crates.io](https://crates.io/crates/sendgrid) and can be included
//! in your Cargo.toml as follows:
//!
//! ```toml
//! [dependencies]
//! sendgrid = "X.X.X"
//! ```
//!
//! # Features
//! The projects has the following feature flags:
//! * `rustls`: this feature flag switches the default SSL provider in the operating system (usually
//! OpenSSL) with RusTLS, which is a TLS implementation in Rust.
//! * `native-tls`: enabled by default, this feature flag enabled the default SSL provider in the
//! operating system (usually OpenSSL).
//! * `async`: this feature flag changes the `send` function on the `SGClient` into an asynchronous
//! version. Note that without this feature flag, constructing an `SGClient` inside an asynchronous
//! function is not possible.
//!
//! ## Build Dependencies
//! This library utilises [reqwest](https://crates.io/crates/reqwest). Follow the instructions on
//! the [reqwest README](https://github.com/seanmonstar/reqwest#requirements) in order to enable
//! sending HTTPS requests to the SendGrid API.
//!
//! ## Example
//! An example of using this library can be found in the examples directory. This example code
//! expects to find your SendGrid API key in the process environment. In shells such as Bash or ZSH
//! this can be set as follows:
//!
//! ```shell
//! export SENDGRID_API_KEY="SG.my.api.key"
//! ```
//!
//! ## Documentation
//! [Documentation](https://docs.rs/sendgrid)
//!
//! Please don't hesitate to contact me at the email listed in my profile. I will try to help as
//! quickly as I can. If you would like to contribute, contact me as well.
//!
//! ## Mentions
//! Thanks to [meehow](https://github.com/meehow) for their contributions.
//!
//! Thanks to [richo](https://github.com/richo) for their improvements to the V2 API.
//!
//! ## License
//! MIT

mod client;
/// Contains the error type used in this library.
pub mod error;
mod mail;
pub mod v3;

pub use client::SGClient;
pub use error::{SendgridError, SendgridResult};
pub use mail::{Destination, Mail};