PHP code example of beziworld / laravel-mailcow

1. Go to this page and download the library: Download beziworld/laravel-mailcow library. Choose the download type require.

2. Extract the ZIP file and open the index.php.

3. Add this code to the index.php.
    
        
<?php
require_once('vendor/autoload.php');

/* Start to develop here. Best regards https://php-download.com/ */

    

beziworld / laravel-mailcow example snippets


use Beziworld\Mailcow\Exceptions\ApiException;
use Beziworld\Mailcow\Facades\Mailcow;

try {
    Mailcow::domains()->create('shop.example.com', mailboxes: 25, quotaMb: 51200, defaultMailboxQuotaMb: 2048);
    Mailcow::dkim()->generate('shop.example.com', selector: 'dkim', keySize: 2048);
    Mailcow::mailboxes()->create('[email protected]', $password, quotaMb: 4096, name: 'Office');
    Mailcow::aliases()->create('[email protected]', '[email protected]');
} catch (ApiException $e) {
    // $e->errorKey(): "domain_exists", "mailbox_quota_exceeded", ...; $e->messages() lists every failed item
    report($e);
}

$dkim = Mailcow::dkim()->get('shop.example.com');
// Publish $dkim->recordName() ("dkim._domainkey.shop.example.com") as TXT with $dkim->txt

foreach (Mailcow::domains()->all() as $domain) {
    // $domain->name, $domain->mailboxes, $domain->maxMailboxes, $domain->usedBytes, $domain->usagePercent()
}

Mailcow::domains()->update('shop.example.com', ['mailboxes' => 50, 'description' => 'Shop']);
Mailcow::domains()->activate('shop.example.com', false);
Mailcow::domains()->setRateLimit('shop.example.com', 500, 'h');
Mailcow::domains()->createAliasDomain('shop.example.net', 'shop.example.com');
Mailcow::domains()->delete('old.example.com');

$mailboxes = Mailcow::mailboxes()->all('shop.example.com');   // list<Mailbox>
$mailbox = Mailcow::mailboxes()->get('[email protected]');

Mailcow::mailboxes()->changePassword('[email protected]', $newPassword, forceUpdate: true);
Mailcow::mailboxes()->update('[email protected]', ['name' => 'Front office', 'sogo_access' => '1']);
Mailcow::mailboxes()->setSenderAcl('[email protected]', ['default', '[email protected]']);
Mailcow::mailboxes()->activate('[email protected]', false);
Mailcow::mailboxes()->delete('[email protected]');

Mailcow::quotas()->setMailbox('[email protected]', 8192);            // MB
Mailcow::quotas()->setDomain('shop.example.com', 102400, maxMailboxQuotaMb: 20480);

foreach (Mailcow::quotas()->nearlyFull(90) as $mailbox) {
    Notification::route('mail', $mailbox->username)->notify(new MailboxAlmostFull($mailbox->percentInUse));
}

Mailcow::quotas()->storage();   // ['total' => '41G', 'used' => '11G', 'used_percent' => '28%', ...]

Mailcow::aliases()->create('[email protected]', ['[email protected]', '[email protected]']);
Mailcow::aliases()->createCatchAll('shop.example.com', '[email protected]');
Mailcow::aliases()->createBlackhole('[email protected]');
Mailcow::aliases()->createTimeLimited('[email protected]', validityHours: 72, description: 'Trade fair');

$alias = Mailcow::aliases()->find('[email protected]');
Mailcow::aliases()->update($alias->id, ['goto' => '[email protected]']);
Mailcow::aliases()->delete($alias->id);

Mailcow::appPasswords()->create('[email protected]', 'Phone', $appPassword, ['imap_access', 'smtp_access']);

foreach (Mailcow::appPasswords()->of('[email protected]') as $app) {
    // $app->id, $app->name, $app->active
}

Mailcow::appPasswords()->delete($id);

$deferred = Mailcow::queue()->all();          // list<QueueItem>
Mailcow::queue()->flush();                    // retry every deferred message now
Mailcow::queue()->hold('B98C6260CA1');
Mailcow::queue()->release('B98C6260CA1');
Mailcow::queue()->delete('B98C6260CA1');

Mailcow::quarantine()->all();
Mailcow::quarantine()->release(33);

foreach (Mailcow::logs()->postfix(200) as $entry) {
    // $entry->time, $entry->program, $entry->priority, $entry->message
}
Mailcow::logs()->get('netfilter', 50);

Mailcow::status()->version();               // "2026-11"
Mailcow::status()->stoppedContainers();     // ["clamd-mailcow"]

// config/mailcow.php
'connections' => [
    'default' => [...],
    'eu' => ['url' => env('MAILCOW_EU_URL'), 'api_key' => env('MAILCOW_EU_KEY')],
],

Mailcow::connection('eu')->mailboxes()->all();

Mailcow::using(['url' => $server->url, 'api_key' => decrypt($server->api_key)])->status()->version();

Mailcow::get('get/bcc/all');
Mailcow::post('add/bcc', ['local_dest' => 'shop.example.com', 'bcc_dest' => '[email protected]', 'type' => 'sender']);
bash
php artisan mailcow:check