See how to send emails in Athenna.
Sending email doesn't have to be complicated. Athenna provides a -clean, simple email API powered by the popular [nodemailer] package. -Right now Athenna provide drivers for sending email via SMTP, only -but in the future we will add support for Mailgun, Mailtrap, -Amazon SES, and sendmail.
+clean, simple email API powered by the popular nodemailer +package. Right now Athenna provide drivers for sending email via +SMTP only, but in the future we will add support for Mailgun, +Mailtrap, Amazon SES, and sendmail.First of all you need to install @athenna/mail package
and configure it. Artisan provides a very simple command to
@@ -65,34 +65,37 @@
Let's see the simplest way to send a mail using Mail facade:
-import { Mail } from '@athenna/mail'
await Mail.from('support@athenna.io')
.to('user@gmail.com')
.text('Mail content')
.send()
import { Mail } from '@athenna/mail'
await Mail.from('support@athenna.io')
.to('user@gmail.com')
.content('<h1>Mail content</h1>')
.send()
You can add "to", "cc" and "bcc" recipientes by chaining their respective method together:
-await Mail.from('support@athenna.io')
.to('user@gmail.com')
.cc('txsoura@athenna.io')
.bcc('support@athenna.io')
.text('Mail content')
.send()
await Mail.from('support@athenna.io')
.to('user@gmail.com')
.cc('txsoura@athenna.io')
.bcc('support@athenna.io')
.content('<h1>Mail content</h1>')
.send()
By default, Athenna will send email using the mailer configured
as the default mailer in your application's mail configuration
file. However, you may use the mailer() method to send a message
using a specific mailer configuration:
await Mail.mailer('my-mailer')
.from('support@athenna.io')
.to('lenon@athenna.io')
.text('Mail content')
.send()
To send HTML as the content of the mail, you can use the html()
-method:
await Mail.mailer('my-mailer')
.from('support@athenna.io')
.to('lenon@athenna.io')
.html('<h1>Mail content</h1>')
.send()
And for markdowns you can use the markdown() method:
await Mail.mailer('my-mailer')
.from('support@athenna.io')
.to('lenon@athenna.io')
.markdown('# Mail content')
.send()
await Mail.mailer('my-mailer') 👈
.from('support@athenna.io')
.to('lenon@athenna.io')
.content('Mail content')
.send()
To send text as the content of the mail, you can set the
+type property in second argument:
await Mail.mailer('my-mailer')
.from('support@athenna.io')
.to('lenon@athenna.io')
.content('Mail content', { type: 'text' }) 👈
.send()
And for markdowns you can use the markdown type:
await Mail.mailer('my-mailer')
.from('support@athenna.io')
.to('lenon@athenna.io')
.content('# Mail content', { type: 'markdown' }) 👈
.send()
The mail component is integrated with the view component to be
able to render and send a view as the body of the email. To do
so you can use the view() method of the Mail facade:
const userEmail = 'lenon@athenna.io'
await Mail.from('support@athenna.io')
.to(userEmail)
.view('mail/welcome', { email: userEmail })
.send()
const userEmail = 'lenon@athenna.io'
await Mail.from('support@athenna.io')
.to(userEmail)
.cc('mailer1@athenna.io, mailer2@athenna.io')
.bcc('mailer3@athenna.io, mailer4@athenna.io')
.content('This is the mail body')
.view('mail/welcome', { email: userEmail }) 👈
.send()
Any data that you provide using the Mail facade will be
+available to you in your view:
<!-- Provided by you also but using Mail facade -->
<h1>{{ to }}</h1>
<h1>{{ cc }}</h1>
<h1>{{ bcc }}</h1>
<h1>{{ from }}</h1>
<h1>{{ content }}</h1>
<!-- Provided by you in second argument -->
<h1>{{ email }}</h1>
When designing a mailable's template, it is convenient to quickly
preview the rendered mailable in your browser like a typical
Edge template. For this reason, Athenna allows you to return any
-mailable directly from a route closure or controller by using the
-response.view() method, allowing you to quickly preview its
-design without needing to send it to an actual email address:
Route.get('/mailable', ({ response }) => {
return response.view('mail.welcome', { email: 'lenon@athenna.io' })
})
Route.view() method,
+allowing you to quickly preview its design without needing to
+send it to an actual email address:
+Route.view('/mailable', 'mail.welcome', { email: 'lenon@athenna.io' })