Struct Envelope

Source

pub struct Envelope { /* private fields */ }

Expand description

SMTP envelope with transport sender and recipients.

Implementations§

Source §

impl Envelope

Source

pub const fn new(sender: EnvelopeSender) -> Envelope

Creates an envelope with no recipients.

Examples found in repository ?

examples/email_facade_basic_usage.rs (line 8)

3fn main() -> Result<(), Box<dyn std::error::Error>> {
4    let mailbox = address::Mailbox::new(Some("Jane Doe"), "jane@example.com")?;
5    let message_id: id::MessageId = "welcome@example.com".parse()?;
6    let message = message::EmailMessage::plain_text("Welcome", "A short note.")
7        .with_header("From", mailbox.to_string())?;
8    let envelope = envelope::Envelope::new(envelope::EnvelopeSender::new("bounce@example.com")?)
9        .with_recipient(envelope::EnvelopeRecipient::new("jane@example.com")?);
10    let mailto_uri = mailto::MailtoBuilder::new()
11        .to("jane@example.com")?
12        .subject("Welcome")
13        .build();
14    let reply = smtp::SmtpReply::new(smtp::SmtpReplyCode::new(250)?, "OK")?;
15    let spf = auth::spf::SpfRecord::new().with_term(auth::spf::SpfTerm::new(
16        auth::spf::SpfQualifier::Fail,
17        auth::spf::SpfMechanism::All,
18    ));
19
20    assert_eq!(message.subject(), Some("Welcome"));
21    assert_eq!(message_id.to_string(), "<welcome@example.com>");
22    assert_eq!(envelope.recipients().len(), 1);
23    assert_eq!(
24        mailto_uri.to_string(),
25        "mailto:jane@example.com?subject=Welcome"
26    );
27    assert_eq!(reply.to_string(), "250 OK");
28    assert_eq!(spf.to_string(), "v=spf1 -all");
29
30    Ok(())
31}

Source

pub fn with_recipient(self, recipient: EnvelopeRecipient) -> Envelope

Adds a recipient and returns the updated envelope.

Examples found in repository ?

examples/email_facade_basic_usage.rs (line 9)

3fn main() -> Result<(), Box<dyn std::error::Error>> {
4    let mailbox = address::Mailbox::new(Some("Jane Doe"), "jane@example.com")?;
5    let message_id: id::MessageId = "welcome@example.com".parse()?;
6    let message = message::EmailMessage::plain_text("Welcome", "A short note.")
7        .with_header("From", mailbox.to_string())?;
8    let envelope = envelope::Envelope::new(envelope::EnvelopeSender::new("bounce@example.com")?)
9        .with_recipient(envelope::EnvelopeRecipient::new("jane@example.com")?);
10    let mailto_uri = mailto::MailtoBuilder::new()
11        .to("jane@example.com")?
12        .subject("Welcome")
13        .build();
14    let reply = smtp::SmtpReply::new(smtp::SmtpReplyCode::new(250)?, "OK")?;
15    let spf = auth::spf::SpfRecord::new().with_term(auth::spf::SpfTerm::new(
16        auth::spf::SpfQualifier::Fail,
17        auth::spf::SpfMechanism::All,
18    ));
19
20    assert_eq!(message.subject(), Some("Welcome"));
21    assert_eq!(message_id.to_string(), "<welcome@example.com>");
22    assert_eq!(envelope.recipients().len(), 1);
23    assert_eq!(
24        mailto_uri.to_string(),
25        "mailto:jane@example.com?subject=Welcome"
26    );
27    assert_eq!(reply.to_string(), "250 OK");
28    assert_eq!(spf.to_string(), "v=spf1 -all");
29
30    Ok(())
31}

Source

pub fn push_recipient(&mut self, recipient: EnvelopeRecipient)

Appends a recipient.

Source

pub const fn sender(&self) -> &EnvelopeSender

Returns the envelope sender.

Source

pub fn recipients(&self) -> &[EnvelopeRecipient]

Returns envelope recipients.

Examples found in repository ?

examples/email_facade_basic_usage.rs (line 22)

3fn main() -> Result<(), Box<dyn std::error::Error>> {
4    let mailbox = address::Mailbox::new(Some("Jane Doe"), "jane@example.com")?;
5    let message_id: id::MessageId = "welcome@example.com".parse()?;
6    let message = message::EmailMessage::plain_text("Welcome", "A short note.")
7        .with_header("From", mailbox.to_string())?;
8    let envelope = envelope::Envelope::new(envelope::EnvelopeSender::new("bounce@example.com")?)
9        .with_recipient(envelope::EnvelopeRecipient::new("jane@example.com")?);
10    let mailto_uri = mailto::MailtoBuilder::new()
11        .to("jane@example.com")?
12        .subject("Welcome")
13        .build();
14    let reply = smtp::SmtpReply::new(smtp::SmtpReplyCode::new(250)?, "OK")?;
15    let spf = auth::spf::SpfRecord::new().with_term(auth::spf::SpfTerm::new(
16        auth::spf::SpfQualifier::Fail,
17        auth::spf::SpfMechanism::All,
18    ));
19
20    assert_eq!(message.subject(), Some("Welcome"));
21    assert_eq!(message_id.to_string(), "<welcome@example.com>");
22    assert_eq!(envelope.recipients().len(), 1);
23    assert_eq!(
24        mailto_uri.to_string(),
25        "mailto:jane@example.com?subject=Welcome"
26    );
27    assert_eq!(reply.to_string(), "250 OK");
28    assert_eq!(spf.to_string(), "v=spf1 -all");
29
30    Ok(())
31}