Basic SMTPS client. More...

#include <smtp_client.hpp>

Inheritance diagram for join::BasicSmtpSecureClient< Protocol >:

Collaboration diagram for join::BasicSmtpSecureClient< Protocol >:

Public Types
using	Endpoint = typename Protocol::Endpoint

Public Types inherited from join::BasicSmtpClient< Protocol >
using	Endpoint = typename Protocol::Endpoint

using	Stream = typename Protocol::Stream

Public Member Functions
	BasicSmtpSecureClient (TlsContext ctx, const char *host, uint16_t port=Protocol::defaultPort)
	create the basic SMTPS client instance using the given context.

	BasicSmtpSecureClient (TlsContext ctx, const std::string &host, uint16_t port=Protocol::defaultPort)
	create the basic SMTPS client instance using the given context.

	BasicSmtpSecureClient (const BasicSmtpSecureClient &other)=delete
	create the basic SMTPS client instance by copy.

BasicSmtpSecureClient &	operator= (const BasicSmtpSecureClient &other)=delete
	assign the basic SMTPS client instance by copy.

	BasicSmtpSecureClient (BasicSmtpSecureClient &&other)
	create the basic SMTPS client instance by move.

BasicSmtpSecureClient &	operator= (BasicSmtpSecureClient &&other)
	assign the basic SMTPS client instance by move.

virtual	~BasicSmtpSecureClient ()=default
	destroy the basic SMTPS client instance.

std::string	scheme () const override
	get scheme.

Public Member Functions inherited from join::BasicSmtpClient< Protocol >
	BasicSmtpClient (const char *host, uint16_t port=Protocol::defaultPort)
	create the basic SMTP client instance.

	BasicSmtpClient (const std::string &host, uint16_t port=Protocol::defaultPort)
	create the basic SMTP client instance.

	BasicSmtpClient (TlsContext ctx, const char *host, uint16_t port=Protocol::defaultPort)
	create the basic SMTP client instance using the given context.

	BasicSmtpClient (TlsContext ctx, const std::string &host, uint16_t port=Protocol::defaultPort)
	create the basic SMTP client instance using the given context.

	BasicSmtpClient (const BasicSmtpClient &other)=delete
	create the basic SMTP client instance by copy.

BasicSmtpClient &	operator= (const BasicSmtpClient &other)=delete
	assign the basic SMTP client instance by copy.

	BasicSmtpClient (BasicSmtpClient &&other)
	create the basic SMTP client instance by move.

BasicSmtpClient &	operator= (BasicSmtpClient &&other)
	assign the basic SMTP client instance by move.

virtual	~BasicSmtpClient ()=default
	destroy the basic SMTP client instance.

const std::string &	host () const
	get host.

uint16_t	port () const
	get port.

std::string	authority () const
	get authority.

std::string	url () const
	get URL.

void	credentials (const std::string &login, const std::string &password)
	set credentials.

int	send (const SmtpMessage &message)
	send mail message.

Protected Member Functions
int	connect (const Endpoint &endpoint) override
	make a connection to the given endpoint.

Protected Member Functions inherited from join::BasicSmtpClient< Protocol >
void	close ()
	close the connection.

int	sendMessage (const std::string &message)
	send message.

std::string	readReplies (std::vector< std::string > *replies=nullptr)
	read replies.

int	greeting ()
	handle greeting.

int	initialize (std::vector< std::string > &replies)
	client init.

int	startTls ()
	start encryption.

int	loginAuthenticate ()
	authenticate using LOGIN.

int	plainAuthenticate ()
	authenticate using PLAIN.

int	sendFrom (const SmtpMessage &message)
	send sender address.

int	sendTo (const SmtpMessage &message)
	send recpient address.

int	sendData (const SmtpMessage &message)
	send message.

int	quit ()
	send quit.

std::string	hostname () const
	get host name.

Additional Inherited Members
Protected Attributes inherited from join::BasicSmtpClient< Protocol >
Stream	_stream
	stream.

