PHPackages                             templateria/zenmail-php - 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. [Mail & Notifications](/categories/mail)
4. /
5. templateria/zenmail-php

ActiveLibrary[Mail & Notifications](/categories/mail)

templateria/zenmail-php
=======================

Zenmail PHP API Client

015PHP

Since Jul 13Pushed 5y ago2 watchersCompare

[ Source](https://github.com/templateria/zenmail-php)[ Packagist](https://packagist.org/packages/templateria/zenmail-php)[ RSS](/packages/templateria-zenmail-php/feed)WikiDiscussions master Synced 3d ago

READMEChangelogDependenciesVersions (1)Used By (0)

PHP Zenmail API Client
======================

[](#php-zenmail-api-client)

[Zenmail](https://zenmail.com.br) é a ferramenta de [envio de email marketing](https://zenmail.com.br/recursos/) criada pela [Templateria](https://templateria.com/). Esta biblioteca PHP é um cliente de sua API que permite a automação de qualquer recurso disponível no [painel web](https://app.zenmail.marketing).

O próprio painel do Zenmail consome sua API - essa é a nossa maneira de garantir uma API completa e fácil de usar.

Instalação
----------

[](#instalação)

Usando [Composer](https://getcomposer.org):

```
composer require templateria/zenmail-php
```

Autenticação
------------

[](#autenticação)

Solicite um token de acesso ao suporte enviando um email para .

Introdução
----------

[](#introdução)

Todas as requisições à API passam por uma instância de `Zenmail\Client`:

```
$zenmail = new Zenmail\Client([
    'token'      => 'seu token aqui'
    'account_id' => 9999
])
```

Através de interfaces fluentes, você acessa todos os recursos disponíveis na API:

```
$contact = $zenmail->contacts->get('pedro@templateria.com'); // obtém um contato pelo email
$contact = $zenmail->contacts->get(58978456);                // ou então diretamente pelo ID
```

Roadmap
-------

[](#roadmap)

Esta biblioteca encontra-se em estágio inicial de desenvolvimento. Estão disponíveis as seguintes operações:

Contatos \[x\] criar contatos \[x\] listar contatos \[x\] buscar contatos \[x\] remover contatos \[x\] atualizar contatos

Listas

\[x\] [criar uma lista](#lists-create)

\[x\] [adicionar um contato a uma lista](#lists-append)

\[x\] [buscar listas](#lists-list)

\[x\] [retornar uma lista](#lists-get)

\[x\] [remover uma lista](#lists-delete)

\[x\] [atualizar/editar uma lista](#lists-update)

Gerenciamento de Contatos
-------------------------

[](#gerenciamento-de-contatos)

### Criar um Contato

[](#criar-um-contato)

```
$zenmail->contacts->create([
    'email'   => 'pedro@templateria.com',
    'details' => ['nome' => 'Pedro']
]);
```

### Obter um Contato

[](#obter-um-contato)

```
$contact = $zenmail->contacts->get('pedro@templateria.com'); // obtém um contato pelo email
$contact = $zenmail->contacts->get(58978456);                // ou então diretamente pelo ID
```

### Listar Contatos (com busca por email)

[](#listar-contatos-com-busca-por-email)

```
// retorna todos os contatos do domínio templateria.com
$zenmail->contacts->find(['email' => '@templateria.com']);
```

### Atualizar um Contato

[](#atualizar-um-contato)

```
$zenmail->contacts->update($contact->id, [
    'details' => [
        'nome'      => 'Pedro',
        'sobrenome' => 'Padron',
        'empresa'   => 'Templateria'
    ]
]);
```

### Remover um Contato

[](#remover-um-contato)

```
$zenmail->contacts->delete($contact->id);
```

Listas
------

[](#listas)

### Criar uma Lista

[](#criar-uma-lista-)

```
$zenmail->contactLists->create(['name' => 'Assinantes da Newsletter']);
```

### Adicionar um Contato a uma Lista

[](#adicionar-um-contato-a-uma-lista-)

Se o contato ainda não existe na conta, ele será criado automaticamente. Se o contato já existe em alguma outra lista, ele apenas será adicionado a mais uma lista.

```
$zenmail->contactLists->append($listId, ['email' => 'pedro@templateria.com']);
```

### Buscar uma Lista por Nome

[](#buscar-uma-lista-por-nome-)

```
$lists = $zenmail->contactLists->find(['name' => 'Assinantes da Newsletter']);
```

### Retornar uma Lista

[](#retornar-uma-lista-)

```
$lists = $zenmail->contacts->get(['name' => 'Assinantes da Newsletter']);
```

### Atualizar/Editar uma Lista

[](#atualizareditar-uma-lista-)

```
$listId = 9999;
$zenmail->contactLists->update($listId, ['name' => 'Assinantes da Newsletter pelo Site']);
```

### Remover uma Lista

[](#remover-uma-lista-)

```
$listId = 9999;
$lists  = $zenmail->contactLists->delete($listId);
```

Campanhas
---------

[](#campanhas)

### Obter uma Campanha

[](#obter-uma-campanha)

```
$zenmail->campaigns->get(12345);
```

### Listar Campanhas

[](#listar-campanhas)

```
foreach ($zenmail->campaigns->all() as $campaign) {
    echo 'Campanha #' . $campaign->id . ': ' . $campaign->subject;
}
```

```
$page = 1;

do {
    $campaigns = $zenmail->campaigns->find(['page' => $page]);
    $lastPage  = $campaigns->getPaginationData()->last_page;
    foreach ($campaigns as $campaign) {
        echo 'Campanha #' . $campaign->id . ': ' . $campaign->subject . "\n";
    }
    $page++;
} while ($page campaigns->create([
    'recipients' => 'lists',
    'list_ids'   => [329104],
    'subject'    => 'Novidades do Zenmail',
    'from_name'  => 'Zenmail',
    'from_email' => 'suporte@zenmail.com.br',
    'html'       => $html,
]);
```

### Enviando uma Campanha

[](#enviando-uma-campanha)

```
$zenmail->campaigns->send($campaign->id);
```

### Editando uma Campanha

[](#editando-uma-campanha)

```
$campaign = $zenmail->campaigns->update([
    'recipients' => 'all'
]);
```

### Remover uma Campanha

[](#remover-uma-campanha)

```
$zenmail->campaigns->delete($campaign->id);
```

Suporte
-------

[](#suporte)

Acesse nossa [documentação](https://zenmail.com.br/ajuda) para saber mais sobre o *Zenmail* e envie um email para  caso tenha alguma dúvida.

Segurança
---------

[](#segurança)

Para questões de segurança como vulnerabilidades encontradas ou outros assuntos, envie um email para .

Changelog
---------

[](#changelog)

Detalhes sobre cada versão desta biblioteca estão disponíveis no arquivo [CHANGELOG.md](CHANGELOG.md).

Licença
-------

[](#licença)

MIT License. Copyright 2019 Templateria Ltda. Por favor, veja o [Arquivo de Licença](LICENSE.md) para mais informações.

###  Health Score

17

—

LowBetter than 6% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity6

Limited adoption so far

Community4

Small or concentrated contributor base

Maturity33

Early-stage or recently created project

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.

### Community

Maintainers

![](https://www.gravatar.com/avatar/19848b1226f4de3911341dc1179933f020c55dd9b2fb5a738922b2bf22ebe203?d=identicon)[ppadron](/maintainers/ppadron)

### Embed Badge

![Health badge](/badges/templateria-zenmail-php/health.svg)

```
[![Health](https://phpackages.com/badges/templateria-zenmail-php/health.svg)](https://phpackages.com/packages/templateria-zenmail-php)
```

###  Alternatives

[tijsverkoyen/css-to-inline-styles

CssToInlineStyles is a class that enables you to convert HTML-pages/files into HTML-pages/files with inline styles. This is very useful when you're sending emails.

5.8k505.3M227](/packages/tijsverkoyen-css-to-inline-styles)[minishlink/web-push

Web Push library for PHP

1.9k12.0M53](/packages/minishlink-web-push)[laravel-notification-channels/twilio

Provides Twilio notification channel for Laravel

2587.7M12](/packages/laravel-notification-channels-twilio)[spatie/url-signer

Generate a url with an expiration date and signature to prevent unauthorized access

4422.3M16](/packages/spatie-url-signer)[mattketmo/email-checker

Throwaway email detection library

2742.0M5](/packages/mattketmo-email-checker)[laravel-notification-channels/discord

Laravel notification driver for Discord.

2371.3M11](/packages/laravel-notification-channels-discord)

PHPackages © 2026

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