Struct Recipient

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

Represents an email recipient with an email address and optional name.

Recipients are used in the EmailOptions struct to specify who will receive an email, including primary recipients, CC, and BCC.

Examples

use send_with_us::types::Recipient;

let recipient = Recipient::new("user@example.com");

let recipient = Recipient::new("user@example.com")
  .with_name("John Doe");

Fields

address: String

Recipient’s email address

name: Option<String>

Recipient’s name (optional)

Implementations

impl Recipient

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

Creates a new recipient with the specified email address.

Arguments

• address - The recipient’s email address

Returns

A new Recipient instance with the provided email and no name

Examples

use send_with_us::types::Recipient;

let recipient = Recipient::new("user@example.com");
assert_eq!(recipient.address, "user@example.com");
assert_eq!(recipient.name, None);

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

Sets the recipient’s name.

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

Arguments

• name - The recipient’s name

Returns

Self with the updated name for method chaining

Examples

use send_with_us::types::Recipient;

let recipient = Recipient::new("user@example.com")
  .with_name("John Doe");
     
assert_eq!(recipient.address, "user@example.com");
assert_eq!(recipient.name, Some("John Doe".to_string()));

Trait Implementations

impl Clone for Recipient

fn clone(&self) -> Recipient

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Recipient

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Recipient

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Recipient

fn eq(&self, other: &Recipient) -> 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 Recipient

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 Recipient