API Documentation
Back to top  

EmailConfigurationProvider

Class EmailConfigurationProvider

package

Default

Methods

EmailConfigurationProvider constructor.

__construct(\CI_DB_query_builder $db)

Arguments

$db

\CI_DB_query_builder

Returns the email configuration value for the given key.

_getEmailConfig(string $key) : string

The configuration value will be read from the configurations table.

Arguments

$key

string

Key of expected configuration value.

Response

string

Configuration value of given key.

Returns the smtp auth configuration value.

auth() : string

Response

string

Configuration value of emails smtp auth.

Returns the smtp backup server configuration value.

backupServer() : string

Response

string

Configuration value of emails smtp backup server.

Returns the charset configuration value for emails.

charset() : string

$_SESSION['language_charset'] will be used if it is set. If not, the charset of the default shop language is taken.

Response

string

Returns the default language configuration value.

defaultLanguage() : string

Response

string

Configuration value of default language.

Returns the email transport configuration value.

emailTransport() : string

Response

string

Configuration value of email transport.

Returns the smtp encryption configuration value.

encryption() : string

Response

string

Configuration value of emails smtp encryption.

Returns the language code configuration value.

languageCode() : string

The code is 'de', if $_SESSION['language'] is equal to 'german'. Any other case will return en.

Response

string

Returns the smtp main server configuration value.

mainServer() : string

Response

string

Configuration value of emails smtp main server.

Returns the smtp password configuration value.

password() : string

Response

string

Configuration value of emails smtp password.

Returns the smtp port configuration value.

port() : string

Response

string

Configuration value of emails smtp port.

Returns the send mail path configuration value.

sendMailPath() : string

Response

string

Configuration value of send mail path.

Returns true if html emails should be used.

useHtmlMail() : boolean

The configuration value will be read from configuration table.

Response

boolean

Returns the smtp user configuration value.

user() : string

Response

string

Configuration value of emails smtp username.

Properties

db

db : \CI_DB_query_builder
var

Type(s)

\CI_DB_query_builder

table

table : string
var

Type(s)

string

keyField

keyField : string
var

Type(s)

string

valueField

valueField : string
var

Type(s)

string