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

Add Events around Zend_Email #1438

Merged
merged 3 commits into from
Jan 14, 2023
Merged

Add Events around Zend_Email #1438

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f5a46d4
core/email use utf-8
rjocoleman Jan 30, 2021
e06c6cb
core/email add before/after events
rjocoleman Jan 30, 2021
70cac1f
newsletter/template add before/after events
rjocoleman Jan 30, 2021
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
23 changes: 21 additions & 2 deletions app/code/core/Mage/Core/Model/Email.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,8 @@ public function send()
return $this;
}

$mail = new Zend_Mail();
$mail = new Zend_Mail('utf-8');
$transport = new Varien_Object();

if (strtolower($this->getType()) == 'html') {
$mail->setBodyHtml($this->getBody());
Expand All @@ -137,7 +138,25 @@ public function send()
$mail->setFrom($this->getFromEmail(), $this->getFromName())
->addTo($this->getToEmail(), $this->getToName())
->setSubject($this->getSubject());
$mail->send();

Mage::dispatchEvent('email_send_before', [
'mail' => $mail,
'template' => $this->getTemplate(),
'transport' => $transport,
'variables' => $this->getTemplateVars()
]);

if ($transport->getTransport()) {
$mail->send($transport->getTransport());
} else {
$mail->send();
}

Mage::dispatchEvent('email_send_after', [
'to' => $this->getToEmail(),
'subject' => $this->getSubject(),
'email_body' => $this->getBody()
]);

return $this;
}
Expand Down
24 changes: 23 additions & 1 deletion app/code/core/Mage/Core/Model/Email/Queue.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -231,10 +231,32 @@ public function send()
}

try {
$mailer->send();
$transport = new Varien_Object();
Mage::dispatchEvent('email_queue_send_before', [
'mail' => $mailer,
'message' => $message,
'transport' => $transport
]);

if ($transport->getTransport()) {
$mailer->send($transport->getTransport());
} else {
$mailer->send();
}

unset($mailer);
$message->setProcessedAt(Varien_Date::formatDate(true));
$message->save(); // save() is throwing exception when recipient is not set

foreach ($message->getRecipients() as $recipient) {
list($email, $name, $type) = $recipient;
Mage::dispatchEvent('email_queue_send_after', [
'to' => $email,
'html' => !$parameters->getIsPlain(),
'subject' => $parameters->getSubject(),
'email_body' => $message->getMessageBody()
]);
}
} catch (Exception $e) {
Mage::logException($e);
}
Expand Down
25 changes: 24 additions & 1 deletion app/code/core/Mage/Core/Model/Email/Template.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -459,7 +459,30 @@ public function send($email, $name = null, array $variables = [])
$mail->setFrom($this->getSenderEmail(), $this->getSenderName());

try {
$mail->send();
$transport = new Varien_Object();

Mage::dispatchEvent('email_template_send_before', [
'mail' => $mail,
'template' => $this,
'transport' => $transport,
'variables' => $variables
]);

if ($transport->getTransport()) {
$mail->send($transport->getTransport());
} else {
$mail->send();
}

foreach ($emails as $key => $email) {
Mage::dispatchEvent('email_template_send_after', [
'to' => $email,
'html' => !$this->isPlain(),
'subject' => $subject,
'template' => $this->getTemplateId(),
'email_body' => $text
]);
}
$this->_mail = null;
} catch (Exception $e) {
$this->_mail = null;
Expand Down
23 changes: 22 additions & 1 deletion app/code/core/Mage/Newsletter/Model/Template.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -328,7 +328,28 @@ public function send($subscriber, array $variables = [], $name = null, Mage_News
$mail->setFrom($this->getTemplateSenderEmail(), $this->getTemplateSenderName());

try {
$mail->send();
$transport = new Varien_Object();

Mage::dispatchEvent('newsletter_send_before', [
'mail' => $mail,
'transport' => $transport,
'template' => $this,
'subscriber' => $subscriber
]);

if ($transport->getTransport()) {
$mail->send($transport->getTransport());
} else {
$mail->send();
}

Mage::dispatchEvent('newsletter_send_after', [
'to' => $email,
'html' => !$this->isPlain(),
'queue' => $queue,
'subject' => $mail->getSubject(),
'email_body' => $text
]);
$this->_mail = null;
if (!is_null($queue)) {
$subscriber->received($queue);
Expand Down
10 changes: 9 additions & 1 deletion docs/EVENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -215,6 +215,12 @@
| customer_registration_is_allowed | 1.9.4.5 |
| customer_session_init | 1.9.4.5 |
| eav_collection_abstract_load_before | 1.9.4.5 |
| email_queue_send_before | 19.4.18 |
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't forget to update numbers.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll merge and update right after, just not to invalidate the reviews

| email_queue_send_after | 19.4.18 |
| email_send_before | 19.4.18 |
| email_send_after | 19.4.18 |
| email_template_send_before | 19.4.18 |
| email_template_send_after | 19.4.18 |
| end_index_events_[getEventTypeName] | 1.9.4.5 |
| end_process_event_[getEventTypeName] | 1.9.4.5 |
| gift_options_prepare_items | 1.9.4.5 |
Expand All @@ -235,6 +241,8 @@
| model_save_after | 1.9.4.5 |
| model_save_before | 1.9.4.5 |
| model_save_commit_after | 1.9.4.5 |
| newsletter_send_before | 19.4.18 |
| newsletter_send_after | 19.4.18 |
| on_view_report | 1.9.4.5 |
| order_cancel_after | 1.9.4.5 |
| page_block_html_topmenu_gethtml_after | 1.9.4.5 |
Expand Down Expand Up @@ -360,4 +368,4 @@ class YourNamespace_YourModule_Model_Observer {
public function yourMethod(Varien_Event_Observer $observer) {
$customer = $observer->getData('customer');
}
}
}