README.md
# Kirby 3 mail-tester.com
[](https://travis-ci.com/bnomei/kirby3-mailtester)
[](https://coveralls.io/github/bnomei/kirby3-mailtester)
[](https://codeclimate.com/github/bnomei/kirby3-mailtester)
[](https://twitter.com/bnomei)
## Install
Using composer:
```bash
composer require getkirby/cli bnomei/kirby3-janitor bnomei/kirby3-mailtester
```
Since the Kirby CLI can only be installed with composer using gitsubmodules or installation from ZIP files is not recommended.
## Commercial Usage
> <br>
> <b>Support open source!</b><br><br>
> This plugin is free but if you use it in a commercial project please consider to sponsor me or make a donation.<br>
> If my work helped you to make some cash it seems fair to me that I might get a little reward as well, right?<br><br>
> Be kind. Share a little. Thanks.<br><br>
> ‐ Bruno<br>
>
| M | O | N | E | Y |
|---|----|---|---|---|
| [Github sponsor](https://github.com/sponsors/bnomei) | [Patreon](https://patreon.com/bnomei) | [Buy Me a Coffee](https://buymeacoff.ee/bnomei) | [Paypal dontation](https://www.paypal.me/bnomei/15) | [Hire me](mailto:b@bnomei.com?subject=Kirby) |
## Usage
You need to forward the data you want to send (`from, subject, body[text,html], transport?`) to the command as [JSON string](https://www.php.net/manual/en/function.json-encode.php). The example shows a `$page->emailDataJSON()`-method but that is something you need to implement yourself.
**site/blueprints/default.yml**
```yml
fields:
mailtester_spam:
type: janitor
command: 'mailtester:spam --to MAILTESTER_USERNAME --data {( page.emailDataJSON )}'
label: Test to current User
icon: mailtester
```
> Note: The command is using the Janitor-only delayed resolution of query language with `{( query )}` in its panel button for the data argument. The argument will not be resolved on every panel view but only when Janitor receives the api call after the button press.
When calling the command using PHP you need to provide the `page` argument yourself to allow the `data` arguments query to be resolved.
```php
var_dump(
janitor()->command(
'mailtester:spam' .
' --to MAILTESTER_USERNAME' .
' --data {{ page.emailDataJSON }}' .
' --page ' . $page->uuid()
)
);
```
### Username (paid accounts)
You can set your [paid mail-tester.com account](https://www.mail-tester.com/manager/) to an environment variable and let it be loaded it with my [dotenv plugin](https://github.com/bnomei/kirby3-dotenv). Doing that you do not need to provide the `--to` argument in the command.
```dotenv
MAILTESTER_USERNAME=myusername
```
## Dependencies
- [Kirby CLI](https://github.com/getkirby/cli)
- [mail-tester.com](https://www.mail-tester.com)
## Disclaimer
This plugin is provided "as is" with no guarantee. Use it at your own risk and always test it yourself before using it in a production environment. If you find any issues, please [create a new issue](https://github.com/bnomei/kirby3-mailtester/issues/new).
## License
[MIT](https://opensource.org/licenses/MIT)
It is discouraged to use this plugin in any project that promotes racism, sexism, homophobia, animal abuse, violence or any other form of hate speech.