bnomei / kirby3-mailtester
Kirby 3 mail-tester.com
Installs: 177
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Type:kirby-plugin
Requires
- php: >=8.0
- getkirby/composer-installer: ^1.2
Requires (Dev)
- getkirby/cli: dev-develop
- getkirby/cms: ^3.8.1.1
- php-coveralls/php-coveralls: ^2.4
- phpunit/phpunit: ^9.5
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.
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
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.