lumenmail - v1.1.0

lumenmail/smtp

SMTP client implementation. Provides functionality for connecting to SMTP servers and sending emails.

Types

SmtpClient

</>

Active SMTP connection.

pub type SmtpClient {
  SmtpClient(
    socket: network.Socket,
    capabilities: types.ServerCapabilities,
    is_tls: Bool,
  )
}

Constructors

SmtpClientBuilder

</>

SMTP client configuration builder.

pub type SmtpClientBuilder {
  SmtpClientBuilder(
    host: String,
    port: Int,
    tls_mode: types.TlsMode,
    credentials: option.Option(types.Credentials),
    timeout_ms: Int,
    helo_host: String,
    allow_invalid_certs: Bool,
  )
}

Constructors

Socket

</>

Socket type - re-exported from network module.

pub type Socket =
  network.Socket

Values

allow_invalid_certs

</> 
pub fn allow_invalid_certs(
  builder: SmtpClientBuilder,
  allow: Bool,
) -> SmtpClientBuilder

Allow invalid/self-signed TLS certificates.

auth

</> 
pub fn auth(
  builder: SmtpClientBuilder,
  username: String,
  password: String,
) -> SmtpClientBuilder

Sets username/password credentials.

builder

</> 
pub fn builder(host: String, port: Int) -> SmtpClientBuilder

Creates a new SMTP client builder.

capabilities

</> 
pub fn capabilities(
  client: SmtpClient,
) -> types.ServerCapabilities

Gets server capabilities.

close

</> 
pub fn close(client: SmtpClient) -> Result(Nil, types.SmtpError)

Closes the SMTP connection gracefully.

connect

</> 
pub fn connect(
  builder: SmtpClientBuilder,
) -> Result(SmtpClient, types.SmtpError)

Connects to the SMTP server.

credentials

</> 
pub fn credentials(
  builder: SmtpClientBuilder,
  creds: types.Credentials,
) -> SmtpClientBuilder

Sets authentication credentials.

helo_host

</> 
pub fn helo_host(
  builder: SmtpClientBuilder,
  host: String,
) -> SmtpClientBuilder

Sets the hostname used in HELO/EHLO.

implicit_tls

</> 
pub fn implicit_tls(
  builder: SmtpClientBuilder,
  use_implicit: Bool,
) -> SmtpClientBuilder

Sets implicit TLS mode (port 465).

noop

</> 
pub fn noop(client: SmtpClient) -> Result(Nil, types.SmtpError)

Sends a NOOP command to keep connection alive.

reset

</> 
pub fn reset(client: SmtpClient) -> Result(Nil, types.SmtpError)

Resets the connection state (for sending multiple emails).

send

</> 
pub fn send(
  client: SmtpClient,
  msg: message.Message,
) -> Result(Nil, types.SmtpError)

Sends an email message.

send_raw

</> 
pub fn send_raw(
  client: SmtpClient,
  from: String,
  to: List(String),
  data: String,
) -> Result(Nil, types.SmtpError)

Sends a raw email with pre-built content.

timeout

</> 
pub fn timeout(
  builder: SmtpClientBuilder,
  timeout_ms: Int,
) -> SmtpClientBuilder

Sets connection timeout in milliseconds.

tls_mode

</> 
pub fn tls_mode(
  builder: SmtpClientBuilder,
  mode: types.TlsMode,
) -> SmtpClientBuilder

Sets the TLS mode.

✨ Search Document