A view that renders stash data using another view and sends it via e-mail. More...

#include <Cutelyst/Plugins/View/Email/viewemailtemplate.h>

Inheritance diagram for Cutelyst::ViewEmailTemplate:

[legend]

Signals
void	changedProp ()
Signals inherited from Cutelyst::ViewEmail
void	changed ()

Public Member Functions
	ViewEmailTemplate (QObject *parent, const QString &name=QString())
QString	defaultView () const
QByteArray	render (Context *c) const override
void	setDefaultView (const QString &view)
void	setTemplatePrefix (const QString &prefix)
QString	templatePrefix () const
Public Member Functions inherited from Cutelyst::ViewEmail
	ViewEmail (QObject *parent, const QString &name=QString())
QByteArray	defaultCharset () const
QByteArray	defaultContentType () const
QByteArray	defaultEncoding () const
AuthMethod	senderAuthMethod () const
ConnectionType	senderConnectionType () const
QString	senderHost () const
QString	senderPassword () const
int	senderPort () const
QString	senderUser () const
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	~View () override=default
Modifiers	modifiers () const override
void	setMinimalSizeToDeflate (qint32 minSize=-1)
Public Member Functions inherited from Cutelyst::Component
	Component (QObject *parent=nullptr)
virtual	~Component () override
bool	execute (Context *c)
virtual bool	init (Application *application, const QVariantHash &args)
QString	name () const noexcept
QString	reverse () const noexcept
void	setName (const QString &name)
void	setReverse (const QString &reverse)
Public Member Functions inherited from QObject
	QObject (QObject *parent)
QBindable< QString >	bindableObjectName ()
bool	blockSignals (bool block)
const QObjectList &	children () const const
QMetaObject::Connection	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const char signal, const QObject receiver, const char *method) const const
bool	disconnect (const QObject receiver, const char method) const const
void	dumpObjectInfo () const const
void	dumpObjectTree () const const
QList< QByteArray >	dynamicPropertyNames () const const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject watched, QEvent event)
T	findChild (QAnyStringView name, Qt::FindChildOptions options) const const
T	findChild (Qt::FindChildOptions options) const const
QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
QList< T >	findChildren (QAnyStringView name, Qt::FindChildOptions options) const const
QList< T >	findChildren (Qt::FindChildOptions options) const const
bool	inherits (const char *className) const const
void	installEventFilter (QObject *filterObj)
bool	isQmlExposed () const const
bool	isQuickItemType () const const
bool	isWidgetType () const const
bool	isWindowType () const const
void	killTimer (int id)
void	killTimer (Qt::TimerId id)
virtual const QMetaObject *	metaObject () const const
bool	moveToThread (QThread *targetThread)
QString	objectName () const const
void	objectNameChanged (const QString &objectName)
QObject *	parent () const const
QVariant	property (const char *name) const const
	Q_CLASSINFO (Name, Value)
	Q_EMIT Q_EMIT
	Q_ENUM (...)
	Q_ENUM_NS (...)
	Q_ENUMS (...)
	Q_FLAG (...)
	Q_FLAG_NS (...)
	Q_FLAGS (...)
	Q_GADGET Q_GADGET
	Q_GADGET_EXPORT (EXPORT_MACRO)
	Q_INTERFACES (...)
	Q_INVOKABLE Q_INVOKABLE
	Q_MOC_INCLUDE Q_MOC_INCLUDE
	Q_NAMESPACE Q_NAMESPACE
	Q_NAMESPACE_EXPORT (EXPORT_MACRO)
	Q_OBJECT Q_OBJECT
	Q_PROPERTY (...)
	Q_REVISION Q_REVISION
	Q_SET_OBJECT_NAME (Object)
	Q_SIGNAL Q_SIGNAL
	Q_SIGNALS Q_SIGNALS
	Q_SLOT Q_SLOT
	Q_SLOTS Q_SLOTS
T	qobject_cast (const QObject *object)
T	qobject_cast (QObject *object)
	QT_NO_CONTEXTLESS_CONNECT QT_NO_CONTEXTLESS_CONNECT
	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
void	removeEventFilter (QObject *obj)
void	setObjectName (const QString &name)
void	setObjectName (QAnyStringView name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	setProperty (const char *name, QVariant &&value)
bool	signalsBlocked () const const
int	startTimer (int interval, Qt::TimerType timerType)
int	startTimer (std::chrono::nanoseconds interval, Qt::TimerType timerType)
QThread *	thread () const const

Properties
QString	defaultView
QString	templatePrefix
Properties inherited from Cutelyst::ViewEmail
QByteArray	defaultCharset
QByteArray	defaultContentType
QByteArray	defaultEncoding
QString	stashKey
Properties inherited from QObject
	objectName

Additional Inherited Members
Public Types inherited from Cutelyst::ViewEmail
enum	AuthMethod { AuthNone , AuthPlain , AuthLogin , AuthCramMd5 }
enum	ConnectionType { TcpConnection , SslConnection , TlsConnection }
Public Types inherited from Cutelyst::Component
enum	Modifier { None , OnlyExecute , BeforeExecute , AroundExecute , AfterExecute }
Public Types inherited from QObject
enum	TimerId
Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject context, Functor functor, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
bool	disconnect (const QMetaObject::Connection &connection)
bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)
bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)
bool	disconnect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method)
QString	tr (const char sourceText, const char disambiguation, int n)
Public Attributes inherited from QObject
	Invalid
