#include <viewemail.h>

Inheritance diagram for Cutelyst::ViewEmail:

[legend]

Public Types
enum	AuthMethod { AuthNone , AuthPlain , AuthLogin , AuthCramMd5 }
enum	ConnectionType { TcpConnection , SslConnection , TlsConnection }
Public Types inherited from Cutelyst::Component
enum	Modifier { None , OnlyExecute , BeforeExecute , AroundExecute , AfterExecute }

Signals
void	changed ()

Public Member Functions
	ViewEmail (QObject *parent, const QString &name=QString())
	Constructs a new ViewEmail object with the given `parent` and `name`.
bool	async () const
QByteArray	defaultCharset () const
QByteArray	defaultContentType () const
QByteArray	defaultEncoding () const
virtual QByteArray	render (Context *c) const override
AuthMethod	senderAuthMethod () const
ConnectionType	senderConnectionType () const
QString	senderHost () const
QString	senderPassword () const
int	senderPort () const
QString	senderUser () const
void	setAsync (bool enable)
void	setDefaultCharset (const QByteArray &charset)
void	setDefaultContentType (const QByteArray &contentType)
void	setDefaultEncoding (const QByteArray &encoding)
void	setSenderAuthMethod (AuthMethod method)
void	setSenderConnectionType (ConnectionType ct)
void	setSenderHost (const QString &host)
void	setSenderPassword (const QString &password)
void	setSenderPort (int port)
void	setSenderUser (const QString &user)
void	setStashKey (const QString &stashKey)
QString	stashKey () const
Public Member Functions inherited from Cutelyst::View
	View (QObject *parent, const QString &name)
virtual Modifiers	modifiers () const override
void	setMinimalSizeToDeflate (qint32 minSize=-1)
Public Member Functions inherited from Cutelyst::Component
	Component (QObject *parent=nullptr)
bool	execute (Context *c)
virtual bool	init (Application *application, const QVariantHash &args)
QString	name () const
QString	reverse () const
void	setName (const QString &name)
void	setReverse (const QString &reverse)

Protected Member Functions
	ViewEmail (ViewEmailPrivate d, QObject parent, const QString &name=QString())
	Constructs a new ViewEmail object using the private class, `parent` and `name`.
Protected Member Functions inherited from Cutelyst::View
	View (ViewPrivate d, QObject parent, const QString &name)
	A derived class using pimpl should call this constructor, to reduce the number of memory allocations.
Protected Member Functions inherited from Cutelyst::Component
	Component (ComponentPrivate d, QObject parent=nullptr)
	A derived class using pimpl should call this constructor, to reduce the number of memory allocations.
virtual bool	afterExecute (Context *c)
void	applyRoles (const QStack< Component * > &roles)
virtual bool	aroundExecute (Context c, QStack< Component > stack)
virtual bool	beforeExecute (Context *c)
virtual bool	dispatcherReady (const Dispatcher dispatch, Controller controller)

Properties
bool	async
QByteArray	defaultCharset
QByteArray	defaultContentType
QByteArray	defaultEncoding
QString	stashKey

Detailed Description

ViewEmail is a Cutelyst::View handler that sends stash data via e-mail.

Definition at line 18 of file viewemail.h.

Member Enumeration Documentation

◆ AuthMethod

enum Cutelyst::ViewEmail::AuthMethod

This value defines which kind of authentication should be used

Definition at line 39 of file viewemail.h.

◆ ConnectionType

enum Cutelyst::ViewEmail::ConnectionType

This value defines which kind of connection should be used

Definition at line 31 of file viewemail.h.

Constructor & Destructor Documentation

◆ ViewEmail() [1/2]

ViewEmail::ViewEmail	(	QObject *	parent,
		const QString &	name = QString() )

explicit

◆ ViewEmail() [2/2]

ViewEmail::ViewEmail	(	ViewEmailPrivate *	d,
		QObject *	parent,
		const QString &	name = QString() )

protected

Definition at line 288 of file viewemail.cpp.

References Cutelyst::View::View(), and Cutelyst::Component::name().

Member Function Documentation

◆ async()

bool ViewEmail::async ( ) const

Returns true if async mode is on.

Definition at line 170 of file viewemail.cpp.

References ViewEmail().

◆ defaultCharset()

QByteArray ViewEmail::defaultCharset ( ) const

Returns the default charset for every MIME part with the content type text.

Definition at line 54 of file viewemail.cpp.

References ViewEmail().

◆ defaultContentType()

QByteArray ViewEmail::defaultContentType ( ) const

Returns the default content type (mime type).

Definition at line 41 of file viewemail.cpp.

References ViewEmail().

◆ defaultEncoding()

QByteArray ViewEmail::defaultEncoding ( ) const

Returns the default encoding set

Definition at line 67 of file viewemail.cpp.

References ViewEmail().

◆ render()

QByteArray ViewEmail::render ( Context * c ) const

overridevirtual

Renders the EMail

Implements Cutelyst::View.

Reimplemented in Cutelyst::ViewEmailTemplate.

Definition at line 196 of file viewemail.cpp.

References ViewEmail(), Cutelyst::Context::error(), and Cutelyst::Context::stash().

Referenced by Cutelyst::ViewEmailTemplate::render().

◆ senderAuthMethod()

ViewEmail::AuthMethod ViewEmail::senderAuthMethod ( ) const

Returns the authenticaion method of the SMTP server

Definition at line 125 of file viewemail.cpp.

References ViewEmail().

