init project

Author: samuraee

.idea/.gitignore

@@ -0,0 +1,23 @@
+{
+  "name": "php-monstaers/laravel-postal-driver",
+  "description": "Laravel mail transport driver for Postal API",
+  "type": "library",
+  "require": {
+    "php": "^8.0",
+    "guzzlehttp/guzzle": "^7.0"
+  },
+  "autoload": {
+    "psr-4": {
+      "PhpMonsters\\LaravelPostalDriver\\": "src/"
+    }
+  },
+  "extra": {
+    "laravel": {
+      "providers": [
+        "PhpMonsters\\LaravelPostalDriver\\PostalTransportServiceProvider"
+      ]
+    }
+  },
+  "minimum-stability": "dev",
+  "prefer-stable": true
+}

.idea/github.laravel-postal-driver.iml

@@ -0,0 +1,46 @@
+<?php
+
+namespace PhpMonsters\LaravelPostalDriver;
+
+use Illuminate\Mail\Transport\Transport;
+use Swift_Mime_SimpleMessage;
+use GuzzleHttp\Client;
+
+class PostalTransport extends Transport
+{
+    protected string $key;
+    protected string $endpoint;
+    protected Client $client;
+
+    public function __construct(string $key, string $endpoint)
+    {
+        $this->key = $key;
+        $this->endpoint = rtrim($endpoint, '/');
+        $this->client = new Client();
+    }
+
+    public function send(Swift_Mime_SimpleMessage $message, &$failedRecipients = null): int
+    {
+        $to = array_keys($message->getTo())[0];
+        $from = array_keys($message->getFrom())[0];
+        $subject = $message->getSubject();
+        $html = $message->getBody();
+        $plain = strip_tags($html);
+
+        $response = $this->client->post($this->endpoint . '/api/v1/send/message', [
+            'headers' => [
+                'X-Server-API-Key' => $this->key,
+                'Content-Type' => 'application/json'
+            ],
+            'json' => [
+                'to' => $to,
+                'from' => $from,
+                'subject' => $subject,
+                'plain_body' => $plain,
+                'html_body' => $html
+            ]
+        ]);
+
+        return $this->numberOfRecipients($message);
+    }
+}

.idea/modules.xml

@@ -0,0 +1,19 @@
+<?php
+
+namespace PhpMonsters\LaravelPostalDriver;
+
+use Illuminate\Mail\MailManager;
+use Illuminate\Support\ServiceProvider;
+
+class PostalTransportServiceProvider extends ServiceProvider
+{
+    public function boot(): void
+    {
+        $this->app->make(MailManager::class)->extend('postal', function ($config) {
+            return new PostalTransport(
+                $config['key'],
+                $config['endpoint'] ?? 'https://postal.yourdomain.com'
+            );
+        });
+    }
+}

.idea/php.xml

@@ -1,2 +1,107 @@
-# Laravel-Postal-Driver
-laravel-postal-driver
+# Laravel Postal Mail Driver
+
+A custom Laravel mail transport driver to send emails via the [Postal](https://postal.atech.media) mail server using its **HTTP API** instead of SMTP.
+
+---
+
+## 📦 Features
+
+- Send transactional emails via Postal HTTP API
+- Uses Laravel's native `Mail::to()->send()` interface
+- Clean, framework-native mail transport driver
+- Compatible with Laravel version 8.0+
+
+---
+
+## 🚀 Installation
+
+### Step 1: Require the package (from local path or Git)
+
+If using local development:
+
+```bash
+composer require php-monsters/laravel-postal-driver
+```
+
+Or add to your composer.json:
+
+```json
+"repositories": [
+  {
+    "type": "path",
+    "url": "./packages/PhpMonsters/LaravelPostalDriver"
+  }
+],
+"require": {
+  "php-monsters/laravel-postal-driver": "*"
+}
+```
+Then run:
+```bash
+composer update
+```
+
+## ⚙️ Configuration
+### Step 2: Set up .env variables
+```dotenv
+MAIL_MAILER=postal
+POSTAL_API_KEY=your_postal_api_key_here
+POSTAL_API_ENDPOINT=https://postal.yourdomain.com
+```
+
+### Step 3: Configure config/mail.php
+Add to the mailers array:
+```php
+'mailers' => [
+    'postal' => [
+        'transport' => 'postal',
+        'key' => env('POSTAL_API_KEY'),
+        'endpoint' => env('POSTAL_API_ENDPOINT'),
+    ],
+],
+```
+
+## ✉️ Usage
+Use Laravel's standard Mail facade:
+```php
+use App\Mail\TestMail;
+use Illuminate\Support\Facades\Mail;
+
+Mail::to('[email protected]')->send(new TestMail());
+```
+Your Mailable class should work as usual.
+
+## 📐 Under the Hood
+This driver makes HTTP POST requests to:
+```bash
+POST /api/v1/send/message
+```
+With headers:
+```http request
+X-Server-API-Key: {your_api_key}
+Content-Type: application/json
+```
+Payload:
+
+```json
+{
+  "to": "[email protected]",
+  "from": "[email protected]",
+  "subject": "Subject Line",
+  "plain_body": "Text version",
+  "html_body": "<p>HTML version</p>"
+}
+```
+
+## 🛠 Requirements
+- Laravel 8 or newer 
+- Postal mail server with API access 
+- PHP 8.0+ 
+- Guzzle 7+
+
+## 📝 License
+This project is open-sourced under the MIT license.
+
+## 🤝 Credits
+Made with ❤️ by Aboozar Ghaffari
+Postal by [Atech Media](https://postal.atech.media)