Vitaliy-1
commented
3 years ago Made it work locally with our mail templates. Some tweaks are required regarding ways to pass data (variables) with native methods. In general, this going to replace our Mail class and its children with Laravel Mailable classes. As an example, let's say there is UserRegistered event its listener MailRegisteredUser and class that extends Laravel's Mailable MailRegisteredUser. The representation of an email looks like:
class MailRegisteredUser extends Mailable
{
// All all template variables associated with arguments of the constructor are automatically available in the template
public function __construct(PKPSubmission $submission, array $recipients, ReviewAssignment $reviewAssignment)
{
$this->submission = $submission;
$this->recipients = $recipients;
$this->reviewAssignment = $reviewAssignment;
}
public function build()
{
// passing email key to view (instead of path to the Laravel's Blade template), using method chaining to set data
return $this->view('USER_REGISTERED')
->replyTo($this->context->getContactEmail())
->with(['additionalVariable => $this->submission->getData('somedata')]) // Supply template with additional variable
}
// as an alternative to method chaining
public function from()
{
$user = PKPAplication::get()->getRequest()->getUser();
$emailAddress = user->getData('email');
$name = $user->getLocalizedData('givenName');
return $this->setAddress($emailAddress, $name, 'from');
}
}Email data can be overridden from the listener, which sends an email, e.g.:
use mail/.../MailRegisteredUser as Mailable
class MailRegisteredUser
{
/**
* @param \PKP\observers\events\UserRegistered
* @return void
*/
public function handle(UserRegisteredAssigned $event)
{
$mail = new Mailable($event->submission, [$event->reviewer], $event->reviewAssignment);
Mail::send($mail->view('ANOTHER_TEMPLATE'));
// or directly changing message data passing a Closure as a 3rd parameter to the send method
}
}Also, it seems that Laravel's interface for the SwiftMailer doesn't support all SMTP configs that are currently in OJS, like default envelope sender and associated. Here are parameters that can be passed to the SMTP config:
- 'host'
- 'port'
- 'encryption'
- 'username'
- 'password'
- 'timeout'
- 'auth_mode'
NateWr
asmecher
Describe the problem you would like to solve
Describe the solution you'd like Register Illuminate Mailer. Review whether additional tweaks/adaptations are required to implement its interface
Who is asking for this feature? Community
Additional information This issue is coupled with email template variables refactoring and improvements to email workflow in general.