join::Smtp Class Reference

SMTP protocol class (SMTP over TCP, upgradable to TLS using STARTTLS). More...

#include <smtp_protocol.hpp>

Public Types
using	Transport = Tcp
using	Endpoint = typename Transport::Endpoint
using	Socket = BasicTlsWrapper<Smtp>
using	Stream = BasicTlsStream<Smtp>
using	Client = BasicSmtpClient<Smtp>

Public Member Functions
constexpr	Smtp (int family=AF_INET) noexcept
	construct the SMTP protocol instance.
constexpr int	family () const noexcept
	get the protocol IP address family.

Static Public Member Functions
static Smtp &	v4 () noexcept
	get protocol suitable for IPv4 address family.
static Smtp &	v6 () noexcept
	get protocol suitable for IPv6 address family.

Static Public Attributes
static constexpr uint16_t	defaultPort = 25
	default SMTP port.

Detailed Description

SMTP protocol class (SMTP over TCP, upgradable to TLS using STARTTLS).

Member Typedef Documentation

Client

using join::Smtp::Client = BasicSmtpClient<Smtp>

Endpoint

using join::Smtp::Endpoint = typename Transport::Endpoint

Socket

using join::Smtp::Socket = BasicTlsWrapper<Smtp>

Stream

using join::Smtp::Stream = BasicTlsStream<Smtp>

Transport

using join::Smtp::Transport = Tcp

Constructor & Destructor Documentation

Smtp()

join::Smtp::Smtp ( int family = AF_INET )

inlineexplicitconstexprnoexcept

construct the SMTP protocol instance.

Parameters

family

IP address family.

Member Function Documentation

family()

int join::Smtp::family ( ) const

inlineconstexprnoexcept

get the protocol IP address family.

Returns

the protocol IP address family.

v4()

static Smtp & join::Smtp::v4 ( )

inlinestaticnoexcept

get protocol suitable for IPv4 address family.

Returns

an IPv4 address family suitable protocol.

v6()

static Smtp & join::Smtp::v6 ( )

inlinestaticnoexcept

get protocol suitable for IPv6 address family.

Returns

an IPv6 address family suitable protocol.

Member Data Documentation

defaultPort

uint16_t join::Smtp::defaultPort = 25

staticconstexpr

default SMTP port.

---

The documentation for this class was generated from the following file:

• services/include/join/smtp_protocol.hpp