Download the PHP package beebmx/kirby-courier without Composer

On this page you can find all versions of the php package beebmx/kirby-courier. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of beebmx/kirby-courier

Informations about the package kirby-courier

Kirby Courier Logo

Build Status Total Downloads Latest Stable Version License

Kirby Courier

Kirby Courier offers a convenient and painless solution for creating emails tailored for your Kirby website. With Kirby Courier, you can streamline the process of email design and implementation for your site.

Overview

Installation

Download

Download and copy this repository to /site/plugins/kirby-courier.

Composer

Usage

Kirby Courier comes with two email message types, and you can customize them for your convenience.

Kirby Courier example

Notification message

The Notification message is the easiest way to send an email. You only need to use the Beebmx\KirbyCourier\Notification\Message class in your controller or in your own implementation. Here's an example:

Formating notification messages

You have several methods to customize your Notification message. Here's an example with all the methods:

[!WARNING] You can only add one action per Notification message.

Mail message

The Mail message is the easiest way to send an email if you need to customize all the body of your email, you only need to use the Beebmx\KirbyCourier\Mail\Message class in your controller or in your own implementation. Here's an example:

[!NOTE] It's important that you set a template to display your own customization. Every template should be located in your courier directory.

Formating mail messages

To create your own template for your mail messages, you need to create a file in the default location for Kirby Courier. Here's an example for a marketing message:

[!NOTE] You can add content as markdown and it will be processed by kirbytext.

Message methods

For both Mail messages, there are shared methods. Here's an example with all the methods:

If you want to previsualize your email, you can do it in any template. Here's an example:

[!NOTE] The render method doesn't trigger any email, and doesn't require any email settings like subject, from or to.

Snippets

For your convenience, Kirby Courier has some snippets to speed up your email building flow. You can add them in your courier template.

[!NOTE] You can create your own snippets if you want and apply it to the courier/message snippet. Just be sure to add it in the slot('body').

Button

Panel

Table

Subcopy

Console

If you are a Kirby CLI user, Kirby Courier also has you covered. The Kirby Courier commands can help you create Mail messages faster or even create your own Courier Theme.

You can create your Mail template with:

[!NOTE] courier:make is an alias of make:courier

Or may be you want to customize your messages with your own theme with:

Helper

If dealing with namespaces is hard, or you feel confused using the same Message class name, you can simplify it with the courier helper:

For Notification message you can use:

For Mail message you can use:

And of course, you can use it in a template to render it:

Options

Option Default Type Description
beebmx.kirby-courier.logo null Closure,string,null Set your own logo in every message.
beebmx.kirby-courier.path courier string Set a path where the templates and themes are located.
beebmx.kirby-courier.from.address 4 int Set the default form.address for every message.
beebmx.kirby-courier.from.name 2 int Set the default form.name for every message.
beebmx.kirby-courier.message.greeting Hello! string Set the default message.greeting for every message.
beebmx.kirby-courier.message.rights All rights reserved. string Set the default message.rights for every message.
beebmx.kirby-courier.message.salutation Regards string Set the default message.salutation for every message.
beebmx.kirby-courier.message.subject Message from courier string Set the default message.subject for every message.
beebmx.kirby-courier.message.notify string Set the default message.notify for every message.
beebmx.kirby-courier.message.brand_name null ?string Set the default message.brand_name for every message.

Here's an example of a full use of the options from the config.php file:

License

Licensed under the MIT.

Credits

Kirby Courier is inspired by the Laravel Notifications and Laravel Mail.

All versions of kirby-courier with dependencies

PHP Build Version
Package Version
Requires php Version ^8.2
getkirby/composer-installer Version ^1.0
tijsverkoyen/css-to-inline-styles Version ^2.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package beebmx/kirby-courier contains the following files

Loading the files please wait ....