@spec auth(socket(), auth_method(), auth_credentials(), timeout()) :: :ok | error()

Sends AUTH extension command and authenticates the sender.

:ok = auth(socket, :login, username: username, password: password)
:ok = auth(socket, :plain, username: username, password: password)

@spec close(socket()) :: :ok | {:error, Mua.TransportError.t()}

Closes connection to the SMTP server.

:ok = close(socket)

@spec connect(proto(), host(), :inet.port_number(), transport_opts(), timeout()) ::
  {:ok, socket(), banner :: String.t()} | error()

Connects to an SMTP server and receives its banner.

{:ok, socket, _banner} = connect(:tcp, host, _port = 25)
{:ok, socket, _banner} = connect(:ssl, host, _port = 465, versions: [:"tlsv1.3"])

@spec data(socket(), iodata(), timeout()) :: {:ok, receipt :: String.t()} | error()

Sends DATA command that specifies the beginning of the mail, and then sends the message.

{:ok, _receipt} = data(socket, "Date: Sat, 24 Jun 2023 13:43:57 +0000\r\n...")

@spec easy_send(String.t() | :inet.ip_address(), String.t(), [String.t()], iodata(), [
  option()
]) ::
  {:ok, receipt :: String.t()} | error()

Utility function to send a message to a list of recipients on a host.

{:ok, _receipt} =
  easy_send(
    _host = "gmail.com",
    _sender = "mua@github.com",
    _recipients = ["support@gmail.com"],
    _message = "Date: Sat, 24 Jun 2023 13:43:57 +0000\r\n..."
  )

@spec ehlo(socket(), String.t(), timeout()) :: {:ok, [String.t()]} | error()

Sends EHLO command which provides the identification of the sender i.e. the host name, and receives the list of extensions the server supports.

{:ok, _extensions = ["STARTTLS" | _rest]} = ehlo(socket, _our_hostname = "copycat.fun")

@spec guess_sender_hostname() :: {:ok, String.t()} | {:error, :inet.posix()}

Utility function to guess the local hostname to use for HELO/EHLO.

{:ok, "mac3"} = guess_sender_hostname()

@spec helo(socket(), String.t(), timeout()) :: :ok | error()

Sends HELO command which provides the identification of the sender i.e. the host name.

:ok = helo(socket, _our_hostname = "copycat.fun")

@spec mail_from(socket(), String.t(), timeout()) :: :ok | error()

Sends MAIL FROM command that specifies the originator of the mail.

:ok = mail_from(socket, "hey@copycat.fun")

@spec mxlookup(String.t()) :: [String.t()]

Utility function to lookup MX servers for a domain.

["gmail-smtp-in.l.google.com" | _rest] = mxlookup("gmail.com")

@spec noop(socket(), timeout()) :: :ok | error()

Sends NOOP command that does nothing.

:ok = noop(socket)

@spec pick_auth_method([String.t()]) :: auth_method() | nil

Utility function to pick a supported auth method from a list of extensions.

{:ok, extensions} = ehlo(socket, hostname)
maybe_method = pick_auth_method(extensions)
true = maybe_method in [nil, :plain, :login]

@spec quit(socket(), timeout()) :: :ok | error()

Sends QUIT command that make the server close the connection.

:ok = quit(socket)

@spec rcpt_to(socket(), String.t(), timeout()) :: :ok | error()

Sends RCPT TO command that specify the recipient of the mail.

:ok = rcpt_to(socket, "world@hey.com")

@spec rset(socket(), timeout()) :: :ok | error()

Sends RSET command that aborts the current mail transaction but keeps the socket open.

:ok = rset(socket)

@spec starttls(:gen_tcp.socket(), host(), transport_opts(), timeout()) ::
  {:ok, :ssl.sslsocket()} | error()

Sends STARTTLS extension command and starts TLS session negotiation.

{:ok, sslsocket} = starttls(socket, host, versions: [:"tlsv1.3"])

@spec vrfy(socket(), String.t(), timeout()) :: {:ok, boolean()} | error()

Sends VRFY command that confirms or verifies the user name.

{:ok, true} = vrfy(socket, "dogaruslan@gmail.com")