join 1.0
lightweight network framework library
Loading...
Searching...
No Matches
join::SmtpRecipient Class Reference

mail recipient. More...

#include <smtp_message.hpp>

Inheritance diagram for join::SmtpRecipient:
Collaboration diagram for join::SmtpRecipient:

Public Types

enum  Type { Recipient , CCRecipient , BCCRecipient }
 recipient type. More...
 

Public Member Functions

 SmtpRecipient ()=default
 create the SmtpRecipient instance.
 
 SmtpRecipient (const std::string &address, Type t=Recipient)
 create the SmtpRecipient instance.
 
 SmtpRecipient (const std::string &address, const std::string &name, Type t=Recipient)
 create the SmtpRecipient instance.
 
 SmtpRecipient (const SmtpRecipient &other)
 create the SmtpRecipient instance by copy.
 
SmtpRecipientoperator= (const SmtpRecipient &other)
 assign the SmtpRecipient instance by copy.
 
 SmtpRecipient (SmtpRecipient &&other)
 create the SmtpRecipient instance by move.
 
SmtpRecipientoperator= (SmtpRecipient &&other)
 assign the SmtpRecipient instance by move.
 
virtual ~SmtpRecipient ()=default
 destroy the SmtpRecipient instance.
 
void type (Type t)
 set recipient type.
 
Type type () const
 get recipient type.
 
- Public Member Functions inherited from join::SmtpSender
 SmtpSender ()=default
 create the SmtpSender instance.
 
 SmtpSender (const std::string &address)
 create the SmtpSender instance.
 
 SmtpSender (const std::string &address, const std::string &name)
 create the SmtpSender instance.
 
 SmtpSender (const SmtpSender &other)
 create the SmtpSender instance by copy.
 
SmtpSenderoperator= (const SmtpSender &other)
 assign the SmtpSender instance by copy.
 
 SmtpSender (SmtpSender &&other)
 create the SmtpSender instance by move.
 
SmtpSenderoperator= (SmtpSender &&other)
 assign the SmtpSender instance by move.
 
virtual ~SmtpSender ()=default
 destroy the SmtpSender instance.
 
void address (const std::string &addr)
 set address.
 
const std::string & address () const
 get address.
 
void realName (const std::string &name)
 set real name.
 
const std::string & realName () const
 get real name.
 
bool empty () const
 check if empty.
 

Protected Attributes

Type _type = Recipient
 recipient type.
 
- Protected Attributes inherited from join::SmtpSender
std::string _address
 address.
 
std::string _name
 name.
 

Detailed Description

mail recipient.

Member Enumeration Documentation

◆ Type

recipient type.

Enumerator
Recipient 

recipient.

CCRecipient 

carbon copy.

BCCRecipient 

black carbon copy.

Constructor & Destructor Documentation

◆ SmtpRecipient() [1/5]

join::SmtpRecipient::SmtpRecipient ( )
default

create the SmtpRecipient instance.

◆ SmtpRecipient() [2/5]

SmtpRecipient::SmtpRecipient ( const std::string & address,
Type t = Recipient )

create the SmtpRecipient instance.

Parameters
addressrecipient address.
trecipient type.

◆ SmtpRecipient() [3/5]

SmtpRecipient::SmtpRecipient ( const std::string & address,
const std::string & name,
Type t = Recipient )

create the SmtpRecipient instance.

Parameters
addressrecipient address.
namerecipient name.
trecipient type.

◆ SmtpRecipient() [4/5]

SmtpRecipient::SmtpRecipient ( const SmtpRecipient & other)

create the SmtpRecipient instance by copy.

Parameters
otherrequest to copy.

◆ SmtpRecipient() [5/5]

SmtpRecipient::SmtpRecipient ( SmtpRecipient && other)

create the SmtpRecipient instance by move.

Parameters
otherrequest to move.

◆ ~SmtpRecipient()

virtual join::SmtpRecipient::~SmtpRecipient ( )
virtualdefault

destroy the SmtpRecipient instance.

Member Function Documentation

◆ operator=() [1/2]

SmtpRecipient & SmtpRecipient::operator= ( const SmtpRecipient & other)

assign the SmtpRecipient instance by copy.

Parameters
otherrequest to copy.
Returns
a reference of the current object.

◆ operator=() [2/2]

SmtpRecipient & SmtpRecipient::operator= ( SmtpRecipient && other)

assign the SmtpRecipient instance by move.

Parameters
otherrequest to move.
Returns
a reference of the current object.

◆ type() [1/2]

SmtpRecipient::Type SmtpRecipient::type ( ) const

get recipient type.

Returns
recipient type.

◆ type() [2/2]

void SmtpRecipient::type ( Type t)

set recipient type.

Parameters
trecipient type.

Member Data Documentation

◆ _type

Type join::SmtpRecipient::_type = Recipient
protected

recipient type.


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