forked from PHPMailer/PHPMailer
-
Notifications
You must be signed in to change notification settings - Fork 901
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request PHPMailer#2874 from voronkovich/support-dsn
Support instantiating from DSN string
- Loading branch information
Showing
3 changed files
with
470 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,242 @@ | ||
<?php | ||
|
||
/** | ||
* PHPMailer - PHP email creation and transport class. | ||
* PHP Version 5.5. | ||
* | ||
* @see https://github.com/PHPMailer/PHPMailer/ The PHPMailer GitHub project | ||
* | ||
* @author Marcus Bointon (Synchro/coolbru) <[email protected]> | ||
* @author Jim Jagielski (jimjag) <[email protected]> | ||
* @author Andy Prevost (codeworxtech) <[email protected]> | ||
* @author Brent R. Matzelle (original founder) | ||
* @copyright 2012 - 2020 Marcus Bointon | ||
* @copyright 2010 - 2012 Jim Jagielski | ||
* @copyright 2004 - 2009 Andy Prevost | ||
* @license https://www.gnu.org/copyleft/lesser.html GNU Lesser General Public License | ||
* @note This program is distributed in the hope that it will be useful - WITHOUT | ||
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | ||
* FITNESS FOR A PARTICULAR PURPOSE. | ||
*/ | ||
|
||
namespace PHPMailer\PHPMailer; | ||
|
||
/** | ||
* Configure PHPMailer with DSN string. | ||
* | ||
* @see https://en.wikipedia.org/wiki/Data_source_name | ||
* | ||
* @author Oleg Voronkovich <[email protected]> | ||
*/ | ||
class DSNConfigurator | ||
{ | ||
/** | ||
* Create new PHPMailer instance configured by DSN. | ||
* | ||
* @param string $dsn DSN | ||
* @param bool $exceptions Should we throw external exceptions? | ||
* | ||
* @return PHPMailer | ||
*/ | ||
public static function mailer($dsn, $exceptions = null) | ||
{ | ||
static $configurator = null; | ||
|
||
if (null === $configurator) { | ||
$configurator = new DSNConfigurator(); | ||
} | ||
|
||
return $configurator->configure(new PHPMailer($exceptions), $dsn); | ||
} | ||
|
||
/** | ||
* Configure PHPMailer instance with DSN string. | ||
* | ||
* @param PHPMailer $mailer PHPMailer instance | ||
* @param string $dsn DSN | ||
* | ||
* @return PHPMailer | ||
*/ | ||
public function configure(PHPMailer $mailer, $dsn) | ||
{ | ||
$config = $this->parseDSN($dsn); | ||
|
||
$this->applyConfig($mailer, $config); | ||
|
||
return $mailer; | ||
} | ||
|
||
/** | ||
* Parse DSN string. | ||
* | ||
* @param string $dsn DSN | ||
* | ||
* @throws Exception If DSN is mailformed | ||
* | ||
* @return array Configruration | ||
*/ | ||
private function parseDSN($dsn) | ||
{ | ||
$config = $this->parseUrl($dsn); | ||
|
||
if (false === $config || !isset($config['scheme']) || !isset($config['host'])) { | ||
throw new Exception( | ||
sprintf('Malformed DSN: "%s".', $dsn) | ||
); | ||
} | ||
|
||
if (isset($config['query'])) { | ||
parse_str($config['query'], $config['query']); | ||
} | ||
|
||
return $config; | ||
} | ||
|
||
/** | ||
* Apply configuration to mailer. | ||
* | ||
* @param PHPMailer $mailer PHPMailer instance | ||
* @param array $config Configuration | ||
* | ||
* @throws Exception If scheme is invalid | ||
*/ | ||
private function applyConfig(PHPMailer $mailer, $config) | ||
{ | ||
switch ($config['scheme']) { | ||
case 'mail': | ||
$mailer->isMail(); | ||
break; | ||
case 'sendmail': | ||
$mailer->isSendmail(); | ||
break; | ||
case 'qmail': | ||
$mailer->isQmail(); | ||
break; | ||
case 'smtp': | ||
case 'smtps': | ||
$mailer->isSMTP(); | ||
$this->configureSMTP($mailer, $config); | ||
break; | ||
default: | ||
throw new Exception( | ||
sprintf( | ||
'Invalid scheme: "%s". Allowed values: "mail", "sendmail", "qmail", "smtp", "smtps".', | ||
$config['scheme'] | ||
) | ||
); | ||
} | ||
|
||
if (isset($config['query'])) { | ||
$this->configureOptions($mailer, $config['query']); | ||
} | ||
} | ||
|
||
/** | ||
* Configure SMTP. | ||
* | ||
* @param PHPMailer $mailer PHPMailer instance | ||
* @param array $config Configuration | ||
*/ | ||
private function configureSMTP($mailer, $config) | ||
{ | ||
$isSMTPS = 'smtps' === $config['scheme']; | ||
|
||
if ($isSMTPS) { | ||
$mailer->SMTPSecure = PHPMailer::ENCRYPTION_STARTTLS; | ||
} | ||
|
||
$mailer->Host = $config['host']; | ||
|
||
if (isset($config['port'])) { | ||
$mailer->Port = $config['port']; | ||
} elseif ($isSMTPS) { | ||
$mailer->Port = SMTP::DEFAULT_SECURE_PORT; | ||
} | ||
|
||
$mailer->SMTPAuth = isset($config['user']) || isset($config['pass']); | ||
|
||
if (isset($config['user'])) { | ||
$mailer->Username = $config['user']; | ||
} | ||
|
||
if (isset($config['pass'])) { | ||
$mailer->Password = $config['pass']; | ||
} | ||
} | ||
|
||
/** | ||
* Configure options. | ||
* | ||
* @param PHPMailer $mailer PHPMailer instance | ||
* @param array $options Options | ||
* | ||
* @throws Exception If option is unknown | ||
*/ | ||
private function configureOptions(PHPMailer $mailer, $options) | ||
{ | ||
$allowedOptions = get_object_vars($mailer); | ||
|
||
unset($allowedOptions['Mailer']); | ||
unset($allowedOptions['SMTPAuth']); | ||
unset($allowedOptions['Username']); | ||
unset($allowedOptions['Password']); | ||
unset($allowedOptions['Hostname']); | ||
unset($allowedOptions['Port']); | ||
unset($allowedOptions['ErrorInfo']); | ||
|
||
$allowedOptions = \array_keys($allowedOptions); | ||
|
||
foreach ($options as $key => $value) { | ||
if (!in_array($key, $allowedOptions)) { | ||
throw new Exception( | ||
sprintf( | ||
'Unknown option: "%s". Allowed values: "%s"', | ||
$key, | ||
implode('", "', $allowedOptions) | ||
) | ||
); | ||
} | ||
|
||
switch ($key) { | ||
case 'AllowEmpty': | ||
case 'SMTPAutoTLS': | ||
case 'SMTPKeepAlive': | ||
case 'SingleTo': | ||
case 'UseSendmailOptions': | ||
case 'do_verp': | ||
case 'DKIM_copyHeaderFields': | ||
$mailer->$key = (bool) $value; | ||
break; | ||
case 'Priority': | ||
case 'SMTPDebug': | ||
case 'WordWrap': | ||
$mailer->$key = (int) $value; | ||
break; | ||
default: | ||
$mailer->$key = $value; | ||
break; | ||
} | ||
} | ||
} | ||
|
||
/** | ||
* Parse URL. | ||
* | ||
* @param string $url URL | ||
* | ||
* @return array Result | ||
*/ | ||
protected function parseUrl($url) | ||
{ | ||
if (\PHP_VERSION_ID >= 50600 || false === strpos($url, '?')) { | ||
return parse_url($url); | ||
} | ||
|
||
$chunks = explode('?', $url); | ||
|
||
$result = parse_url($chunks[0]); | ||
$result['query'] = $chunks[1]; | ||
|
||
return $result; | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.