sendgrid-rs - GitLite

KO | EN

gitlite — search

#javascript #hacktoberfest #react #llm #go #golang #machine-learning #nodejs #awesome #cli #awesome-list #vue #pytorch #security

sendgrid-rs

(★ 119)

Unofficial Rust library for the SendGrid API

File Explorer

Download Latest Version (.zip)

- - ci.yml
- main.rs
- v3.rs
- v3_async.rs
- v3_disable_tracking.rs
- - clients.rs
  - message.rs
  - mod.rs
- client.rs
- error.rs
- lib.rs
- mail.rs
.gitignore
Cargo.toml
CHANGELOG.md
LICENSE
README.md

# Installation Guide

1. Get the code

git clone https://github.com/gsquire/sendgrid-rs

Downloads the entire project code from GitHub to your computer.

cd sendgrid-rs

Moves into the project folder you just downloaded.

2. Rust

Medium Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Rust (rustup) Installing via rustup also installs cargo.

SENDGRID_API_KEY=SG.... cargo run --example v3_disable_tracking --features="blocking" from@examle.com to@example.com

Builds and then immediately runs the program.

✅ If cargo build finishes without errors, it worked. The executable is created under target/.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# sendgrid-rs
Unofficial Rust library for the SendGrid API.

Weigh in [here](https://github.com/gsquire/sendgrid-rs/discussions/121) if you find the crate's
`Sender` type confusing.

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"
```

## Build Dependencies
This library utilizes [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.

## Features
You can take advantage of a couple features for the crate. To enable the blocking send function, you
can use the `blocking` flag. To use your operating system's [TLS implementation](https://github.com/sfackler/rust-native-tls),
enable the `native-tls` feature.

## 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"
```

```shell
SENDGRID_API_KEY=SG.... cargo run --example v3_disable_tracking --features="blocking" from@examle.com to@example.com
```

## 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