Cutelyst
2.13.0
|
#include <viewemail.h>
Public Types | |
enum | AuthMethod { AuthNone, AuthPlain, AuthLogin, AuthCramMd5 } |
enum | ConnectionType { TcpConnection, SslConnection, TlsConnection } |
![]() | |
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 |
![]() | |
View (QObject *parent, const QString &name) | |
virtual Modifiers | modifiers () const override |
void | setMinimalSizeToDeflate (qint32 minSize=-1) |
![]() | |
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 . | |
![]() | |
View (ViewPrivate *d, QObject *parent, const QString &name) | |
A derived class using pimpl should call this constructor, to reduce the number of memory allocations. | |
![]() | |
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 |
ViewEmail is a Cutelyst::View handler that sends stash data via e-mail.
Definition at line 31 of file viewemail.h.
This value defines which kind of authentication should be used
Definition at line 51 of file viewemail.h.
This value defines which kind of connection should be used
Definition at line 42 of file viewemail.h.
bool Cutelyst::ViewEmail::async | ( | ) | const |
Returns true if async mode is on.
QByteArray Cutelyst::ViewEmail::defaultCharset | ( | ) | const |
Returns the default charset for every MIME part with the content type text.
QByteArray Cutelyst::ViewEmail::defaultContentType | ( | ) | const |
Returns the default content type (mime type).
QByteArray Cutelyst::ViewEmail::defaultEncoding | ( | ) | const |
Returns the default encoding set
|
overridevirtual |
Renders the EMail
Implements Cutelyst::View.
Reimplemented in Cutelyst::ViewEmailTemplate.
Definition at line 208 of file viewemail.cpp.
References Cutelyst::Context::error(), and Cutelyst::Context::stash().
Referenced by Cutelyst::ViewEmailTemplate::render().
ViewEmail::AuthMethod ViewEmail::senderAuthMethod | ( | ) | const |
Returns the authenticaion method of the SMTP server
Definition at line 138 of file viewemail.cpp.
ViewEmail::ConnectionType ViewEmail::senderConnectionType | ( | ) | const |
Defines the connection type of the SMTP server
Definition at line 123 of file viewemail.cpp.
QString ViewEmail::senderHost | ( | ) | const |
Returns the hostname of the SMTP server
Definition at line 93 of file viewemail.cpp.
QString ViewEmail::senderPassword | ( | ) | const |
Returns the password that will authenticate on the SMTP server
Definition at line 168 of file viewemail.cpp.
int ViewEmail::senderPort | ( | ) | const |
Returns the port of the SMTP server
Definition at line 108 of file viewemail.cpp.
QString ViewEmail::senderUser | ( | ) | const |
Returns the username that will authenticate on the SMTP server
Definition at line 153 of file viewemail.cpp.
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 189 of file viewemail.cpp.
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 73 of file viewemail.cpp.
void ViewEmail::setDefaultContentType | ( | const QByteArray & | contentType | ) |
Defines the default content type (mime type).
Definition at line 60 of file viewemail.cpp.
void ViewEmail::setDefaultEncoding | ( | const QByteArray & | encoding | ) |
Defines the default encoding to be used when sending mails
Definition at line 86 of file viewemail.cpp.
void ViewEmail::setSenderAuthMethod | ( | ViewEmail::AuthMethod | method | ) |
Defines the authenticaion method of the SMTP server
Definition at line 144 of file viewemail.cpp.
void ViewEmail::setSenderConnectionType | ( | ViewEmail::ConnectionType | ct | ) |
Returns the username that will authenticate on the SMTP server
Definition at line 129 of file viewemail.cpp.
void ViewEmail::setSenderHost | ( | const QString & | host | ) |
Defines the hostname of the SMTP server
Definition at line 99 of file viewemail.cpp.
void ViewEmail::setSenderPassword | ( | const QString & | password | ) |
Defines the password that will authenticate on the SMTP server
Definition at line 174 of file viewemail.cpp.
void ViewEmail::setSenderPort | ( | int | port | ) |
Defines the port of the SMTP server
Definition at line 114 of file viewemail.cpp.
void ViewEmail::setSenderUser | ( | const QString & | user | ) |
Defines the username that will authenticate on the SMTP server
Definition at line 159 of file viewemail.cpp.
void ViewEmail::setStashKey | ( | const QString & | stashKey | ) |
Defines the stash key that will contain the email data
Definition at line 47 of file viewemail.cpp.
QString Cutelyst::ViewEmail::stashKey | ( | ) | const |
Returns the stash key that will contain the email data