README

The MultiTenantMailer is a powerful and flexible email-sending library designed for multi-tenant applications. It simplifies the process of configuring and sending emails while supporting multiple tenants with different settings.

Features

• Support for multiple tenants with unique SMTP configurations.
• Easy-to-use API for setting up email properties (host, port, username, etc.).
• Ability to queue emails for background processing.
• Support for HTML and plain text emails.

Installation

1. Install via Composer: If you haven't done so, install the package using Composer:

   composer require khaleejinfotech/multi-tenant-mailer

2. Register the service provider: Open your config/app.php file and add the service provider to the providers array.

   'providers' => [
       // ...
       Khaleejinfotech\MultiTenantMailer\MultiTenantMailerServiceProvider::class,
   ],

3. Publish Configuration: After installation, publish the configuration file and any required resources:

   php artisan vendor:publish --provider="Khaleejinfotech\MultiTenantMailer\MultiTenantMailerServiceProvider" 

Configuration

You can configure the queue_class in the published configuration file (config/multi-tenant-mailer.php) like this:

return [
    'queue_class' => \Khaleejinfotech\MultiTenantMailer\Jobs\MultiTenantMailerQueued::class,
];

Usage

MultiTenantMailer

Initialize the Mailer

use Khaleejinfotech\MultiTenantMailer\MultiTenantMailer;

$mailer = new MultiTenantMailer();
$mailer->init($host, $port, $username, $password, $encryption);

Set Email Properties

$mailer->setFrom($fromAddresses, $fromName)
  ->setTo($toAddresses, $toName)
  ->setSubject($subject)
  ->setBody($body)
  ->setContentType('text/html')
  ->setAttachments($attachments)
  ->shouldQueue(); // Optional: Set to true if you want to queue the email

Send the Email

$mailer->send();

MultiTenantMailerSettings

Create and Configure Settings

use Khaleejinfotech\MultiTenantMailer\Contracts\MultiTenantMailerSettings;

$mailerSettings = new MultiTenantMailerSettings();
$mailerSettings->setHost($host)
   ->setPort($port)
   ->setUsername($username)
   ->setPassword($password)
   ->setEncryption($encryption)
   ->setFromAddress($fromAddress, $fromName);

by this you can directly pass the settings object to the mailer instance.
Here is the example

use Khaleejinfotech\MultiTenantMailer\MultiTenantMailer;

$mailer = new MultiTenantMailer();
$mailer->withSettings($mailerSettings);

Using Facades

If you prefer to use facades for cleaner syntax, you can utilize the facades you've created.

Using MultiTenantMailer Facade

use Khaleejinfotech\MultiTenantMailer\Facades\MultiTenantMailer;

MultiTenantMailer::init($host, $port, $username, $password, $encryption)
  ->setFrom($fromAddresses, $fromName)
  ->setTo($toAddresses, $toName)
  ->setSubject($subject)
  ->setBody($body)
  ->setContentType('text/html')
  ->setAttachments($attachments)
  ->shouldQueue()
  ->send();

Using MultiTenantMailerSettings Facade

use Khaleejinfotech\MultiTenantMailer\Facades\MultiTenantMailerSettings;

MultiTenantMailerSettings::setHost($host)
  ->setPort($port)
  ->setUsername($username)
  ->setPassword($password)
  ->setEncryption($encryption)
  ->setFromAddress($fromAddress, $fromName);

Notification Driver Support

public function via(object $notifiable): array
{
    return ['tenant_mailer'];
}

public function toTenantMailer($notifiable): MultiTenantMailer
{
    return (new MultiTenantMailer)
        ->setHost(config('mail.mailers.smtp.host'))
        ->setPort(config('mail.mailers.smtp.port'))
        ->setUsername(config('mail.mailers.smtp.username'))
        ->setPassword(config('mail.mailers.smtp.password'))
        ->setEncryption(config('mail.mailers.smtp.encryption'))
        ->setFrom(config('mail.from.address'))
        ->setTo($notifiable)
        ->setSubject('Subject')
        ->setBody($this->toMail($notifiable)->render());
}

the setBody() can have either Notification/Mailable or the self mailable method to render the message;

1. Notification/Mailable Object

->setBody(new MailTestMessge()); 

2. Self $this->toMail($notifiable)->render() method

->setBody($this->toMail($notifiable)->render()); 

Queues

The MultiTenantMailer class provides the ability to define specific queues for processing emails, giving you control over how and when emails are queued.

Setting the Queue

You can set a queue name or identifier using the setOnQueue method. This allows you to specify a queue that suits your system’s job-handling requirements.

->onQueue('emails'); 

Events

The library includes the following events:

MailFailed: Triggered when sending an email fails.

MailSuccess: Triggered when an email is sent successfully.

Available Methods

Class MultiTenantMailer

Class MultiTenantMailerSettings

Exception Handling

The MultiTenantMailer class throws MultiTenantMailerException when the required properties (host, port, username, etc.) are not set. Be sure to handle these exceptions to avoid runtime errors.

Contributing

Contributions are welcome! Please submit a pull request or open an issue for any improvements or bugs you encounter.