join::Smtp Class Reference

SMTP protocol class. More...

#include <protocol.hpp>

Public Types
using	Endpoint = BasicInternetEndpoint <Smtp>
using	Socket = BasicTlsSocket <Smtp>
using	Stream = BasicTlsStream <Smtp>
using	Client = BasicSmtpClient <Smtp>

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

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.

Detailed Description

SMTP protocol class.

Member Typedef Documentation

Client

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

Endpoint

using join::Smtp::Endpoint = BasicInternetEndpoint <Smtp>

Socket

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

Stream

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

Constructor & Destructor Documentation

Smtp()

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

inlineconstexprnoexcept

create 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.

protocol()

int join::Smtp::protocol ( ) const

inlineconstexprnoexcept

get the protocol type.

Returns

the protocol type.

type()

int join::Smtp::type ( ) const

inlineconstexprnoexcept

get the protocol communication semantic.

Returns

the protocol communication semantic.

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.

---

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

• core/include/join/protocol.hpp