Class MailServiceConfig

__construct()

__construct() 

Constructs a AbstractConfigData object

• Inherited from \AbstractConfigData

Tags

None found

synchronize()

synchronize() 

This method is not used in the configuration context.

{@inheritdoc}

final

• Inherited from \AbstractConfigData

Tags

None found

set_default_values()

set_default_values() 

Redefine this method if you want to avoid getting errors while asking values.

If some entries doesn't exist, they can be created here.

• Inherited from \AbstractConfigData

Tags

None found

get_property()

get_property(string $name) : string

Reads a property's value.

Parameters

string

$name

Name of the property to read

Returns

string —

the read value

• Inherited from \AbstractConfigData

Tags

None found

set_property()

set_property(string $name, string $value) 

Sets a property value. If the property exists, it overrides its value, otherwise, it creates an entry for this property.

Parameters

string	$name	Name of the property
string	$value	Value of the property

• Inherited from \AbstractConfigData

Tags

None found

get_default_values()

get_default_values() : \string[mixed]

Returns a map associating to each property name the corresponding default value

Returns

\string[mixed]

• Inherited from \MailServiceConfig

Tags

None found

get_default_mail_sender()

get_default_mail_sender() 

• Inherited from \MailServiceConfig

Tags

None found

set_default_mail_sender()

set_default_mail_sender( $sender) 

Parameters

$sender

• Inherited from \MailServiceConfig

Tags

None found

get_administrators_mails()

get_administrators_mails() 

• Inherited from \MailServiceConfig

Tags

None found

set_administrators_mails()

set_administrators_mails(array $mails) 

Parameters

array

$mails

• Inherited from \MailServiceConfig

Tags

None found

get_mail_signature()

get_mail_signature() 

• Inherited from \MailServiceConfig

Tags

None found

set_mail_signature()

set_mail_signature( $signature) 

Parameters

$signature

• Inherited from \MailServiceConfig

Tags

None found

is_smtp_enabled()

is_smtp_enabled() 

• Inherited from \MailServiceConfig

Tags

None found

enable_smtp()

enable_smtp() 

• Inherited from \MailServiceConfig

Tags

None found

disable_smtp()

disable_smtp() 

• Inherited from \MailServiceConfig

Tags

None found

get_smtp_host()

get_smtp_host() 

• Inherited from \MailServiceConfig

Tags

None found

set_smtp_host()

set_smtp_host( $host) 

Parameters

$host

• Inherited from \MailServiceConfig

Tags

None found

get_smtp_port()

get_smtp_port() 

• Inherited from \MailServiceConfig

Tags

None found

set_smtp_port()

set_smtp_port( $port) 

Parameters

$port

• Inherited from \MailServiceConfig

Tags

None found

get_smtp_login()

get_smtp_login() 

• Inherited from \MailServiceConfig

Tags

None found

set_smtp_login()

set_smtp_login( $login) 

Parameters

$login

• Inherited from \MailServiceConfig

Tags

None found

get_smtp_password()

get_smtp_password() 

• Inherited from \MailServiceConfig

Tags

None found

set_smtp_password()

set_smtp_password( $password) 

Parameters

$password

• Inherited from \MailServiceConfig

Tags

None found

get_smtp_protocol()

get_smtp_protocol() 

• Inherited from \MailServiceConfig

Tags

None found

set_smtp_protocol()

set_smtp_protocol( $protocol) 

Parameters

$protocol

• Inherited from \MailServiceConfig

Tags

None found

to_smtp_config()

to_smtp_config() : \SMTPConfiguration

Returns

\SMTPConfiguration

• Inherited from \MailServiceConfig

Tags

None found

load()

load() : \MailServiceConfig

Returns the configuration.

Returns

\MailServiceConfig

static

• Inherited from \MailServiceConfig

Tags

None found

save()

save() 

Saves the configuration in the database. Has it become persistent.

static

• Inherited from \MailServiceConfig

Tags

None found

get_default_value()

get_default_value( $property) 

Parameters

$property

• Inherited from \AbstractConfigData

Tags

None found