typedef	QObjectList
Protected Member Functions inherited from Cutelyst::ViewEmail
	ViewEmail (ViewEmailPrivate d, QObject parent, const QString &name=QString())
Protected Member Functions inherited from Cutelyst::View
	View (ViewPrivate d, QObject parent, const QString &name)
Protected Member Functions inherited from Cutelyst::Component
	Component (ComponentPrivate d, QObject parent=nullptr)
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)
Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)
virtual void	connectNotify (const QMetaMethod &signal)
virtual void	customEvent (QEvent *event)
virtual void	disconnectNotify (const QMetaMethod &signal)
bool	isSignalConnected (const QMetaMethod &signal) const const
int	receivers (const char *signal) const const
QObject *	sender () const const
int	senderSignalIndex () const const
virtual void	timerEvent (QTimerEvent *event)

Detailed Description

ViewEmailTemplate is a View handler that renders Context::stash() data using another view and sends it via e-mail.

Logging category: cutelyst.view.emailtemplate
Logging with Cutelyst

Definition at line 25 of file viewemailtemplate.h.

Constructor & Destructor Documentation

◆ ViewEmailTemplate()

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

explicit

Constructs a new ViewEmailTemplate object with the given parent and name.

The name can be used to specify different views that can be called either dynamically by Context::setCustomView() or with the :View() argument of the RenderView action.

Definition at line 18 of file viewemailtemplate.cpp.

References Cutelyst::ViewEmail::ViewEmail(), ViewEmailTemplate(), Cutelyst::Component::name(), and QObject::parent().

Referenced by ViewEmailTemplate(), defaultView(), render(), setDefaultView(), setTemplatePrefix(), and templatePrefix().

Member Function Documentation

◆ defaultView()

QString ViewEmailTemplate::defaultView ( ) const

nodiscard

Returns the name of the default view used to render the templates.

See also: setDefaultView()

Definition at line 39 of file viewemailtemplate.cpp.

References ViewEmailTemplate().

◆ render()

QByteArray ViewEmailTemplate::render ( Context * c ) const

overridevirtual

Renders and sends the email. This will always return an emty byte array, regardless of mail sending success.

Reimplemented from Cutelyst::ViewEmail.

Definition at line 107 of file viewemailtemplate.cpp.

References ViewEmailTemplate(), QVariant::fromValue(), QString::insert(), QString::isEmpty(), QMetaType::QVariantHash, Cutelyst::ViewEmail::render(), Cutelyst::Context::setStash(), and Cutelyst::Context::stash().

◆ setDefaultView()

void ViewEmailTemplate::setDefaultView ( const QString & view )

Defines the default view used to render the templates. If none is specified, neither here nor in the stash, Cutelysts default view is used.

Warning: If you don’t tell Cutelyst explicit which of your views should be its default one, this class may choose the wrong one!

See also: defaultView()

Definition at line 45 of file viewemailtemplate.cpp.

References ViewEmailTemplate(), and QObject::Q_EMIT().

◆ setTemplatePrefix()

void ViewEmailTemplate::setTemplatePrefix ( const QString & prefix )

Defines the optional prefix to look somewhere under the existing configured template paths of the used view. This will be prepended to your template file name in the form prefix + / + template.

See also: templatePrefix()

Definition at line 32 of file viewemailtemplate.cpp.

References ViewEmailTemplate(), and QObject::Q_EMIT().

◆ templatePrefix()

QString ViewEmailTemplate::templatePrefix ( ) const

nodiscard

Returns the optional prefix to look somewhere under the existing configured template paths of the used view. This will be prepended to your template file name in the form prefix + / + template.

See also: setTemplatePrefix()

Definition at line 26 of file viewemailtemplate.cpp.

References ViewEmailTemplate().

Property Documentation

◆ defaultView

QString Cutelyst::ViewEmailTemplate::defaultView

readwrite

The name of the default view used to render the templates.

Definition at line 38 of file viewemailtemplate.h.

◆ templatePrefix

QString Cutelyst::ViewEmailTemplate::templatePrefix

readwrite

The optional prefix to look somewhere under the existing configured template paths of the used view. This will be prepended to your template file name in the form prefix + / + template.

Definition at line 34 of file viewemailtemplate.h.

Signals

Public Member Functions

Properties

Additional Inherited Members