maik

A mock SMTP server library for Rust.

Supported standards

• SMTP (RFC5321)
• TLS (RFC3207)
• AUTH (RFC4954)
  • PLAIN (RFC4616)

lib.rs:

maik is a mock SMTP server library. It is designed to help write integration tests for applications that send emails.

Examples

Basic example with authentication and TLS, using the lettre client.

use lettre::{
    message::Mailboxes,
    transport::smtp::{
        authentication::{Credentials, Mechanism},
        client::{Certificate, Tls, TlsParameters, TlsParametersBuilder},
        SmtpTransport,
    },
    Message, Transport,
};
use maik::{MailAssertion, MockServer};

#[test]
fn send_with_auth_and_tls() {
    // set up and start the mock server
    let server = MockServer::builder()
        .add_mailbox("[email protected]", "my_password")
        .build();

    server.start();

    // set up the client using lettre
    let certificate = Certificate::from_pem(server.cert_pem()).unwrap();
    let tls_params = TlsParametersBuilder::new(server.host().to_string())
        .add_root_certificate(certificate)
        .build()
        .unwrap();
    let credentials =
        Credentials::new(String::from("[email protected]"), String::from("my_password"));
    let mailer = SmtpTransport::relay(&server.host().to_string())
        .unwrap()
        .port(server.port())
        .tls(Tls::Opportunistic(tls_params))
        .credentials(credentials)
        .authentication(vec![Mechanism::Plain])
        .build();

    // send a mail message
    let message = Message::builder()
        .from("[email protected]".parse().unwrap())
        .to("[email protected]".parse().unwrap())
        .body(String::from("What's up?"))
        .unwrap();
    mailer.send(&message);

    // assert [email protected] sent "What's up?" to [email protected]
    let ma = MailAssertion::new()
        .sender_is("[email protected]")
        .recipients_are(["[email protected]"])
        .body_is("What's up?");
    assert!(server.assert(ma));
}

Another example using the lettre client, without tls and verification of authentication credentials.

use lettre::{
    message::Mailboxes,
    transport::smtp::{
        authentication::{Credentials, Mechanism},
        client::{Certificate, Tls},
        SmtpTransport,
    },
    Message, Transport,
};
use maik::{MailAssertion, MockServer};
use regex::bytes::Regex;

#[test]
fn no_verify_credentials_no_tls() {
    // set up and start the mock server
    let server = MockServer::builder()
        .no_verify_credentials()
        .build();

    server.start();

    // set up the client using lettre
    let credentials = Credentials::new(
        String::from("[email protected]"),
        String::from("any_password"),
    );
    let mailer = SmtpTransport::relay(&server.host().to_string())
        .unwrap()
        .port(server.port())
        .tls(Tls::None)
        .credentials(credentials)
        .authentication(vec![Mechanism::Plain])
        .build();

    // send a mail message
    let message = Message::builder()
        .from("[email protected]".parse().unwrap())
        .to("[email protected]".parse().unwrap())
        .body(String::from("Here is your verification code: 123456"))
        .unwrap();
    mailer.send(&message);

    // assert [email protected] received some mail that ends with "verification code: \d{6}"
    let ma = MailAssertion::new()
        .recipients_are(["[email protected]"])
        .body_matches(Regex::new(r"verification code: \d{6}$").unwrap());
    assert!(server.assert(ma));
}