Enum new_tokio_smtp::ClientId

pub enum ClientId {
    Domain(Domain),
    AddressLiteral(AddressLiteral),
}

Represents the identity of an client

If you connect to an MSA this can be as simple as localhost, through for smtp communication between servers or for connecting with an MX server this should be a public facing domain or ip address

---

MSA: Mail Submission Agent

MX: Mail Exchanger

Variants

Domain(Domain)

a registered domain

AddressLiteral(AddressLiteral)

a ipv4/ipv6 address, through theoretically others protocols are possible too

Implementations

impl ClientId

pub fn localhost() -> Self

creates a client identity for “localhost” (here fixed to 127.0.0.1)

This can be used as client identity when connecting a mail client to a Mail Submission Agent (MSA), but should not be used when connecting to an Mail Exchanger (MX).

pub fn hostname() -> Self

creates a client identity using hostname (fallback localhost)

This uses the hostname crate to create a client identity. If this fails ClientId::localhost() is used.

pub fn try_hostname() -> Option<Self>

creates a client identity if a hostname can be found

Implementation Note

As the hostname crate currently only returns an Option we also do so.

Trait Implementations

impl Clone for ClientId

fn clone(&self) -> ClientId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ClientId

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

Formats the value using the given formatter.

impl From<AddressLiteral> for ClientId

fn from(adl: AddressLiteral) -> Self

Converts to this type from the input type.

impl From<ClientId> for Ehlo

fn from(identity: ClientId) -> Self

Converts to this type from the input type.

impl From<Domain> for ClientId

fn from(dm: Domain) -> Self

Converts to this type from the input type.

impl From<IpAddr> for ClientId

fn from(saddr: IpAddr) -> Self

Converts to this type from the input type.

impl From<Ipv4Addr> for ClientId

fn from(saddr: Ipv4Addr) -> Self

Converts to this type from the input type.

impl From<Ipv6Addr> for ClientId

fn from(saddr: Ipv6Addr) -> Self

Converts to this type from the input type.

impl Into<ClientId> for Ehlo

fn into(self) -> ClientId

Converts this type into the (usually inferred) input type.