File phpboost/config/MailServiceConfig.class.php

  1:   2:   3:   4:   5:   6:   7:   8:   9:  10:  11:  12:  13:  14:  15:  16:  17:  18:  19:  20:  21:  22:  23:  24:  25:  26:  27:  28:  29:  30:  31:  32:  33:  34:  35:  36:  37:  38:  39:  40:  41:  42:  43:  44:  45:  46:  47:  48:  49:  50:  51:  52:  53:  54:  55:  56:  57:  58:  59:  60:  61:  62:  63:  64:  65:  66:  67:  68:  69:  70:  71:  72:  73:  74:  75:  76:  77:  78:  79:  80:  81:  82:  83:  84:  85:  86:  87:  88:  89:  90:  91:  92:  93:  94:  95:  96:  97:  98:  99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: 124: 125: 126: 127: 128: 129: 130: 131: 132: 133: 134: 135: 136: 137: 138: 139: 140: 141: 142: 143: 144: 145: 146: 147: 148: 149: 150: 151: 152: 153: 154: 155: 156: 157: 158: 159: 160: 161: 162: 163: 164: 165: 166: 167: 168: 

<?php
/**
 * This class contains the configuration of PHPBoost's mail service.
 * @package     PHPBoost
 * @subpackage  Config
 * @copyright   &copy; 2005-2019 PHPBoost
 * @license     https://www.gnu.org/licenses/gpl-3.0.html GNU/GPL-3.0
 * @author      Benoit SAUTEL <ben.popeye@phpboost.com>
 * @version     PHPBoost 5.2 - last update: 2014 12 22
 * @since       PHPBoost 3.0 - 2010 04 13
*/

class MailServiceConfig extends AbstractConfigData
{
    public function get_default_mail_sender()
    {
        return $this->get_property('default_mail_sender');
    }

    public function set_default_mail_sender($sender)
    {
        $this->set_property('default_mail_sender', $sender);
    }

    public function get_administrators_mails()
    {
        return $this->get_property('administrators_mails');
    }

    public function set_administrators_mails(array $mails)
    {
        $this->set_property('administrators_mails', $mails);
    }

    public function get_mail_signature()
    {
        return $this->get_property('mail_signature');
    }

    public function set_mail_signature($signature)
    {
        $this->set_property('mail_signature', $signature);
    }

    public function is_smtp_enabled()
    {
        return $this->get_property('use_smtp');
    }

    public function enable_smtp()
    {
        return $this->set_property('use_smtp', true);
    }

    public function disable_smtp()
    {
        $this->set_property('use_smtp', false);
    }

    public function get_smtp_host()
    {
        return $this->get_property('smtp_host');
    }

    public function set_smtp_host($host)
    {
        $this->set_property('smtp_host', $host);
    }

    public function get_smtp_port()
    {
        return $this->get_property('smtp_port');
    }

    public function set_smtp_port($port)
    {
        $this->set_property('smtp_port', $port);
    }

    public function get_smtp_login()
    {
        return $this->get_property('smtp_login');
    }

    public function set_smtp_login($login)
    {
        $this->set_property('smtp_login', $login);
    }

    public function get_smtp_password()
    {
        return $this->get_property('smtp_password');
    }

    public function set_smtp_password($password)
    {
        $this->set_property('smtp_password', $password);
    }

    public function get_smtp_protocol()
    {
        return $this->get_property('smtp_protocol');
    }

    public function set_smtp_protocol($protocol)
    {
        $this->set_property('smtp_protocol', $protocol);
    }

    /**
     * {@inheritdoc}
     */
    public function get_default_values()
    {
        //TODO Add mail signature lang
        return array(
            'use_smtp' => false,
            'smtp_host' => '',
            'smtp_port' => 25,
            'smtp_login' => '',
            'smtp_password' => '',
            'smtp_protocol' => 'none',
            'default_mail_sender' => '',
            'administrators_mails' => array(),
            'mail_signature' => ''
        );
    }

    /**
     * @return SMTPConfiguration
     */
    public function to_smtp_config()
    {
        if ($this->is_smtp_enabled())
        {
            $config = new SMTPConfiguration();
            $config->set_host($this->get_smtp_host());
            $config->set_port($this->get_smtp_port());
            $config->set_login($this->get_smtp_login());
            $config->set_password($this->get_smtp_password());
            $config->set_auth_mode($this->get_smtp_protocol());
            return $config;
        }
        else
        {
            return null;
        }
    }

    /**
     * Returns the configuration.
     * @return MailServiceConfig
     */
    public static function load()
    {
        return ConfigManager::load(__CLASS__, 'kernel', 'mail-service');
    }

    /**
     * Saves the configuration in the database. Has it become persistent.
     */
    public static function save()
    {
        ConfigManager::save('kernel', self::load(), 'mail-service');
    }
}
?>