Struct Sender

pub struct Sender {
    pub address: String,
    pub name: Option<String>,
    pub reply_to: Option<String>,
}

Represents email sender information including address, name, and reply-to.

The Sender struct is used in EmailOptions to specify who the email appears to be from, which can differ from the actual sending address managed by SendWithUs.

Examples

use send_with_us::types::Sender;

// Create a sender with just an email address
let sender = Sender::new("support@company.com");

// Create a sender with a name
let sender = Sender::new("noreply@company.com")
  .with_name("Company Support");

// Create a sender with a name and reply-to address
let sender = Sender::new("noreply@company.com")
  .with_name("Company Support")
  .with_reply_to("support@company.com");

Fields

address: String

Sender’s email address

name: Option<String>

Sender’s name (optional)

reply_to: Option<String>

Reply-to address (optional)

Implementations

impl Sender

pub fn new(address: impl Into<String>) -> Self

Creates a new sender with the specified email address.

Arguments

• address - The sender’s email address

Returns

A new Sender instance with the provided email address

Examples

use send_with_us::types::Sender;

let sender = Sender::new("support@company.com");
assert_eq!(sender.address, "support@company.com");
assert_eq!(sender.name, None);
assert_eq!(sender.reply_to, None);

pub fn with_name(self, name: impl Into<String>) -> Self

Sets the sender’s name.

This method uses the builder pattern, allowing for method chaining.

Arguments

• name - The sender’s name

Returns

Self with the updated name for method chaining

Examples

use send_with_us::types::Sender;

let sender = Sender::new("support@company.com")
  .with_name("Company Support Team");
     
assert_eq!(sender.name, Some("Company Support Team".to_string()));

pub fn with_reply_to(self, reply_to: impl Into<String>) -> Self

Sets the reply-to address.

This address will be used when recipients click “Reply” in their email client.

Arguments

• reply_to - The email address to use for replies

Returns

Self with the updated reply-to for method chaining

Examples

use send_with_us::types::Sender;

let sender = Sender::new("noreply@company.com")
  .with_reply_to("support@company.com");
     
assert_eq!(sender.reply_to, Some("support@company.com".to_string()));

Trait Implementations

impl Clone for Sender

fn clone(&self) -> Sender

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Sender

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Sender

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Sender

fn eq(&self, other: &Sender) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Sender

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Sender