◆ senderConnectionType()

ViewEmail::ConnectionType ViewEmail::senderConnectionType ( ) const

Defines the connection type of the SMTP server

Definition at line 110 of file viewemail.cpp.

References ViewEmail().

◆ senderHost()

QString ViewEmail::senderHost ( ) const

Returns the hostname of the SMTP server

Definition at line 80 of file viewemail.cpp.

References ViewEmail().

◆ senderPassword()

QString ViewEmail::senderPassword ( ) const

Returns the password that will authenticate on the SMTP server

Definition at line 155 of file viewemail.cpp.

References ViewEmail().

◆ senderPort()

int ViewEmail::senderPort ( ) const

Returns the port of the SMTP server

Definition at line 95 of file viewemail.cpp.

References ViewEmail().

◆ senderUser()

QString ViewEmail::senderUser ( ) const

Returns the username that will authenticate on the SMTP server

Definition at line 140 of file viewemail.cpp.

References ViewEmail().

◆ setAsync()

void ViewEmail::setAsync ( bool enable )

Enable sending mails in async mode, it will use SimpleMail::Server class, and render() will always return true regardless of mail sending success.

Definition at line 176 of file viewemail.cpp.

References ViewEmail().

◆ setDefaultCharset()

void ViewEmail::setDefaultCharset ( const QByteArray & charset )

Defines the default charset for every MIME part with the content type text. According to RFC2049 a MIME part without a charset should be treated as US-ASCII by the mail client. If the charset is not set it won't be set for all MIME parts without an overridden one.

Definition at line 60 of file viewemail.cpp.

References ViewEmail().

◆ setDefaultContentType()

void ViewEmail::setDefaultContentType ( const QByteArray & contentType )

Defines the default content type (mime type).

Definition at line 47 of file viewemail.cpp.

References ViewEmail().

◆ setDefaultEncoding()

void ViewEmail::setDefaultEncoding ( const QByteArray & encoding )

Defines the default encoding to be used when sending mails

Definition at line 73 of file viewemail.cpp.

References ViewEmail().

◆ setSenderAuthMethod()

void ViewEmail::setSenderAuthMethod ( ViewEmail::AuthMethod method )

Defines the authenticaion method of the SMTP server

Definition at line 131 of file viewemail.cpp.

References ViewEmail().

◆ setSenderConnectionType()

void ViewEmail::setSenderConnectionType ( ViewEmail::ConnectionType ct )

Returns the username that will authenticate on the SMTP server

Definition at line 116 of file viewemail.cpp.

References ViewEmail().

◆ setSenderHost()

void ViewEmail::setSenderHost ( const QString & host )

Defines the hostname of the SMTP server

Definition at line 86 of file viewemail.cpp.

References ViewEmail().

◆ setSenderPassword()

void ViewEmail::setSenderPassword ( const QString & password )

Defines the password that will authenticate on the SMTP server

Definition at line 161 of file viewemail.cpp.

References ViewEmail().

◆ setSenderPort()

void ViewEmail::setSenderPort ( int port )

Defines the port of the SMTP server

Definition at line 101 of file viewemail.cpp.

References ViewEmail().

◆ setSenderUser()

void ViewEmail::setSenderUser ( const QString & user )

Defines the username that will authenticate on the SMTP server

Definition at line 146 of file viewemail.cpp.

References ViewEmail().

◆ setStashKey()

void ViewEmail::setStashKey ( const QString & stashKey )

Defines the stash key that will contain the email data

Definition at line 34 of file viewemail.cpp.

References ViewEmail().

◆ stashKey()

QString ViewEmail::stashKey ( ) const

Returns the stash key that will contain the email data

Definition at line 28 of file viewemail.cpp.

References ViewEmail().

Property Documentation

◆ async

bool Cutelyst::ViewEmail::async

readwrite

Definition at line 28 of file viewemail.h.

◆ defaultCharset

QByteArray Cutelyst::ViewEmail::defaultCharset

readwrite

Definition at line 25 of file viewemail.h.

◆ defaultContentType

QByteArray Cutelyst::ViewEmail::defaultContentType

readwrite

Definition at line 23 of file viewemail.h.

◆ defaultEncoding

QByteArray Cutelyst::ViewEmail::defaultEncoding

readwrite

Definition at line 26 of file viewemail.h.

◆ stashKey

QString Cutelyst::ViewEmail::stashKey

readwrite

Definition at line 22 of file viewemail.h.

Public Types

Signals

Public Member Functions

Protected Member Functions

Properties

Detailed Description

Member Enumeration Documentation

◆ AuthMethod

◆ ConnectionType

Constructor & Destructor Documentation

◆ ViewEmail() [1/2]

◆ ViewEmail() [2/2]

Member Function Documentation

◆ async()

◆ defaultCharset()

◆ defaultContentType()

◆ defaultEncoding()

◆ render()

◆ senderAuthMethod()

◆ senderConnectionType()

◆ senderHost()

◆ senderPassword()

◆ senderPort()

◆ senderUser()

◆ setAsync()

◆ setDefaultCharset()

◆ setDefaultContentType()

◆ setDefaultEncoding()

◆ setSenderAuthMethod()

◆ setSenderConnectionType()

◆ setSenderHost()

◆ setSenderPassword()

◆ setSenderPort()

◆ setSenderUser()

◆ setStashKey()

◆ stashKey()

Property Documentation

◆ async

◆ defaultCharset

◆ defaultContentType

◆ defaultEncoding

◆ stashKey