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

mail message. More...

#include <mailmessage.hpp>

Collaboration diagram for join::MailMessage:

Public Member Functions

 MailMessage ()=default
 create the MailMessage instance.
 
 MailMessage (const MailMessage &other)
 create the MailMessage instance by copy.
 
MailMessageoperator= (const MailMessage &other)
 assign the MailMessage instance by copy.
 
 MailMessage (MailMessage &&other)
 create the MailMessage instance by move.
 
MailMessageoperator= (MailMessage &&other)
 assign the MailMessage instance by move.
 
virtual ~MailMessage ()=default
 destroy the MailMessage instance.
 
void sender (const MailSender &from)
 set mail sender.
 
const MailSendersender () const
 get mail sender
 
void addRecipient (const MailRecipient &to)
 add mail recipient.
 
void addRecipient (MailRecipient &&to)
 add mail recipient.
 
const MailRecipientsrecipients () const
 get mail recipients.
 
void subject (const std::string &subj)
 set mail subject.
 
const std::string & subject () const
 get mail subject.
 
void content (const std::string &message)
 set mail content.
 
const std::string & content () const
 get mail content.
 
int writeHeaders (std::ostream &out) const
 write header to the given output stream.
 
int writeContent (std::ostream &out) const
 write content to the given output stream.
 

Protected Attributes

MailSender _sender
 mail sender.
 
MailRecipients _recipients
 mail recipients.
 
std::string _subject
 mail sender.
 
std::string _content
 mail content.
 

Detailed Description

mail message.

Constructor & Destructor Documentation

◆ MailMessage() [1/3]

join::MailMessage::MailMessage ( )
default

create the MailMessage instance.

◆ MailMessage() [2/3]

MailMessage::MailMessage ( const MailMessage & other)

create the MailMessage instance by copy.

Parameters
otherrequest to copy.

◆ MailMessage() [3/3]

MailMessage::MailMessage ( MailMessage && other)

create the MailMessage instance by move.

Parameters
otherrequest to move.

◆ ~MailMessage()

virtual join::MailMessage::~MailMessage ( )
virtualdefault

destroy the MailMessage instance.

Member Function Documentation

◆ addRecipient() [1/2]

void MailMessage::addRecipient ( const MailRecipient & to)

add mail recipient.

Parameters
tomail recipient.

◆ addRecipient() [2/2]

void MailMessage::addRecipient ( MailRecipient && to)

add mail recipient.

Parameters
tomail recipient.

◆ content() [1/2]

const std::string & MailMessage::content ( ) const

get mail content.

Returns
mail content.

◆ content() [2/2]

void MailMessage::content ( const std::string & message)

set mail content.

Parameters
messagemail content.

◆ operator=() [1/2]

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

assign the MailMessage instance by copy.

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

◆ operator=() [2/2]

MailMessage & MailMessage::operator= ( MailMessage && other)

assign the MailMessage instance by move.

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

◆ recipients()

const MailRecipients & MailMessage::recipients ( ) const

get mail recipients.

Returns
mail recipients.

◆ sender() [1/2]

const MailSender & MailMessage::sender ( ) const

get mail sender

Returns
mail sender.

◆ sender() [2/2]

void MailMessage::sender ( const MailSender & from)

set mail sender.

Parameters
frommail sender.

◆ subject() [1/2]

const std::string & MailMessage::subject ( ) const

get mail subject.

Returns
mail subject.

◆ subject() [2/2]

void MailMessage::subject ( const std::string & subj)

set mail subject.

Parameters
subjmail subject.

◆ writeContent()

int MailMessage::writeContent ( std::ostream & out) const

write content to the given output stream.

Parameters
outoutput stream.
Returns
0 on success, -1 on failure.

◆ writeHeaders()

int MailMessage::writeHeaders ( std::ostream & out) const

write header to the given output stream.

Parameters
outoutput stream.
Returns
0 on success, -1 on failure.

Member Data Documentation

◆ _content

std::string join::MailMessage::_content
protected

mail content.

◆ _recipients

MailRecipients join::MailMessage::_recipients
protected

mail recipients.

◆ _sender

MailSender join::MailMessage::_sender
protected

mail sender.

◆ _subject

std::string join::MailMessage::_subject
protected

mail sender.


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