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 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227
use reqwest::header::{self, HeaderMap, HeaderValue};
#[cfg(not(feature = "async"))]
use reqwest::blocking::Response;
#[cfg(feature = "async")]
use reqwest::Response;
use url::form_urlencoded::Serializer;
use crate::{
error::{RequestNotSuccessful, SendgridResult},
mail::Mail,
};
static API_URL: &str = "https://api.sendgrid.com/api/mail.send.json?";
/// This is the struct that allows you to authenticate to the SendGrid API.
/// It contains the API key which allows you to send messages as well as a blocking request client.
#[derive(Clone, Debug)]
pub struct SGClient {
api_key: String,
host: String,
#[cfg(feature = "async")]
client: reqwest::Client,
#[cfg(not(feature = "async"))]
client: reqwest::blocking::Client,
}
// Given a form value and a key, generate the correct key.
fn make_form_key(form: &str, key: &str) -> String {
let mut value = String::with_capacity(form.len() + key.len() + 2);
value.push_str(form);
value.push('[');
value.push_str(key);
value.push(']');
value
}
// Use the URL form encoder to properly generate the body used in the mail send request.
fn make_post_body(mut mail_info: Mail) -> SendgridResult<String> {
let body = String::new();
let mut encoder = Serializer::new(body);
for to in mail_info.to.iter() {
encoder.append_pair("to[]", to.address);
encoder.append_pair("toname[]", to.name);
}
for cc in mail_info.cc.iter() {
encoder.append_pair("cc[]", cc);
}
for bcc in mail_info.bcc.iter() {
encoder.append_pair("bcc[]", bcc);
}
for (attachment, contents) in &mail_info.attachments {
encoder.append_pair(&make_form_key("files", attachment), contents);
}
for (id, value) in &mail_info.content {
encoder.append_pair(&make_form_key("content", id), value);
}
encoder.append_pair("from", mail_info.from);
encoder.append_pair("subject", mail_info.subject);
encoder.append_pair("html", mail_info.html);
encoder.append_pair("text", mail_info.text);
encoder.append_pair("fromname", mail_info.from_name);
encoder.append_pair("replyto", mail_info.reply_to);
encoder.append_pair("date", mail_info.date);
encoder.append_pair("headers", &mail_info.make_header_string()?);
encoder.append_pair("x-smtpapi", mail_info.x_smtpapi);
Ok(encoder.finish())
}
impl SGClient {
/// Makes a new SendGrid cient with the specified API key. This will panic if you are using the
/// default TLS backend and do not have a default TLS backend available. If you are using the
/// RustTLS backend, this can never panic because RustTLS is statically linked.
pub fn new<S: Into<String>>(key: S) -> SGClient {
#[cfg(feature = "async")]
use reqwest as rq;
#[cfg(not(feature = "async"))]
use reqwest::blocking as rq;
let builder = rq::ClientBuilder::new();
#[cfg(feature = "rustls")]
let builder = builder.use_rustls_tls();
let client = builder.build().unwrap();
SGClient {
api_key: key.into(),
client,
host: API_URL.to_string(),
}
}
/// Sets the host to use for the API. This is useful if you are using a proxy or a local
/// development server. It should be a full URL, including the protocol.
pub fn set_host<S: Into<String>>(&mut self, host: S) {
self.host = host.into();
}
/// Sends a messages through the SendGrid API. It takes a Mail struct as an argument. It returns
/// the string response from the API as JSON.
///
/// ### Example
///
/// ```rust,ignore
/// use sendgrid::SendgridError;
///
/// fn main() -> Result<(), SendgridError> {
/// let my_secret_key = std::env::var("SENDGRID_KEY").expect("need SENDGRID_KEY to test");
/// use sendgrid::{Mail, SGClient};
///
/// let mail = Mail::new()
/// .add_from("my-email@address.com")
/// .add_text("hi!")
/// .add_subject("Hello")
/// .add_to(("your-email@address.com", "Your Name").into());
/// let response = SGClient::new(my_secret_key)
/// .send(mail)?;
/// Ok(())
/// }
/// ```
#[cfg(not(feature = "async"))]
pub fn send(&self, mail_info: Mail) -> SendgridResult<Response> {
let post_body = make_post_body(mail_info)?;
let resp = self
.client
.post(&self.host)
.headers(self.headers()?)
.body(post_body)
.send()?;
if resp.error_for_status_ref().is_err() {
return Err(RequestNotSuccessful::new(resp.status(), resp.text()?).into());
}
Ok(resp)
}
/// Sends a messages through the SendGrid API. It takes a Mail struct as an argument. It returns
/// the string response from the API as JSON.
///
/// ### Example
///
/// ```rust,ignore
/// use sendgrid::SendgridError;
///
/// #[tokio::main]
/// async fn main() -> Result<(), SendgridError> {
/// let my_secret_key = std::env::var("SENDGRID_KEY").expect("need SENDGRID_KEY to test");
/// use sendgrid::{Mail, SGClient};
///
/// let mail = Mail::new()
/// .add_from("my-email@address.com")
/// .add_text("hi!")
/// .add_subject("Hello")
/// .add_to(("your-email@address.com", "Your Name").into());
/// let response = SGClient::new(my_secret_key)
/// .send(mail)
/// .await?;
/// Ok(())
/// }
/// ```
#[cfg(feature = "async")]
pub async fn send(&self, mail_info: Mail<'_>) -> SendgridResult<Response> {
let post_body = make_post_body(mail_info)?;
let resp = self
.client
.post(&self.host)
.headers(self.headers()?)
.body(post_body)
.send()
.await?;
if resp.error_for_status_ref().is_err() {
return Err(RequestNotSuccessful::new(resp.status(), resp.text().await?).into());
}
Ok(resp)
}
fn headers(&self) -> SendgridResult<HeaderMap> {
let mut headers = HeaderMap::new();
headers.insert(
header::AUTHORIZATION,
HeaderValue::from_str(&format!("Bearer {}", self.api_key.clone()))?,
);
headers.insert(
header::CONTENT_TYPE,
HeaderValue::from_static("application/x-www-form-urlencoded"),
);
headers.insert(header::USER_AGENT, HeaderValue::from_static("sendgrid-rs"));
Ok(headers)
}
}
#[test]
fn basic_message_body() {
use crate::mail::Destination;
let m = Mail::new()
.add_to(Destination {
address: "test@example.com",
name: "Testy mcTestFace",
})
.add_from("me@example.com")
.add_subject("Test")
.add_text("It works");
let body = make_post_body(m);
let want = "to%5B%5D=test%40example.com&toname%5B%5D=Testy+mcTestFace&from=me%40example.com&subject=Test&\
html=&text=It+works&fromname=&replyto=&date=&headers=%7B%7D&x-smtpapi=";
assert_eq!(body.unwrap(), want);
}
#[test]
fn test_proper_key() {
let want = "files[test.jpg]";
let got = make_form_key("files", "test.jpg");
assert_eq!(want, got);
}