Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

SubscriptionSender: Send mail to each subscriber individually #4035

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

SubscriptionSender: Send mail to each subscriber individually #4035

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b1663ec
SubscriptionSender: Send mail to each subscriber individually
tomabrafix Aug 10, 2023
25cc7a8
Add test for Mailer::splitAddress()
tomabrafix Aug 20, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
12 changes: 6 additions & 6 deletions _test/tests/Subscriptions/BulkSubscriptionsSenderTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ public function testBulkdigest()

// should trigger a mail
$this->assertEquals(1, $sub->sendBulk('sub1:test'));
$this->assertEquals(['arthur@example.com'], array_column($mailerMock->mails, 'Bcc'));
$this->assertEquals(['arthur@example.com'], array_column($mailerMock->mails, 'To'));

$mailerMock->mails = [];

Expand All @@ -57,7 +57,7 @@ public function testBulkdigest()

// should not trigger a mail, because the subscription time has not been reached, yet
$this->assertEquals(0, $sub->sendBulk('sub1:test'));
$this->assertEquals([], array_column($mailerMock->mails, 'Bcc'));
$this->assertEquals([], array_column($mailerMock->mails, 'To'));

// reset the subscription time
$manager->add('sub1:', 'testuser', 'digest', '978328800'); // last mod 2001-01-01
Expand All @@ -66,7 +66,7 @@ public function testBulkdigest()
$this->assertEquals(3, $sub->sendBulk('sub1:test'));
$this->assertEquals(
['arthur@example.com', 'arthur@example.com', 'arthur@example.com'],
array_column($mailerMock->mails, 'Bcc')
array_column($mailerMock->mails, 'To')
);
}

Expand All @@ -88,7 +88,7 @@ public function testBulklist()

// should trigger a mail
$this->assertEquals(1, $sub->sendBulk('sub1:test'));
$this->assertEquals(['arthur@example.com'], array_column($mailerMock->mails, 'Bcc'));
$this->assertEquals(['arthur@example.com'], array_column($mailerMock->mails, 'To'));

$mailerMock->mails = [];

Expand All @@ -99,13 +99,13 @@ public function testBulklist()

// should not trigger a mail, because the subscription time has not been reached, yet
$this->assertEquals(0, $sub->sendBulk('sub1:test'));
$this->assertEquals([], array_column($mailerMock->mails, 'Bcc'));
$this->assertEquals([], array_column($mailerMock->mails, 'To'));

// reset the subscription time
$manager->add('sub1:', 'testuser', 'list', '978328800'); // last mod 2001-01-01

// we now should get a single mail for all three changes
$this->assertEquals(1, $sub->sendBulk('sub1:test'));
$this->assertEquals(['arthur@example.com'], array_column($mailerMock->mails, 'Bcc'));
$this->assertEquals(['arthur@example.com'], array_column($mailerMock->mails, 'To'));
}
}
22 changes: 22 additions & 0 deletions _test/tests/inc/mailer.test.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -377,5 +377,27 @@ function test_getCleanName() {
$this->assertEquals('Foo tar', $name);

}

function test_splitAddress() {
$mail = new TestMailer();

$output = ['test@example.com'];
$addresses = $mail->splitAddress('test@example.com');
$this->assertEquals($output, $addresses);
$addresses = $mail->splitAddress($output);
$this->assertEquals($output, $addresses);

$output = ['test1@example.com', 'test2@example.com'];
$addresses = $mail->splitAddress('test1@example.com,test2@example.com');
$this->assertEquals($output, $addresses);
$addresses = $mail->splitAddress($output);
$this->assertEquals($output, $addresses);

$output = ['föö <foo@bar.com>', 'me@somewhere.com', '"foo, Dr." <foo@bar.com>'];
$addresses = $mail->splitAddress('föö <foo@bar.com>,me@somewhere.com,"foo, Dr." <foo@bar.com>');
$this->assertEquals($output, $addresses);
$addresses = $mail->splitAddress($output);
$this->assertEquals($output, $addresses);
}
}
//Setup VIM: ex: et ts=4 :
31 changes: 22 additions & 9 deletions inc/Mailer.class.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -337,6 +337,26 @@ public function getCleanName($name) {
return $name;
}

/**
* Splits a string with multiple email addresses into an array
*
* @param string|string[] $addresses Multiple adresses separated by commas or as array
* @return string[] the email addresses as array
*/
public function splitAddress($addresses) {
if(!is_array($addresses)){
$count = preg_match_all('/\s*(?:("[^"]*"[^,]+),*)|([^,]+)\s*,*/', $addresses, $matches, PREG_SET_ORDER);
$addresses = array();
if ($count !== false && is_array($matches)) {
foreach ($matches as $match) {
array_push($addresses, rtrim($match[0], ','));
}
}
}

return $addresses;
}

/**
* Sets an email address header with correct encoding
*
Expand All @@ -357,15 +377,8 @@ public function getCleanName($name) {
*/
public function cleanAddress($addresses) {
$headers = '';
if(!is_array($addresses)){
$count = preg_match_all('/\s*(?:("[^"]*"[^,]+),*)|([^,]+)\s*,*/', $addresses, $matches, PREG_SET_ORDER);
$addresses = array();
if ($count !== false && is_array($matches)) {
foreach ($matches as $match) {
array_push($addresses, rtrim($match[0], ','));
}
}
}

$addresses = $this->splitAddress($addresses);

foreach($addresses as $part) {
$part = preg_replace('/[\r\n\0]+/', ' ', $part); // remove attack vectors
Expand Down
31 changes: 19 additions & 12 deletions inc/Subscriptions/SubscriptionSender.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,24 +63,31 @@ protected function send($subscriber_mail, $subject, $context, $template, $trep,
{
global $lang;
global $conf;
$success = true;

$text = rawLocale($template);
$subject = $lang['mail_' . $subject] . ' ' . $context;
$mail = $this->mailer;
$mail->bcc($subscriber_mail);
$mail->subject($subject);
$mail->setBody($text, $trep, $hrep);
if (in_array($template, ['subscr_list', 'subscr_digest'])) {
$mail->from($conf['mailfromnobody']);
}
if (isset($trep['SUBSCRIBE'])) {
$mail->setHeader('List-Unsubscribe', '<' . $trep['SUBSCRIBE'] . '>', false);
}
$addresses = $mail->splitAddress($subscriber_mail);

foreach($addresses as $address) {
$mail->to($address);
$mail->subject($subject);
$mail->setBody($text, $trep, $hrep);
if (in_array($template, ['subscr_list', 'subscr_digest'])) {
$mail->from($conf['mailfromnobody']);
}
if (isset($trep['SUBSCRIBE'])) {
$mail->setHeader('List-Unsubscribe', '<' . $trep['SUBSCRIBE'] . '>', false);
}

foreach ($headers as $header => $value) {
$mail->setHeader($header, $value);
}

foreach ($headers as $header => $value) {
$mail->setHeader($header, $value);
$success &= $mail->send();
}

return $mail->send();
return $success;
}
}