Cutelyst  1.8.0
Public Types | Public Member Functions | Protected Member Functions | Properties | List of all members
Cutelyst::ViewEmail Class Reference

#include <viewemail.h>

Inheritance diagram for Cutelyst::ViewEmail:
Inheritance graph
[legend]

Public Types

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

Public Member Functions

 ViewEmail (QObject *parent, const QString &name=QString())
 Constructs a new ViewEmail object with the given parent and name.
 
QByteArray defaultCharset () const
 
QByteArray defaultContentType () const
 
QByteArray defaultEncoding () const
 
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 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
 
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::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)
 

Properties

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 33 of file viewemail.h.

Member Enumeration Documentation

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.

Member Function Documentation

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

QByteArray Cutelyst::ViewEmail::render ( Context c) const
overridevirtual

Renders the EMail

Implements Cutelyst::View.

Reimplemented in Cutelyst::ViewEmailTemplate.

AuthMethod Cutelyst::ViewEmail::senderAuthMethod ( ) const

Returns the authenticaion method of the SMTP server

ConnectionType Cutelyst::ViewEmail::senderConnectionType ( ) const

Defines the connection type of the SMTP server

QString Cutelyst::ViewEmail::senderHost ( ) const

Returns the hostname of the SMTP server

QString Cutelyst::ViewEmail::senderPassword ( ) const

Returns the password that will authenticate on the SMTP server

int Cutelyst::ViewEmail::senderPort ( ) const

Returns the port of the SMTP server

QString Cutelyst::ViewEmail::senderUser ( ) const

Returns the username that will authenticate on the SMTP server

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

void Cutelyst::ViewEmail::setDefaultContentType ( const QByteArray &  contentType)

Defines the default content type (mime type).

void Cutelyst::ViewEmail::setDefaultEncoding ( const QByteArray &  encoding)

Defines the default encoding to be used when sending mails

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

Defines the authenticaion method of the SMTP server

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

Returns the username that will authenticate on the SMTP server

void Cutelyst::ViewEmail::setSenderHost ( const QString &  host)

Defines the hostname of the SMTP server

void Cutelyst::ViewEmail::setSenderPassword ( const QString &  password)

Defines the password that will authenticate on the SMTP server

void Cutelyst::ViewEmail::setSenderPort ( int  port)

Defines the port of the SMTP server

void Cutelyst::ViewEmail::setSenderUser ( const QString &  user)

Defines the username that will authenticate on the SMTP server

void Cutelyst::ViewEmail::setStashKey ( const QString &  stashKey)

Defines the stash key that will contain the email data

QString Cutelyst::ViewEmail::stashKey ( ) const

Returns the stash key that will contain the email data