Mail

Register MailServiceProvider and add config/mail.ts:

export default {
  default: 'log',
  from: { address: '[email protected]', name: 'Tyravel' },
  connections: {
    log: { driver: 'log', channel: 'stdout' },
    array: { driver: 'array' },
    smtp: {
      driver: 'smtp',
      host: env('SMTP_HOST', '127.0.0.1'),
      port: Number(env('SMTP_PORT', 1025)),
      username: env('SMTP_USERNAME', ''),
      password: env('SMTP_PASSWORD', ''),
      encryption: env('SMTP_ENCRYPTION', ''),
    },
  },
} as const;

Sending mail

Use the Mail facade:

import { Mail } from '@tyravel/core';

// Quick message
await Mail.to('[email protected]').send({
  subject: 'Welcome!',
  html: '<h1>Welcome aboard</h1>',
  text: 'Welcome aboard',
});

Mailable classes

For reusable mail logic, extend Mailable:

import { Mailable, type MailMessage } from '@tyravel/mail';

export class WelcomeMail extends Mailable {
  constructor(private readonly name: string) {
    super();
  }

  override build(): MailMessage {
    return {
      subject: `Welcome, ${this.name}!`,
      htmlView: 'emails.welcome',
      textView: 'emails.welcome-text',
      viewData: { name: this.name },
    };
  }

  // Queue this mailable instead of sending immediately
  override shouldQueue(): boolean {
    return true;
  }

  connection = 'database';
  queue = 'emails';
}

Send it:

await Mail.to('[email protected]').send(new WelcomeMail('Ada'));

Using .tyr views

When you register a ViewServiceProvider and set the view engine, mailable's htmlView and textView are resolved from resources/views/:

resources/views/emails/welcome.tyr
resources/views/emails/welcome-text.tyr

The mail package ships with default HTML and text message layouts at @tyravel/mail namespace — use them in your views:

@layout('mail::html.message')

@section('body')
  <h1>Hello {{ name }}</h1>
  <p>Welcome to the app!</p>
@endsection

Transports

Driver	Description
smtp	Send over SMTP (production)
log	Write to a log channel (development)
array	Collect messages in memory (testing)

Queued mail

Mark a mailable as queued by overriding shouldQueue() to return true. The mail manager will dispatch it through the queue system instead of sending immediately. Configure which queue connection to use:

export class WelcomeMail extends Mailable {
  override shouldQueue(): boolean {
    return true;
  }
  connection = 'database'; // queue connection from config/queue.ts
  queue = 'emails';
  delaySeconds = 30; // send 30 seconds from now
}

Service provider registration

import { MailServiceProvider } from '@tyravel/core';

app.register(MailServiceProvider);
await app.boot();

Then wire the facade:

import { setMailApplication } from '@tyravel/core';

setMailApplication(app);

If you use mail views, also set the view engine:

const mail = app.make<MailManager>('mail');
mail.setViewEngine(app.make<ViewEngine>('view.engine'));