#include <viewemailtemplate.h>
Signals | |
| void | changedProp () |
 Signals inherited from Cutelyst::ViewEmail | |
| void | changed () |
Public Member Functions | |
| ViewEmailTemplate (QObject *parent, const QString &name=QString()) | |
Constructs a new ViewEmailTemplate object with the given parent and name. | |
| QString | defaultView () const |
| virtual 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()) | |
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 |
| virtual QByteArray | render (Context *c) const =0 |
| 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) |
| virtual Modifiers | modifiers () const |
| QString | name () const |
| QString | reverse () const |
| void | setName (const QString &name) |
| void | setReverse (const QString &reverse) |
Properties | |
| QString | defaultView |
| QString | templatePrefix |
| Properties inherited from Cutelyst::ViewEmail | |
| bool | async |
| QByteArray | defaultCharset |
| QByteArray | defaultContentType |
| QByteArray | defaultEncoding |
| QString | stashKey |
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 } |
| Protected Member Functions inherited from Cutelyst::ViewEmail | |
| 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) |
| virtual bool | doExecute (Context *c) |
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 19 of file viewemailtemplate.h.
Constructor & Destructor Documentation
◆ ViewEmailTemplate()
|
explicit |
Definition at line 18 of file viewemailtemplate.cpp.
Member Function Documentation
◆ defaultView()
| QString ViewEmailTemplate::defaultView | ( | ) | const |
Returns the default view used to render the templates.
Definition at line 39 of file viewemailtemplate.cpp.
◆ render()
|
overridevirtual |
Renders the EMail
Reimplemented from Cutelyst::ViewEmail.
Definition at line 106 of file viewemailtemplate.cpp.
References 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!
Definition at line 45 of file viewemailtemplate.cpp.
◆ setTemplatePrefix()
| void ViewEmailTemplate::setTemplatePrefix | ( | const QString & | prefix | ) |
Defines the optional prefix to look somewhere under the existing configured template paths.
Definition at line 32 of file viewemailtemplate.cpp.
◆ templatePrefix()
| QString ViewEmailTemplate::templatePrefix | ( | ) | const |
Returns the optional prefix to look somewhere under the existing configured template paths.
Definition at line 26 of file viewemailtemplate.cpp.
Property Documentation
◆ defaultView
|
readwrite |
Definition at line 19 of file viewemailtemplate.h.
◆ templatePrefix
|
readwrite |
Definition at line 19 of file viewemailtemplate.h.
