From b098bc42c21c56bc85f5da4459b4c4b899a1736e Mon Sep 17 00:00:00 2001
From: Demian Katz <demian.katz@villanova.edu>
Date: Wed, 23 Oct 2019 15:12:32 -0400
Subject: [PATCH] Add support (and tests) for SMTP connection time limit.
(#1468)
---
config/vufind/config.ini | 5 +++
module/VuFind/src/VuFind/Mailer/Factory.php | 4 ++
.../src/VuFindTest/Mailer/MailerTest.php | 39 +++++++++++++++++++
3 files changed, 48 insertions(+)
diff --git a/config/vufind/config.ini b/config/vufind/config.ini
index 931a1ca8ede..18c8de3e221 100644
--- a/config/vufind/config.ini
+++ b/config/vufind/config.ini
@@ -538,6 +538,11 @@ port = 25
; connection. If no explicit protocol ('tls' or 'ssl') is configured, a protocol
; based on the configured port is chosen (587 -> tls, 487 -> ssl).
;secure = tls
+; This setting enforces a limit (in seconds) on the lifetime of an SMTP
+; connection, which can be useful when sending batches of emails, since it can
+; help avoid errors caused by server timeouts. Comment out the setting to disable
+; the limit.
+connection_time_limit = 60
; Uncomment this setting to disable outbound mail but simulate success; this
; is useful for interface testing but should never be used in production!
;testOnly = true
diff --git a/module/VuFind/src/VuFind/Mailer/Factory.php b/module/VuFind/src/VuFind/Mailer/Factory.php
index ac139c6d858..4fcc86269fd 100644
--- a/module/VuFind/src/VuFind/Mailer/Factory.php
+++ b/module/VuFind/src/VuFind/Mailer/Factory.php
@@ -83,6 +83,10 @@ class Factory implements FactoryInterface
$settings['connection_config']['ssl'] = 'ssl';
}
}
+ if (isset($config->Mail->connection_time_limit)) {
+ $settings['connection_time_limit']
+ = $config->Mail->connection_time_limit;
+ }
return new Smtp(new SmtpOptions($settings));
}
diff --git a/module/VuFind/tests/unit-tests/src/VuFindTest/Mailer/MailerTest.php b/module/VuFind/tests/unit-tests/src/VuFindTest/Mailer/MailerTest.php
index bf8dab5a97a..a5d49a5128b 100644
--- a/module/VuFind/tests/unit-tests/src/VuFindTest/Mailer/MailerTest.php
+++ b/module/VuFind/tests/unit-tests/src/VuFindTest/Mailer/MailerTest.php
@@ -27,7 +27,9 @@
*/
namespace VuFindTest\Mailer;
+use VuFind\Mailer\Factory as MailerFactory;
use VuFind\Mailer\Mailer;
+use VuFindTest\Container\MockContainer;
use Zend\Mail\Address;
use Zend\Mail\AddressList;
@@ -42,6 +44,43 @@ use Zend\Mail\AddressList;
*/
class MailerTest extends \VuFindTest\Unit\TestCase
{
+ /**
+ * Test that the factory configures the object correctly.
+ *
+ * @return void
+ */
+ public function testFactoryConfiguration()
+ {
+ $config = new \Zend\Config\Config(
+ [
+ 'Mail' => [
+ 'host' => 'vufindtest.localhost',
+ 'port' => 123,
+ 'connection_time_limit' => 600,
+ 'name' => 'foo',
+ 'username' => 'vufinduser',
+ 'password' => 'vufindpass',
+ ]
+ ]
+ );
+ $cm = new MockContainer($this);
+ $cm->set('config', $config);
+ $sm = new MockContainer($this);
+ $sm->set(\VuFind\Config\PluginManager::class, $cm);
+ $factory = new MailerFactory();
+ $mailer = $factory($sm, Mailer::class);
+ $options = $mailer->getTransport()->getOptions();
+ $this->assertEquals('vufindtest.localhost', $options->getHost());
+ $this->assertEquals('foo', $options->getName());
+ $this->assertEquals(123, $options->getPort());
+ $this->assertEquals(600, $options->getConnectionTimeLimit());
+ $this->assertEquals('login', $options->getConnectionClass());
+ $this->assertEquals(
+ ['username' => 'vufinduser', 'password' => 'vufindpass'],
+ $options->getConnectionConfig()
+ );
+ }
+
/**
* Test sending an email.
*
--
GitLab