Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dancespiele/mailgun_api
API for Mailgun in Rust
https://github.com/dancespiele/mailgun_api
email mailgun mailgun-api rust rust-library
Last synced: 11 days ago
JSON representation
API for Mailgun in Rust
- Host: GitHub
- URL: https://github.com/dancespiele/mailgun_api
- Owner: dancespiele
- License: mit
- Created: 2020-08-23T21:31:56.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2020-11-30T20:06:22.000Z (almost 4 years ago)
- Last Synced: 2024-10-10T05:35:22.337Z (28 days ago)
- Topics: email, mailgun, mailgun-api, rust, rust-library
- Language: Rust
- Homepage: https://docs.rs/crate/mailgun_api
- Size: 34.2 KB
- Stars: 8
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Mailgun API
Send emails through mailgun in rust asynchronously
## How install it
1. Add the next dependencies in the Cargo.toml file of the project:
```toml
mailgun_api = "0.2"
reqwest = {version = "0.10", features = ["json"]}
serde = { version = "1.0", features = ["derive"]}
serde_derive = "1.0"
serde_json = "1.0"
tokio = { version = "0.2", features = ["macros"]}
```
## Example
```rust
use mailgun_api::MailgunApi;
use mailgun_api::api::EmailParams;
use dotenv::dotenv;
use std::env;
// Inside of you tokio implementation
dotenv().ok();
let mailgun_secret = env::var("MAILGUN_SECRET").expect("MAILGUN_SECRET must be set");
let mailgun_domain = env::var("MAILGUN_DOMAIN").expect("MAILGUN_DOMAIN must be set");
let mailgun_endpoint = env::var("MAILGUN_ENDPOINT").expect("MAILGUN_ENDPOINT must be set");
let sender = env::var("EMAIL_FROM").expect("MAIL_FROM must be set");
let receiver = env::var("EMAIL_RECEIVER_TEST").expect("EMAIL_RECEIVER_TEST must be set");
let params = EmailParams {
from: sender,
to: receiver,
subject: "test mailgung api".to_string(),
text: Some("hello this is a test".to_string()),
html: None,
};
let mut mailgun = MailgunApi::new(&mailgun_secret, &mailgun_endpoint, &mailgun_domain);
let response = mailgun.send_email::>(params).await;
assert_eq!(response.is_ok(), true)
```
## How test it
1. Create a .env file and add the next parameters:
```
MAILGUN_DOMAIN=[YOUR DOMAIN]
MAILGUN_SECRET=[YOUR MAILGUN API SECRET]
MAILGUN_ENDPOINT=[MAILGUN ENDPOINT] // There is two endpoint currently: api.mailgun.net and api.eu.mailgun.net
EMAIL_RECEIVER_TEST=[EMAIL RECEIVER TEST]
EMAIL_FROM=[SENDER TEST]
```
2. Execute the tests `cargo test`
**Warning:** when you are running the tests you are sending a email to the receiver that you set
## About Dtos
The dtos are structures used to transform the json retrieved from Mailung API in data accesible by the rust aplication.
It wasn't possible to see any Mailgun documentation which specify which parameters are nullable then maybe is possible
to get an error in the response because the Dto property is not typed as `Option` (please open an issue if that happens),
for this reason the methods accept Generics which you need to pass the Dtos provided or yours
## Do you like Mailgun API?
If you like Mailgun API, help us supporting the project:
- Sending coins to the address **0x619d3FA3bD7CF497d9899Ccd4d7b5663Ff318e52**
- BAT rewards in case that you use [Brave Browser](https://brave.com/)
- [Github Sponsors](https://github.com/sponsors/dancespiele)
- Burst coins to the address BURST-DPN6-2AT3-FCRL-9BBKG
## Roadmap
- [x] Send email
- [x] Retrieve Store Message
- [ ] Domains
- [ ] IPs
- [x] Events
- [ ] Stats
- [ ] Tags
- [ ] Suppressions
- [ ] Routes
- [ ] Webhooks
- [ ] Mailing List
- [ ] Templates
- [ ] Email validation
- [ ] Inbox Placement
## License
Mailgun API is [MIT](LICENSE) licensed