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 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607
/*
* Copyright Stalwart Labs Ltd. See the COPYING
* file at the top-level directory of this distribution.
*
* Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
* https://www.apache.org/licenses/LICENSE-2.0> or the MIT license
* <LICENSE-MIT or https://opensource.org/licenses/MIT>, at your
* option. This file may not be copied, modified, or distributed
* except according to those terms.
*/
//! # mail-builder
//!
//! [![crates.io](https://img.shields.io/crates/v/mail-builder)](https://crates.io/crates/mail-builder)
//! [![build](https://github.com/stalwartlabs/mail-builder/actions/workflows/rust.yml/badge.svg)](https://github.com/stalwartlabs/mail-builder/actions/workflows/rust.yml)
//! [![docs.rs](https://img.shields.io/docsrs/mail-builder)](https://docs.rs/mail-builder)
//! [![crates.io](https://img.shields.io/crates/l/mail-builder)](http://www.apache.org/licenses/LICENSE-2.0)
//!
//! _mail-builder_ is a flexible **e-mail builder library** written in Rust. It includes the following features:
//!
//! - Generates **e-mail** messages conforming to the Internet Message Format standard (_RFC 5322_).
//! - Full **MIME** support (_RFC 2045 - 2049_) with automatic selection of the most optimal encoding for each message body part.
//! - **Fast Base64 encoding** based on Chromium's decoder ([the fastest non-SIMD encoder](https://github.com/lemire/fastbase64)).
//! - Minimal dependencies.
//!
//! Please note that this library does not support sending or parsing e-mail messages as these functionalities are provided by the crates [`mail-send`](https://crates.io/crates/mail-send) and [`mail-parser`](https://crates.io/crates/mail-parser).
//!
//! ## Usage Example
//!
//! Build a simple e-mail message with a text body and one attachment:
//!
//! ```rust
//! use mail_builder::MessageBuilder;
//!
//! // Build a simple text message with a single attachment
//! let eml = MessageBuilder::new()
//! .from(("John Doe", "john@doe.com"))
//! .to("jane@doe.com")
//! .subject("Hello, world!")
//! .text_body("Message contents go here.")
//! .attachment("image/png", "image.png", [1, 2, 3, 4].as_ref())
//! .write_to_string()
//! .unwrap();
//!
//! // Print raw message
//! println!("{}", eml);
//! ```
//!
//! More complex messages with grouped addresses, inline parts and
//! multipart/alternative sections can also be easily built:
//!
//! ```rust
//! use mail_builder::{headers::url::URL, MessageBuilder};
//! use std::fs::File;
//!
//! // Build a multipart message with text and HTML bodies,
//! // inline parts and attachments.
//! MessageBuilder::new()
//! .from(("John Doe", "john@doe.com"))
//!
//! // To recipients
//! .to(vec![
//! ("Antoine de Saint-Exupéry", "antoine@exupery.com"),
//! ("안녕하세요 세계", "test@test.com"),
//! ("Xin chào", "addr@addr.com"),
//! ])
//!
//! // BCC recipients using grouped addresses
//! .bcc(vec![
//! (
//! "My Group",
//! vec![
//! ("ASCII name", "addr1@addr7.com"),
//! ("ハロー・ワールド", "addr2@addr6.com"),
//! ("áéíóú", "addr3@addr5.com"),
//! ("Γειά σου Κόσμε", "addr4@addr4.com"),
//! ],
//! ),
//! (
//! "Another Group",
//! vec![
//! ("שלום עולם", "addr5@addr3.com"),
//! ("ñandú come ñoquis", "addr6@addr2.com"),
//! ("Recipient", "addr7@addr1.com"),
//! ],
//! ),
//! ])
//!
//! // Set RFC and custom headers
//! .subject("Testing multipart messages")
//! .in_reply_to(vec!["message-id-1", "message-id-2"])
//! .header("List-Archive", URL::new("http://example.com/archive"))
//!
//! // Set HTML and plain text bodies
//! .text_body("This is the text body!\n")
//! .html_body("<p>HTML body with <img src=\"cid:my-image\"/>!</p>")
//!
//! // Include an embedded image as an inline part
//! .inline("image/png", "cid:my-image", [0, 1, 2, 3, 4, 5].as_ref())
//! .attachment("text/plain", "my fíle.txt", "Attachment contents go here.")
//!
//! // Add text and binary attachments
//! .attachment(
//! "text/plain",
//! "ハロー・ワールド",
//! b"Binary contents go here.".as_ref(),
//! )
//!
//! // Write the message to a file
//! .write_to(File::create("message.eml").unwrap())
//! .unwrap();
//! ```
//!
//! Nested MIME body structures can be created using the `body` method:
//!
//! ```rust
//! use mail_builder::{headers::address::Address, mime::MimePart, MessageBuilder};
//! use std::fs::File;
//!
//! // Build a nested multipart message
//! MessageBuilder::new()
//! .from(Address::new_address("John Doe".into(), "john@doe.com"))
//! .to(Address::new_address("Jane Doe".into(), "jane@doe.com"))
//! .subject("Nested multipart message")
//!
//! // Define the nested MIME body structure
//! .body(MimePart::new(
//! "multipart/mixed",
//! vec![
//! MimePart::new("text/plain", "Part A contents go here...").inline(),
//! MimePart::new(
//! "multipart/mixed",
//! vec![
//! MimePart::new(
//! "multipart/alternative",
//! vec![
//! MimePart::new(
//! "multipart/mixed",
//! vec![
//! MimePart::new("text/plain", "Part B contents go here...").inline(),
//! MimePart::new(
//! "image/jpeg",
//! "Part C contents go here...".as_bytes(),
//! )
//! .inline(),
//! MimePart::new("text/plain", "Part D contents go here...").inline(),
//! ],
//! ),
//! MimePart::new(
//! "multipart/related",
//! vec![
//! MimePart::new("text/html", "Part E contents go here...").inline(),
//! MimePart::new(
//! "image/jpeg",
//! "Part F contents go here...".as_bytes(),
//! ),
//! ],
//! ),
//! ],
//! ),
//! MimePart::new("image/jpeg", "Part G contents go here...".as_bytes())
//! .attachment("image_G.jpg"),
//! MimePart::new(
//! "application/x-excel",
//! "Part H contents go here...".as_bytes(),
//! ),
//! MimePart::new(
//! "x-message/rfc822",
//! "Part J contents go here...".as_bytes(),
//! ),
//! ],
//! ),
//! MimePart::new("text/plain", "Part K contents go here...").inline(),
//! ],
//! ))
//!
//! // Write the message to a file
//! .write_to(File::create("nested-message.eml").unwrap())
//! .unwrap();
//! ```
//!
//! ## Testing
//!
//! To run the testsuite:
//!
//! ```bash
//! $ cargo test --all-features
//! ```
//!
//! or, to run the testsuite with MIRI:
//!
//! ```bash
//! $ cargo +nightly miri test --all-features
//! ```
//!
//! ## License
//!
//! Licensed under either of
//!
//! * Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
//! * MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
//!
//! at your option.
//!
//! ## Copyright
//!
//! Copyright (C) 2020-2022, Stalwart Labs Ltd.
//!
//! See [COPYING] for the license.
//!
//! [COPYING]: https://github.com/stalwartlabs/mail-builder/blob/main/COPYING
//!
pub mod encoders;
pub mod headers;
pub mod mime;
use std::{
borrow::Cow,
io::{self, Write},
};
use headers::{
address::Address,
content_type::ContentType,
date::Date,
message_id::{generate_message_id_header, MessageId},
text::Text,
Header, HeaderType,
};
use mime::{BodyPart, MimePart};
/// Builds an RFC5322 compliant MIME email message.
#[derive(Clone, Debug)]
pub struct MessageBuilder<'x> {
pub headers: Vec<(Cow<'x, str>, HeaderType<'x>)>,
pub html_body: Option<MimePart<'x>>,
pub text_body: Option<MimePart<'x>>,
pub attachments: Option<Vec<MimePart<'x>>>,
pub body: Option<MimePart<'x>>,
}
impl<'x> Default for MessageBuilder<'x> {
fn default() -> Self {
Self::new()
}
}
impl<'x> MessageBuilder<'x> {
/// Create a new MessageBuilder.
pub fn new() -> Self {
MessageBuilder {
headers: Vec::new(),
html_body: None,
text_body: None,
attachments: None,
body: None,
}
}
/// Set the Message-ID header. If no Message-ID header is set, one will be
/// generated automatically.
pub fn message_id(self, value: impl Into<MessageId<'x>>) -> Self {
self.header("Message-ID", value.into())
}
/// Set the In-Reply-To header.
pub fn in_reply_to(self, value: impl Into<MessageId<'x>>) -> Self {
self.header("In-Reply-To", value.into())
}
/// Set the References header.
pub fn references(self, value: impl Into<MessageId<'x>>) -> Self {
self.header("References", value.into())
}
/// Set the Sender header.
pub fn sender(self, value: impl Into<Address<'x>>) -> Self {
self.header("Sender", value.into())
}
/// Set the From header.
pub fn from(self, value: impl Into<Address<'x>>) -> Self {
self.header("From", value.into())
}
/// Set the To header.
pub fn to(self, value: impl Into<Address<'x>>) -> Self {
self.header("To", value.into())
}
/// Set the Cc header.
pub fn cc(self, value: impl Into<Address<'x>>) -> Self {
self.header("Cc", value.into())
}
/// Set the Bcc header.
pub fn bcc(self, value: impl Into<Address<'x>>) -> Self {
self.header("Bcc", value.into())
}
/// Set the Reply-To header.
pub fn reply_to(self, value: impl Into<Address<'x>>) -> Self {
self.header("Reply-To", value.into())
}
/// Set the Subject header.
pub fn subject(self, value: impl Into<Text<'x>>) -> Self {
self.header("Subject", value.into())
}
/// Set the Date header. If no Date header is set, one will be generated
/// automatically.
pub fn date(self, value: impl Into<Date>) -> Self {
self.header("Date", value.into())
}
/// Add a custom header.
pub fn header(
mut self,
header: impl Into<Cow<'x, str>>,
value: impl Into<HeaderType<'x>>,
) -> Self {
self.headers.push((header.into(), value.into()));
self
}
/// Set custom headers.
pub fn headers<T, U, V>(mut self, header: T, values: U) -> Self
where
T: Into<Cow<'x, str>>,
U: IntoIterator<Item = V>,
V: Into<HeaderType<'x>>,
{
let header = header.into();
for value in values {
self.headers.push((header.clone(), value.into()));
}
self
}
/// Set the plain text body of the message. Note that only one plain text body
/// per message can be set using this function.
/// To build more complex MIME body structures, use the `body` method instead.
pub fn text_body(mut self, value: impl Into<Cow<'x, str>>) -> Self {
self.text_body = Some(MimePart::new("text/plain", BodyPart::Text(value.into())));
self
}
/// Set the HTML body of the message. Note that only one HTML body
/// per message can be set using this function.
/// To build more complex MIME body structures, use the `body` method instead.
pub fn html_body(mut self, value: impl Into<Cow<'x, str>>) -> Self {
self.html_body = Some(MimePart::new("text/html", BodyPart::Text(value.into())));
self
}
/// Add a binary attachment to the message.
pub fn attachment(
mut self,
content_type: impl Into<ContentType<'x>>,
filename: impl Into<Cow<'x, str>>,
value: impl Into<BodyPart<'x>>,
) -> Self {
self.attachments
.get_or_insert_with(Vec::new)
.push(MimePart::new(content_type, value).attachment(filename));
self
}
/// Add an inline binary to the message.
pub fn inline(
mut self,
content_type: impl Into<ContentType<'x>>,
cid: impl Into<Cow<'x, str>>,
value: impl Into<BodyPart<'x>>,
) -> Self {
self.attachments
.get_or_insert_with(Vec::new)
.push(MimePart::new(content_type, value).inline().cid(cid));
self
}
/// Set a custom MIME body structure.
pub fn body(mut self, value: MimePart<'x>) -> Self {
self.body = Some(value);
self
}
/// Build the message.
pub fn write_to(self, mut output: impl Write) -> io::Result<()> {
let mut has_date = false;
let mut has_message_id = false;
for (header_name, header_value) in &self.headers {
if !has_date && header_name == "Date" {
has_date = true;
} else if !has_message_id && header_name == "Message-ID" {
has_message_id = true;
}
output.write_all(header_name.as_bytes())?;
output.write_all(b": ")?;
header_value.write_header(&mut output, header_name.len() + 2)?;
}
if !has_message_id {
output.write_all(b"Message-ID: ")?;
generate_message_id_header(
&mut output,
gethostname::gethostname().to_str().unwrap_or("localhost"),
)?;
output.write_all(b"\r\n")?;
}
if !has_date {
output.write_all(b"Date: ")?;
output.write_all(Date::now().to_rfc822().as_bytes())?;
output.write_all(b"\r\n")?;
}
self.write_body(output)
}
/// Write the message body without headers.
pub fn write_body(self, output: impl Write) -> io::Result<()> {
(if let Some(body) = self.body {
body
} else {
match (self.text_body, self.html_body, self.attachments) {
(Some(text), Some(html), Some(attachments)) => {
let mut parts = Vec::with_capacity(attachments.len() + 1);
parts.push(MimePart::new("multipart/alternative", vec![text, html]));
parts.extend(attachments);
MimePart::new("multipart/mixed", parts)
}
(Some(text), Some(html), None) => {
MimePart::new("multipart/alternative", vec![text, html])
}
(Some(text), None, Some(attachments)) => {
let mut parts = Vec::with_capacity(attachments.len() + 1);
parts.push(text);
parts.extend(attachments);
MimePart::new("multipart/mixed", parts)
}
(Some(text), None, None) => text,
(None, Some(html), Some(attachments)) => {
let mut parts = Vec::with_capacity(attachments.len() + 1);
parts.push(html);
parts.extend(attachments);
MimePart::new("multipart/mixed", parts)
}
(None, Some(html), None) => html,
(None, None, Some(attachments)) => MimePart::new("multipart/mixed", attachments),
(None, None, None) => MimePart::new("text/plain", "\n"),
}
})
.write_part(output)?;
Ok(())
}
/// Build message to a Vec<u8>.
pub fn write_to_vec(self) -> io::Result<Vec<u8>> {
let mut output = Vec::new();
self.write_to(&mut output)?;
Ok(output)
}
/// Build message to a String.
pub fn write_to_string(self) -> io::Result<String> {
let mut output = Vec::new();
self.write_to(&mut output)?;
String::from_utf8(output).map_err(|err| io::Error::new(io::ErrorKind::Other, err))
}
}
#[cfg(test)]
mod tests {
use mail_parser::MessageParser;
use crate::{
headers::{address::Address, url::URL},
mime::MimePart,
MessageBuilder,
};
#[test]
fn build_nested_message() {
let output = MessageBuilder::new()
.from(Address::new_address("John Doe".into(), "john@doe.com"))
.to(Address::new_address("Jane Doe".into(), "jane@doe.com"))
.subject("RFC 8621 Section 4.1.4 test")
.body(MimePart::new(
"multipart/mixed",
vec![
MimePart::new("text/plain", "Part A contents go here...").inline(),
MimePart::new(
"multipart/mixed",
vec![
MimePart::new(
"multipart/alternative",
vec![
MimePart::new(
"multipart/mixed",
vec![
MimePart::new(
"text/plain",
"Part B contents go here...",
)
.inline(),
MimePart::new(
"image/jpeg",
"Part C contents go here...".as_bytes(),
)
.inline(),
MimePart::new(
"text/plain",
"Part D contents go here...",
)
.inline(),
],
),
MimePart::new(
"multipart/related",
vec![
MimePart::new(
"text/html",
"Part E contents go here...",
)
.inline(),
MimePart::new(
"image/jpeg",
"Part F contents go here...".as_bytes(),
),
],
),
],
),
MimePart::new("image/jpeg", "Part G contents go here...".as_bytes())
.attachment("image_G.jpg"),
MimePart::new(
"application/x-excel",
"Part H contents go here...".as_bytes(),
),
MimePart::new(
"x-message/rfc822",
"Part J contents go here...".as_bytes(),
),
],
),
MimePart::new("text/plain", "Part K contents go here...").inline(),
],
))
.write_to_vec()
.unwrap();
MessageParser::new().parse(&output).unwrap();
//fs::write("test.yaml", &serde_yaml::to_string(&message).unwrap()).unwrap();
}
#[test]
fn build_message() {
let output = MessageBuilder::new()
.from(("John Doe", "john@doe.com"))
.to(vec![
("Antoine de Saint-Exupéry", "antoine@exupery.com"),
("안녕하세요 세계", "test@test.com"),
("Xin chào", "addr@addr.com"),
])
.bcc(vec![
(
"Привет, мир",
vec![
("ASCII recipient", "addr1@addr7.com"),
("ハロー・ワールド", "addr2@addr6.com"),
("áéíóú", "addr3@addr5.com"),
("Γειά σου Κόσμε", "addr4@addr4.com"),
],
),
(
"Hello world",
vec![
("שלום עולם", "addr5@addr3.com"),
("¡El ñandú comió ñoquis!", "addr6@addr2.com"),
("Recipient", "addr7@addr1.com"),
],
),
])
.header("List-Archive", URL::new("http://example.com/archive"))
.subject("Hello world!")
.text_body("Hello, world!\n".repeat(20))
.html_body("<p>¡Hola Mundo!</p>".repeat(20))
.inline("image/png", "cid:image", [0, 1, 2, 3, 4, 5].as_ref())
.attachment("text/plain", "my fíle.txt", "안녕하세요 세계".repeat(20))
.attachment(
"text/plain",
"ハロー・ワールド",
"ハロー・ワールド".repeat(20).into_bytes(),
)
.write_to_vec()
.unwrap();
MessageParser::new().parse(&output).unwrap();
}
}