snappymail/plugins/override-smtp-credentials/index.php
2023-01-19 10:55:01 +01:00

103 lines
4 KiB
PHP

<?php
class OverrideSmtpCredentialsPlugin extends \RainLoop\Plugins\AbstractPlugin
{
const
NAME = 'Override SMTP Credentials',
VERSION = '2.4',
RELEASE = '2023-01-19',
REQUIRED = '2.23.0',
CATEGORY = 'Filters',
DESCRIPTION = 'Override SMTP credentials for specific users.';
public function Init() : void
{
$this->addHook('smtp.before-connect', 'FilterSmtpConnect');
$this->addHook('smtp.before-login', 'FilterSmtpCredentials');
}
/**
* @param \RainLoop\Model\Account $oAccount
* @param \MailSo\Smtp\SmtpClient $oSmtpClient
* @param \MailSo\Smtp\Settings $oSettings
*/
public function FilterSmtpConnect(\RainLoop\Model\Account $oAccount, \MailSo\Smtp\SmtpClient $oSmtpClient, \MailSo\Smtp\Settings $oSettings)
{
$sEmail = $oAccount->Email();
$sWhiteList = \trim($this->Config()->Get('plugin', 'override_users', ''));
$sFoundValue = '';
if (\strlen($sWhiteList) && \RainLoop\Plugins\Helper::ValidateWildcardValues($sEmail, $sWhiteList, $sFoundValue)) {
\SnappyMail\LOG::debug('SMTP Override', "{$sEmail} matched {$sFoundValue}");
$oSettings->usePhpMail = false;
$sHost = \trim($this->Config()->Get('plugin', 'smtp_host', ''));
if (\strlen($sHost)) {
$oSettings->host = $sHost;
$oSettings->port = (int) $this->Config()->Get('plugin', 'smtp_port', 25);
$sSecure = \trim($this->Config()->Get('plugin', 'smtp_secure', 'None'));
switch ($sSecure)
{
case 'SSL':
$oSettings->type = MailSo\Net\Enumerations\ConnectionSecurityType::SSL;
break;
case 'TLS':
case 'STARTTLS':
$oSettings->type = MailSo\Net\Enumerations\ConnectionSecurityType::STARTTLS;
break;
case 'Detect':
$oSettings->type = MailSo\Net\Enumerations\ConnectionSecurityType::AUTO_DETECT;
break;
default:
$oSettings->type = MailSo\Net\Enumerations\ConnectionSecurityType::NONE;
break;
}
}
} else {
\SnappyMail\LOG::debug('SMTP Override', "{$sEmail} no match");
}
}
/**
* @param \RainLoop\Model\Account $oAccount
* @param \MailSo\Smtp\SmtpClient $oSmtpClient
* @param \MailSo\Smtp\Settings $oSettings
*/
public function FilterSmtpCredentials(\RainLoop\Model\Account $oAccount, \MailSo\Smtp\SmtpClient $oSmtpClient, \MailSo\Smtp\Settings $oSettings)
{
$sWhiteList = \trim($this->Config()->Get('plugin', 'override_users', ''));
$sFoundValue = '';
if (\strlen($sWhiteList) && \RainLoop\Plugins\Helper::ValidateWildcardValues($oAccount->Email(), $sWhiteList, $sFoundValue)) {
$oSettings->useAuth = (bool) $this->Config()->Get('plugin', 'smtp_auth', true);
$oSettings->Login = \trim($this->Config()->Get('plugin', 'smtp_user', ''));
$oSettings->Password = (string) $this->Config()->Get('plugin', 'smtp_password', '');
}
}
/**
* @return array
*/
protected function configMapping() : array
{
return array(
\RainLoop\Plugins\Property::NewInstance('smtp_host')->SetLabel('SMTP Host')
->SetDefaultValue(''),
\RainLoop\Plugins\Property::NewInstance('smtp_port')->SetLabel('SMTP Port')
->SetType(\RainLoop\Enumerations\PluginPropertyType::INT)
->SetDefaultValue(25),
\RainLoop\Plugins\Property::NewInstance('smtp_secure')->SetLabel('SMTP Secure')
->SetType(\RainLoop\Enumerations\PluginPropertyType::SELECTION)
->SetDefaultValue(array('None', 'Detect', 'SSL', 'STARTTLS')),
\RainLoop\Plugins\Property::NewInstance('smtp_auth')->SetLabel('Use auth')
->SetType(\RainLoop\Enumerations\PluginPropertyType::BOOL)
->SetDefaultValue(true),
\RainLoop\Plugins\Property::NewInstance('smtp_user')->SetLabel('SMTP User')
->SetDefaultValue(''),
\RainLoop\Plugins\Property::NewInstance('smtp_password')->SetLabel('SMTP Password')
->SetType(\RainLoop\Enumerations\PluginPropertyType::PASSWORD)
->SetDefaultValue(''),
\RainLoop\Plugins\Property::NewInstance('override_users')->SetLabel('Override users')
->SetType(\RainLoop\Enumerations\PluginPropertyType::STRING_TEXT)
->SetDescription('space as delimiter, wildcard supported.')
->SetDefaultValue('user@example.com *@example2.com')
);
}
}