PHPackages                             aldoanizio/carteiro - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Framework](/categories/framework)
4. /
5. aldoanizio/carteiro

ActiveLibrary[Framework](/categories/framework)

aldoanizio/carteiro
===================

Lightweight SMTP Mailer Class for Mako Framework 4.2

2.0.x-dev(10y ago)0146PHP

Since Oct 26Pushed 10y ago1 watchersCompare

[ Source](https://github.com/aldoanizio/carteiro)[ Packagist](https://packagist.org/packages/aldoanizio/carteiro)[ Docs](https://github.com/aldoanizio/carteiro)[ RSS](/packages/aldoanizio-carteiro/feed)WikiDiscussions master Synced 4d ago

READMEChangelogDependenciesVersions (3)Used By (0)

Carteiro Mailer
===============

[](#carteiro-mailer)

This is a lightweight SMTP mailer package for Mako Framework >=4.2.

Install
-------

[](#install)

Use composer to install. Simply add package to your project.

```
composer require aldoanizio/carteiro:*
```

So now you can update your project with a single command.

```
composer update
```

### Register Service

[](#register-service)

After installing you'll have to register the package in your `app/config/application.php` file.

```
    /**
     * ---------------------------------------------------------
     * Packages
     * ---------------------------------------------------------
     *
     * Packages to boot during the application boot sequence.
     * They will be booted in the order that they are defined.
     */

    'packages' =>
    [
        ....
        'aldoanizio\carteiro\CarteiroPackage',
    ],
```

### Configuring

[](#configuring)

There are two ways to configure your package. The first is editing config file directly in packages folder: `app/packages/carteiro/config/config.php` and input the necessary information.

If you like you can copy the package's config file `app/packages/carteiro/config/config.php` into `app/config/packages/carteiro` folder and the application will load that file instead of the one located in the package. This makes it possible to update the package while keeping your custom settings.

Basic Usage
-----------

[](#basic-usage)

To send emails just use the `create` method parsing some data.

```
$this->carteiro->create('my.email.view', $data, function($mail)
{
    $mail->subject('Hello World');

    $mail->to('foo@bar.com', 'John Doe');
});
```

The first argument passed to the `create` method is the name of the view that should be used as the e-mail body. If passed as string will set mail body to use `html` format.

The second is the `$data` that should be passed to the view.

The third is a Closure allowing you to specify various options on the e-mail message. Also using closure you can access other variables.

#### Message format

[](#message-format)

You can also specify a plain text view to use in addition to an `html` view. To do this you need to use an array to define wich view to use in each format.

```
$this->carteiro->create(['text' => 'my.text.view', 'html' => 'my.html.view'], $data, function($mail) use ($newUser)
{
    $mail->subject('Welcome New User');

    $mail->to($newUser->email, $newUser->name);
}
```

Or just use `text` key to send email as a plain text only.

```
$this->carteiro->create(['text' => 'my.text.view'], $data, function($mail) use ($newUser)
{
    $mail->subject('Welcome New User');

    $mail->to($newUser->email, $newUser->name);
}
```

#### Raw content data

[](#raw-content-data)

Sometimes you need to send emails using a content that do not depends of a view file. For example if you would like to send a custom message to one of your customers stored in database.

To do this you can make use of `raw` key to parse a custom content. Notice in this case you don't need to use a view data so pass an empty array to second parameter.

```
// Your form post data
$postData = $this->request->post();

// ORM
$customer = Custommer::get($postData['customer_id']);

// Send message
$this->carteiro->create(['raw' => $postData['message']], [], function($mail) use ($postData, $customer)
{
    $mail->subject($postData['subject']);

    $mail->to($customer->email, $customer->name);
});
```

Mail options
------------

[](#mail-options)

You may specify other options on the e-mail message such as any carbon copies or attachments as well.

### Set email subject

[](#set-email-subject)

```
$mail->subject('Welcome User');
```

### Set email "From" and "Reply-To" address / name

[](#set-email-from-and-reply-to-address--name)

Instead use information stored in config file you can use array or string to set 'from' and 'reply-to' addresses / name.

```
$address = ['webmaster@domain.tld', 'System Webmaster'];

// From
$mail->from($address);
// or
$mail->from('webmaster@domain.tld', 'System Webmaster');

// Reply To
$mail->reply($address);
// or
$mail->reply('webmaster@domain.tld', 'System Webmaster');
```

### Set email receiver addresses / names.

[](#set-email-receiver-addresses--names)

You can define multiples recipients (name is optional).

```
// Add to
$mail->to('receiver1@domain.tld');
$mail->to('receiver2@domain.tld');
```

You can add multiples using array.

```
// Build list
$list = [];
$list[] = 'receiver1@domain.tld';
$list[] = 'receiver2@domain.tld';

// List with names
$list = [];
$list[] = ['receiver1@domain.tld', 'Receiver 1'];
$list[] = ['receiver1@domain.tld', 'Receiver 2'];

// Add to
$mail->to($list);
```

### Add carbon copy addresses / names

[](#add-carbon-copy-addresses--names)

The `cc` option works like `to`option even using multiples recipients.

```
$mail->cc('carboncopy1@domain.tld', 'Copy Receiver 1');

// or

$mail->cc($list);
```

### Add blind carbon copy addresses / names

[](#add-blind-carbon-copy-addresses--names)

The `bcc` option works like `to`option even using multiples recipients.

```
$mail->bcc('blindcarboncopy1@domain.tld', 'Blind Copy Receiver 1');

// or

$mail->bcc($list);
```

### Attach files to email

[](#attach-files-to-email)

You can add attachments.

```
$mail->attach('/path/to/file1.png');
$mail->attach('/path/to/file2.png');
```

### Debug Mode

[](#debug-mode)

In config file you can flag `'debug_mode' = true;`, which can be helpful in testing your SMTP connections. It will write log files with server responses from each step in the email sending process.

Or you can enable/disable debug mode just in some cases without edit config file.

```
$mail->debug(true);

$mail->debug(false);
```

### Change debug file path

[](#change-debug-file-path)

By default the package uses default mako debug files but you can define another debug file location. Use the `'debugFilePath()'` method to change file location.

When you call this method you don't need to enable debug using `$mail->debug(true)`.

```
$mail->debugFilePath('my/new/file/path');
```

### Change server parameters

[](#change-server-parameters)

In config file you can define multiple `connections`, each of them with their own settings. The default connection settings used is defined in `'default' => 'primary'` flag.

Sometimes you may want to change which connection will be used. You can do this 'on-the-fly'.

```
$mail->useConn('my_other_connection');
```

Also, you can define server parameters that are not included in config file.

```
$mail->setConn('server_host_addr', 'server_conn_port', (null|'ssl'|'tls'), (true|false), 'my_auth_user_name', 'my_auth_password');
```

### Change localhost domain name

[](#change-localhost-domain-name)

You may want to change the origin of the HELO / EHLO request.

Setting default value as "localhost" may cause email to be considered spam.

```
$mail->setLocalhost('my.host.domain.name');
```

Credits
-------

[](#credits)

This package was build in top of Laravel SMTP class by swt83 - ()

Limitations
-----------

[](#limitations)

Just like original class, this package has some limitations. Please feel free to contribute to this project.

- Does not support encryption.
- Does not support priority level.
- Does not keep connection open for spooling email sends.

###  Health Score

24

—

LowBetter than 32% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity10

Limited adoption so far

Community4

Small or concentrated contributor base

Maturity50

Maturing project, gaining track record

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~0 days

Total

2

Last Release

3854d ago

Major Versions

1.0.x-dev → 2.0.x-dev2015-10-26

### Community

Maintainers

![](https://www.gravatar.com/avatar/0bbb75946e7d75134253ef101e005e3b645577ef13c754d9ca2264f91377359e?d=identicon)[aldoanizio](/maintainers/aldoanizio)

---

Tags

frameworkmailmako

### Embed Badge

![Health badge](/badges/aldoanizio-carteiro/health.svg)

```
[![Health](https://phpackages.com/badges/aldoanizio-carteiro/health.svg)](https://phpackages.com/packages/aldoanizio-carteiro)
```

###  Alternatives

[mako/framework

Mako Framework

249170.3k23](/packages/mako-framework)[mako/app

Mako Framework

335.0k](/packages/mako-app)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)