std::string	_host
	SMTP host.

uint16_t	_port
	SMTP port.

std::string	_login
	SMTP login.

std::string	_password
	SMTP password.

Detailed Description

template<class Protocol>
class join::BasicSmtpSecureClient< Protocol >

Basic SMTPS client.

Member Typedef Documentation

◆ Endpoint

template<class Protocol >

using join::BasicSmtpSecureClient< Protocol >::Endpoint = typename Protocol::Endpoint

Constructor & Destructor Documentation

◆ BasicSmtpSecureClient() [1/4]

template<class Protocol >

join::BasicSmtpSecureClient< Protocol >::BasicSmtpSecureClient	(	TlsContext	ctx,
		const char *	host,
		uint16_t	port = Protocol::defaultPort )

inline

create the basic SMTPS client instance using the given context.

Parameters

ctx	TLS context to use for the encryption layer.
host	host.
port	port (default: 465).

◆ BasicSmtpSecureClient() [2/4]

template<class Protocol >

join::BasicSmtpSecureClient< Protocol >::BasicSmtpSecureClient	(	TlsContext	ctx,
		const std::string &	host,
		uint16_t	port = Protocol::defaultPort )

inline

create the basic SMTPS client instance using the given context.

Parameters

ctx	TLS context to use for the encryption layer.
host	host.
port	port (default: 465).

◆ BasicSmtpSecureClient() [3/4]

template<class Protocol >

join::BasicSmtpSecureClient< Protocol >::BasicSmtpSecureClient ( const BasicSmtpSecureClient< Protocol > & other )

delete

create the basic SMTPS client instance by copy.

Parameters

other request to copy.

◆ BasicSmtpSecureClient() [4/4]

template<class Protocol >

join::BasicSmtpSecureClient< Protocol >::BasicSmtpSecureClient ( BasicSmtpSecureClient< Protocol > && other )

inline

create the basic SMTPS client instance by move.

Parameters

other request to move.

◆ ~BasicSmtpSecureClient()

template<class Protocol >

virtual join::BasicSmtpSecureClient< Protocol >::~BasicSmtpSecureClient ( )

virtualdefault

destroy the basic SMTPS client instance.

Member Function Documentation

◆ connect()

template<class Protocol >

int join::BasicSmtpSecureClient< Protocol >::connect ( const Endpoint & endpoint )

inlineoverrideprotectedvirtual

make a connection to the given endpoint.

Parameters

endpoint endpoint to connect to.

Returns: 0 on success, -1 on failure.

Reimplemented from join::BasicSmtpClient< Protocol >.

◆ operator=() [1/2]

template<class Protocol >

BasicSmtpSecureClient & join::BasicSmtpSecureClient< Protocol >::operator= ( BasicSmtpSecureClient< Protocol > && other )

inline

assign the basic SMTPS client instance by move.

Parameters

other request to move.

Returns: a reference of the current object.

◆ operator=() [2/2]

template<class Protocol >

BasicSmtpSecureClient & join::BasicSmtpSecureClient< Protocol >::operator= ( const BasicSmtpSecureClient< Protocol > & other )

delete

assign the basic SMTPS client instance by copy.

Parameters

other request to copy.

Returns: a reference of the current object.

◆ scheme()

template<class Protocol >

std::string join::BasicSmtpSecureClient< Protocol >::scheme ( ) const

inlineoverridevirtual

get scheme.

Returns: scheme.

Reimplemented from join::BasicSmtpClient< Protocol >.

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

services/include/join/smtp_client.hpp
services/include/join/smtp_protocol.hpp

Public Types

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Endpoint

Constructor & Destructor Documentation

◆ BasicSmtpSecureClient() [1/4]

◆ BasicSmtpSecureClient() [2/4]

◆ BasicSmtpSecureClient() [3/4]

◆ BasicSmtpSecureClient() [4/4]

◆ ~BasicSmtpSecureClient()

Member Function Documentation

◆ connect()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ scheme()