Cutelyst  1.5.0
Public Member Functions | Properties | List of all members
Cutelyst::ViewEmailTemplate Class Reference

#include <viewemailtemplate.h>

Inheritance diagram for Cutelyst::ViewEmailTemplate:
Inheritance graph

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=QString())
virtual Modifiers modifiers () const override
QString name () const
- 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
 name More...
QString reverse () const
 name More...
void setName (const QString &name)
void setReverse (const QString &reverse)


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

Additional Inherited Members

- Public Types inherited from Cutelyst::ViewEmail
enum  AuthMethod { AuthNone, AuthPlain, AuthLogin }
enum  ConnectionType { TcpConnection, SslConnection, TlsConnection }
- Public Types inherited from Cutelyst::Component
enum  Modifier {
  None, OnlyExecute, BeforeExecute, AroundExecute,
- Protected Member Functions inherited from Cutelyst::ViewEmail
 ViewEmail (ViewEmailPrivate *d, QObject *parent, const QString &name=QString())
- Protected Member Functions inherited from Cutelyst::Component
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 Attributes inherited from Cutelyst::ViewEmail
ViewEmailPrivate * d_ptr
- Protected Attributes inherited from Cutelyst::Component
ComponentPrivate * d_ptr

Detailed Description

ViewEmailTemplate is a Cutelyst::View handler that renders stash data using another view and send the result via e-mail.

Definition at line 33 of file viewemailtemplate.h.

Member Function Documentation

QString Cutelyst::ViewEmailTemplate::defaultView ( ) const

Returns the default view used to render the templates.

QByteArray Cutelyst::ViewEmailTemplate::render ( Context c) const

All subclasses must reimplement this when doing it's rendering. If an error (c->error()) is not set c->response()->body() is defined with the returned value, this is useful if the view is not meant to be used as a body.

Reimplemented from Cutelyst::ViewEmail.

void Cutelyst::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!

void Cutelyst::ViewEmailTemplate::setTemplatePrefix ( const QString &  prefix)

Defines the optional prefix to look somewhere under the existing configured template paths.

QString Cutelyst::ViewEmailTemplate::templatePrefix ( ) const

Returns the optional prefix to look somewhere under the existing configured template paths.