nawa::mail::MimeEmail::MimePart Class Reference

#include <nawa/mail/Email/impl/MimeEmail.h>

Public Types
enum class	ApplyEncoding { BASE64 , QUOTED_PRINTABLE , NONE }

Public Member Functions
virtual	~MimePart ()
	MimePart ()
	MimePart (MimePart const &other)
MimePart &	operator= (const MimePart &other)
	MimePart (MimePart &&other) noexcept
MimePart &	operator= (MimePart &&other) noexcept
std::string &	contentType () noexcept
std::string const &	contentType () const noexcept
MimePart &	contentType (std::string value) noexcept
std::string &	contentDisposition () noexcept
std::string const &	contentDisposition () const noexcept
MimePart &	contentDisposition (std::string value) noexcept
ApplyEncoding &	applyEncoding () noexcept
ApplyEncoding	applyEncoding () const noexcept
MimePart &	applyEncoding (ApplyEncoding value) noexcept
HeadersMap &	partHeaders () noexcept
HeadersMap const &	partHeaders () const noexcept
MimePart &	partHeaders (HeadersMap value) noexcept
bool &	allowReplacements () noexcept
bool	allowReplacements () const noexcept
MimePart &	allowReplacements (bool value) noexcept
std::string &	partData () noexcept
std::string const &	partData () const noexcept
MimePart &	partData (std::string value) noexcept

Public Attributes
friend	MimePartOrList

Detailed Description

Structure representing a MIME part of a MIME email.

Definition at line 56 of file MimeEmail.h.

Member Enumeration Documentation

ApplyEncoding

enum class nawa::mail::MimeEmail::MimePart::ApplyEncoding

strong

Encodings which can be applied to the MIME part. Choose BASE64 for file attachments, and QUOTED_PRINTABLE for HTML, etc. Use NONE if and only if you made sure that the part contains only valid characters.

Enumerator
BASE64
QUOTED_PRINTABLE
NONE

Definition at line 64 of file MimeEmail.h.

Constructor & Destructor Documentation

~MimePart()

virtual nawa::mail::MimeEmail::MimePart::~MimePart ( )

virtual

MimePart() [1/3]

nawa::mail::MimeEmail::MimePart::MimePart

(

)

MimePart() [2/3]

nawa::mail::MimeEmail::MimePart::MimePart

(

MimePart const &

other

)

MimePart() [3/3]

nawa::mail::MimeEmail::MimePart::MimePart ( MimePart &&  other )

noexcept

Member Function Documentation

operator=() [1/2]

MimePart & nawa::mail::MimeEmail::MimePart::operator=

(

const MimePart &

other

)

operator=() [2/2]

MimePart & nawa::mail::MimeEmail::MimePart::operator= ( MimePart &&  other )

noexcept

contentType() [1/3]

std::string & nawa::mail::MimeEmail::MimePart::contentType ( )

noexcept

The Content-Type of this part (e.g., "text/plain; charset=utf-8").

contentType() [2/3]

std::string const & nawa::mail::MimeEmail::MimePart::contentType ( ) const

noexcept

contentType() [3/3]

MimePart & nawa::mail::MimeEmail::MimePart::contentType ( std::string  value )

noexcept

contentDisposition() [1/3]

std::string & nawa::mail::MimeEmail::MimePart::contentDisposition ( )

noexcept

The Content-Disposition part-header (e.g., "inline", or "attachment; filename=test.zip"). Optional, if this value is empty, the header will not be set.

contentDisposition() [2/3]

std::string const & nawa::mail::MimeEmail::MimePart::contentDisposition ( ) const

noexcept

contentDisposition() [3/3]

MimePart & nawa::mail::MimeEmail::MimePart::contentDisposition ( std::string  value )

noexcept

applyEncoding() [1/3]

ApplyEncoding & nawa::mail::MimeEmail::MimePart::applyEncoding ( )

noexcept

The encoding to apply to the MIME part, see nawa::MimeEmail::MimePart::ApplyEncoding. Default: quoted-printable.

applyEncoding() [2/3]

ApplyEncoding nawa::mail::MimeEmail::MimePart::applyEncoding ( ) const

noexcept

applyEncoding() [3/3]

MimePart & nawa::mail::MimeEmail::MimePart::applyEncoding ( ApplyEncoding  value )

noexcept

partHeaders() [1/3]

HeadersMap & nawa::mail::MimeEmail::MimePart::partHeaders ( )

noexcept

Additional headers for this MIME part (such as Content-ID) can be added here.

partHeaders() [2/3]

HeadersMap const & nawa::mail::MimeEmail::MimePart::partHeaders ( ) const

noexcept

partHeaders() [3/3]

MimePart & nawa::mail::MimeEmail::MimePart::partHeaders ( HeadersMap  value )

noexcept

allowReplacements() [1/3]

bool & nawa::mail::MimeEmail::MimePart::allowReplacements ( )

noexcept

Whether to allow replacements using ReplacementRules in the data of this MIME part. The replacements will be applied before the encoding. Default: false.

allowReplacements() [2/3]

bool nawa::mail::MimeEmail::MimePart::allowReplacements ( ) const

noexcept

allowReplacements() [3/3]

MimePart & nawa::mail::MimeEmail::MimePart::allowReplacements ( bool  value )

noexcept

partData() [1/3]

std::string & nawa::mail::MimeEmail::MimePart::partData ( )

noexcept

The data string, containing the body of the MIME part.

partData() [2/3]

std::string const & nawa::mail::MimeEmail::MimePart::partData ( ) const

noexcept

partData() [3/3]

MimePart & nawa::mail::MimeEmail::MimePart::partData ( std::string  value )

noexcept

Member Data Documentation

MimePartOrList

friend nawa::mail::MimeEmail::MimePart::MimePartOrList

Definition at line 115 of file MimeEmail.h.

---

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

• include/nawa/mail/Email/impl/MimeEmail.h