I've defined a simple email controller based on this tutorial:
https://symfony.com/doc/3.4/email.html
So the php file code is:
<?php
namespace AppBundle\Controller;
use Symfony\Component\HttpKernel\Tests\Controller;
class SendEmailController extends Controller
{
public function indexAction($originlEmail, $destinationEmail1, $destinationEmail2, $name, \Swift_Mailer $mailer)
{
$message = (new \Swift_Message('Email Title'))
->setFrom($originlEmail)
->setTo($destinationEmail1, $destinationEmail2)
->setBody(
$this->renderView(
'emails/send-email.html.twig',
array('name' => $name)
),
'text/html'
);
$mailer->send($message);
return $this->render(...);
}
}
And the .twig template code is:
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8" />
</head>
<body>
<h3>This is an email!</h3>
<p>Hi {{ name }}, this is an email! </p>
</body>
</html>
Now, following this tutorial https://symfony.com/doc/3.4/email/testing.html I've created a PhpUnit testing class:
<?php
namespace tests\AppBundle\Controller;
use AppBundle\Controller\SendMyEmailController;
class SendCustomerEmailControllerTest extends PHPUnit_Framework_TestCase
{
public function testMailIsSentAndContentIsCorrect()
{
$client = static:: createClient();
$client->enableProfiler();
$crawler = $client->request('POST', 'path/to/above/action');
$mailCollector = $client->getProfile()->getCollector('swiftmailer');
$this->assertSame(1, $mailCollector->getMessageCount());
$collectedMessages = $mailCollector->getMessages();
$message = $collectedMessages[0];
$this->assertInstanceOf('Swift_Message', $message);
$this->assertSame('My Email Title', $message->getSubject());
$this->assertSame($originEmail, key($message->getFrom()));
$this->assertSame($destinationEmail1, $destinationEmail2, key($message->getTo()));
##Asserting template content???
$this->assertSame(?????, $message->getBody()
);
}
}
Then, the problems I have are:
Where and how should I define (in the test) variables like $originEmail, given the fact that in the "assertSame..." line, I get the error "Undefined variable $originEmail".
Is correct the syntax (considering they are more than one variable) of the line $this->assertSame($destinationEmail1, $destinationEmail2, key($message->getTo())); ?
How can I assert the body content, if instead of a defined text in the .php controller, it is showed in the .twig template (in addition, by using a variable like {{ name }}?
Regarding 1)
How I would go about this depends on how this information is passed into the action. If it's not part of the request, I would just assert against the expected value by doing something like:
$this->assertSame('expected#email.com', $message->getFrom());
If it's part of the route I would assign a local variable in the test and then pass it into the route, maybe like this:
$originalEmail = 'expected#email.com';
$path = sprintf('/path/to/action/%s', $originalEmail);
$client->request('POST', $path);
...
$this->assertSame($originalEmail, $message->getFrom());
If it's part of the POST-data:
$data = [
'originalEmail' => 'expected#email.com',
];
$client->request('POST', '/path/to/action', $data);
...
$this->assertSame($data['originalEmail'], $message->getFrom());
Regarding 2)
This will not work as intended, but you can do something like this (if the email is a value in the array):
$this->assertContains($destinationEmail1, $message->getTo());
Or like this if it's a key (like in your example):
$this->assertArrayHasKey($destinationEmail1, $message->getTo());
Regarding 3)
If you want to compare that the body matches an example you might have to store a reference output in a file and then compare the contents:
$this->assertSame(
file_get_contents(__DIR__ . '/emails/reference_output.html'),
$message->getBody()
);
In that case you have to be careful your email body contains the same name as your reference output.
Alternatively you can also use the crawler to look only for some html elements and their content, e.g. check if the header <h3>This is an email!</h3> is in there:
$crawler = $client->request('POST', '/path/to/action');
$this->assertSame(
'This is an email!',
$crawler->filter('h3')->first()->text()
);
// alternative:
$this->assertGreaterThan(
0,
$crawler->filter('h3:contains("This is an email!")')->count()
);
Zend expressive - Layout
https://github.com/zendframework/zend-expressive-twigrenderer/issues/24
Based on this question, I want to pass a variable to layout from an Action
How can I try to do that?
$toast = [
'level'=>'info',
'msg' =>'rafael',
'url' => null
];
$this->template->addDefaultParam(Template\TemplateRendererInterface::TEMPLATE_ALL,'toast',$this->toastrMessenger->show($toast));
return new HtmlResponse($this->template->render('contentpages::contact',$data));
on my layout/default.phtml
<?php
if ( isset($this->toast) ){
echo $this->toast;
}
?>
</body>
</html>
Did you try "addDefaultParam" method? signeture is;
public function addDefaultParam($templateName, $param, $value)
and you can set star (*) as $templateName (see TemplateRendererInterface::TEMPLATE_ALL) so i think layout can read it.
You can read about it on documentation. Let me know if its working.
It seems like i am not following the MVC design structure.
I'm making an ajax call from my view to a Controller function
Controller
public function actionGetClient()
{
$user = Client::model()->findByAttributes(array('email'=>$_POST['email'], 'password'=>$_POST['pass']));
echo $user->fullname;
}
View (the calling ajax)
CHtml::ajaxLink(
$text = 'get user',
$url = Yii::app()->createUrl('[my controller]/getClient'),
$ajax=array (
'type'=>'POST',
'data' => array('email'=>email, 'pass'=>pass),
'beforeSend' => "function( request )
{
$(\".result\").html(\"fetching...\")
}",
'success'=>"function(data){
$(\".result\").html(\"user is :\"+data)
}
"
));
Is it good to "echo" the $user->fullname inside the controller for the ajax success function to display it? My boss doesn't like it when i print stuff in my controller, how can i approach this
because when i use return instead, the ajax success gets a null value
return $user->fullname;
No,
It's not a good practice.
You need to create a view to use echo.
You can use return $this->renderPartial('VIEW_NAME'); to render a view without Layout.
You should write 'return' instead of 'echo'. 'echo' is not a good practice for ajax response. You don't need to make a new view for just return a name in your case.
public function actionGetClient()
{
$user = Client::model()->findByAttributes(array('email'=>$_POST['email'],'password'=>$_POST['pass']));
return $user->fullname;
}
No. A controller’s supposed to pass its results to a view for rendering.
I would avoid echoing in the controller what we usually do is have a ajax view folder and a json view and render with that so:
public function actionGetClient()
{
$user = Client::model()->findByAttributes(array(
'email'=>$_POST['email'],
'password'=>$_POST['pass']
));
$this->render("json",array("outputData"=>$user));
}
then add this to the controller as well:
public function getViewPath(){
if(Yii::app()->request->isAjaxRequest){
if(($module=$this->getModule())===null)
$module=Yii::app();
return $module->getViewPath().DIRECTORY_SEPARATOR."ajax";
}
return parent::getViewPath();
}
and in the ajax views folder add a json.php file like so
header('Content-Type: application/json');
// output data
echo json_encode($outputData);
please degug the code as I wrote it free hand. You can also set a marker in the controller like $viewPath and set it before the rendering
I want to send a confirmation e-mail using laravel.
The laravel Mail::send() function only seems to accept a path to a file on the system.
The problem is that my mailtemplates are stored in the database and not in a file on the system.
How can I pass plain content to the email?
Example:
$content = "Hi,welcome user!";
Mail::send($content,$data,function(){});
update on 7/20/2022: For more current versions of Laravel, the setBody() method in the Mail::send() example below has been replaced with the text() or html() methods.
update: In Laravel 5 you can use raw instead:
Mail::raw('Hi, welcome user!', function ($message) {
$message->to(..)
->subject(..);
});
This is how you do it:
Mail::send([], [], function ($message) {
$message->to(..)
->subject(..)
// here comes what you want
->setBody('Hi, welcome user!'); // assuming text/plain
// or:
->setBody('<h1>Hi, welcome user!</h1>', 'text/html'); // for HTML rich messages
});
For Html emails
Mail::send(array(), array(), function ($message) use ($html) {
$message->to(..)
->subject(..)
->from(..)
->setBody($html, 'text/html');
});
It is not directly related to the question, but for the ones that search for setting the plain text version of your email while keeping the custom HTML version, you can use this example :
Mail::raw([], function($message) {
$message->from('contact#company.com', 'Company name');
$message->to('johndoe#gmail.com');
$message->subject('5% off all our website');
$message->setBody( '<html><h1>5% off its awesome</h1><p>Go get it now !</p></html>', 'text/html' );
$message->addPart("5% off its awesome\n\nGo get it now!", 'text/plain');
});
If you would ask "but why not set first argument as plain text ?", I made a test and it only takes the html part, ignoring the raw part.
If you need to use additional variable, the anonymous function will need you to use use() statement as following :
Mail::raw([], function($message) use($html, $plain, $to, $subject, $formEmail, $formName){
$message->from($fromEmail, $fromName);
$message->to($to);
$message->subject($subject);
$message->setBody($html, 'text/html' ); // dont miss the '<html></html>' or your spam score will increase !
$message->addPart($plain, 'text/plain');
});
Hope it helps you folks.
The Mailer class passes a string to addContent which via various other methods calls views->make(). As a result passing a string of content directly won't work as it'll try and load a view by that name.
What you'll need to do is create a view which simply echos $content
// mail-template.php
<?php echo $content; ?>
And then insert your string into that view at runtime.
$content = "Hi,welcome user!";
$data = [
'content' => $content
];
Mail::send('mail-template', $data, function() { });
I had a similar issue where the HTML and/or plain text of my email were not built by a view and I didn't want to create a dummy view for them (as proposed by #Matthew Odedoyin).
As others have commented, you can use $this->html() to set the HTML content of the message, but what if you want your email to have both HTML and plain text content?
Unfortunately $this->text() only takes a view, but I got around this by using:
$this->text(new HtmlString('Here is the plain text content'));
Which renders the content of the HTMLString instead of the view.
try
public function build()
{
$message = 'Hi,welcome user!'
return $this->html($message)->subject($message);
}
as you know
Only mailables may be queued.
meaning, if you use ShouldQueue interface
1) first, you should always do
php artisan queue:restart
2) second, in your mailable you can use html method (tested in laravel 5.8)
public function build(): self
{
return $this
->html('
<html>
<body>
ForwardEmail
</body>
</html>
')
->subject(config('app.name') . ' ' . 'email forwarded')
->attachData($this->content, 'email.eml', [
'mime' => 'application/eml',
]);
}
If you were using mailables. You can do something like this in the build method :
public function build()
{
return $this->view('email')
->with(['html'=>'This is the message']);
}
And you just go ahead and create the blade view email.blade.php in your resource folder.
Then in the blade you can reference your string using laravel blade syntax
<html>
<body>
{{$html}}
</body>
</html>
or
<html>
<body>
{!!$html!!}
</body>
</html>
If your raw text contains HTML mark up
I hope this works for those who have templates stored in the database and wants to take advantage of the Mailables class in Laravel.
To send raw html, text etc using Laravel Mailables you can
override Mailable->send() in your Mailable and in there, use the method in previous responses:
send([], [], function($message){ $message->setBody() } )
No need to call $this->view() at your build function at all.
NOTE: Below answer is for those who are looking for a flexible approach. i,e (with or without laravel template)
With Template
$payload['message'] = View::make('emails.test-mail',$data)->render();
Without Template
$payload['message'] = "lorem ipsum";
Mail::raw([], function ($mail) use ($payload) {
$mail->from($payload['from_email'])
->to($payload['to'])
->setBody($payload['message'], 'text/html')
->cc($payload['cc'])
->bcc($payload['bcc'])
->subject($payload['subject']);
foreach ($payload['attachments'] as $file){
$mail->attach($file);
}
});
This can be accomplished within a Mailable implementation, with plain text and html content parts:
public function build() {
// Text and html content sections we wish to use in place of view output
$bodyHtml = ...
$bodyText = ...
// Internally, Mailer::renderView($view) interprets $view as the name of a blade template
// unless, instead of string, it is set to an object implementing Htmlable,
// in which case it returns the result $view->toHtml()
$htmlViewAlternative = new class($bodyHtml) implements Htmlable {
protected string $html;
public function __construct($html) {
$this->html = $html;
}
public function toHtml(): string {
return $this->html;
}
};
// We can now set both the html and text content sections without
// involving blade templates. One minor hitch is the Mailable::view($view)
// documents $view as being a string, which is incorrect if you follow
// the convoluted downstream logic.
/** #noinspection PhpParamsInspection */
return $this
->to(...)
->from(...)
->subject(...)
->view([
'html' => $htmlViewAlternative,
'raw' => $bodyText
]);
}
Laravel mailable now has an ->html() function to be used instead of ->view() and works both with o without ->text()
laravel 9 has built in function to send HTML without view. Here is the example:
\Illuminate\Support\Facades\Mail::html($content, function ($message) {
$message->to("email#example.com")
->subject("Test dev 4")
->from("email#example.com");
});
and also if we use accepted answer will return:
Symfony\Component\Mime\Message::setBody(): Argument #1 ($body) must be
of type ?Symfony\Component\Mime\Part\AbstractPart, string given,
called in
/Users/yaskur/Sites/laravel/mail-builder/vendor/laravel/framework/src/Illuminate/Support/Traits/ForwardsCalls.php
on line 23
It's happened because laravel use new library to send email. Previously, use Swiftmailer and now use Symfony Mailer. To send HTML email without view you can also use below code:
Mail::raw("", function ($message) use ($content) {
$body = new \Symfony\Component\Mime\Part\TextPart($content);
$message->to("dyas#example.com")
->subject("Test dev")
->from("no-reply#example.com")
->setBody($body);
});
I would like display a link using a route name (home) into my template.
How can I do with Slim Framework
Thanks
My route
<?php
// index : home
$app->get('/home', function () use ($app){
$app->render('home.php');
})->name('home');
My template
<div>
my home link
</div>
or with urlFor()
<div>
my home link
</div>
I got this message
=> Call to undefined method Slim\View::urlFor()
The Slim instance is accessible through a Singleton and its getInstance method
my home link
You can also specify a name if you have multiple instances of Slim
my home link
If you want to access the urlFor method using $this
my home link
Then you should create a Custom View by adding a subclass of Slim\View containing a urlFor method and link it to Slim
Custom class :
<?php
class CustomView extends \Slim\View
{
public function urlFor($name, $params = array(), $appName = 'default')
{
return Slim::getInstance($appName)->urlFor($name, $params);
}
}
Linking :
<?php
require 'CustomView.php';
$app = new \Slim\Slim(array(
'view' => new CustomView()
));
I found the solution
just add this
$app->hook('slim.before.router', function () use ($app) {
// Pass in the App so we can use urlFor() to generate routes
$app->view()->setData('app', $app);
});
An then into your template you can use this (with app not this):
<div>
my home link
</div>
OR:
echo 'home';