README

Install

Using composer:

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

Support open source!

This plugin is free but if you use it in a commercial project please consider to sponsor me or make a donation.
If my work helped you to make some cash it seems fair to me that I might get a little reward as well, right?

Be kind. Share a little. Thanks.

‐ Bruno

Usage

You need to forward the data you want to send (from, subject, body[text,html], transport?) to the command as JSON string. The example shows a $page->emailDataJSON()-method but that is something you need to implement yourself.

site/blueprints/default.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.

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 to an environment variable and let it be loaded it with my dotenv plugin. Doing that you do not need to provide the --to argument in the command.

MAILTESTER_USERNAME=myusername

Dependencies

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.

License

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.

bnomei / kirby3-mailtester

Maintainers

Details