Download the PHP package locomotivemtl/charcoal-email without Composer

On this page you can find all versions of the php package locomotivemtl/charcoal-email. 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 locomotivemtl/charcoal-email

Informations about the package charcoal-email

Charcoal Email

Sending emails (with PHPMailer) and queue management.

How to install

The preferred (and only supported) way of installing charcoal-email is with composer:

Dependencies

Optional dependencies

👉 All optional depedencies are required for development. All other development dependencies, which are optional when using charcoal-email in a project, are described in the Development section of this README file.

Usage

Email Config

The entire email system can be configured from the main app config, in the email config key.

Service Provider

All email services can be quickly registered to a (pimple) container with \Charcoal\Email\ServiceProvider\EmailServiceProvider.

Provided services:

Service Type Description
email Email1 An email object (factory).
email/factory FactoryInterface2 An email factory, to create email objects.

1 \Charcoal\Email\Email.
2 Charcoal\Factory\FactoryInterface.

Also available are the following helpers:

Helper Service Type Description
email/config EmailConfig3 Email configuration.
email/view ViewInterface4 The view object to render email templates ($container['view']).

3 \Charcoal\Email\EmailConfig.
4 \Charcoal\View\ViewInterface.

👉 For charcoal projects, simply add this provider to your config to enable:

Service dependencies

For the email service provider to work properly, the following services are expected to e registerd on the same container:

Development

To install the development environment:

To run the scripts (phplint, phpcs and phpunit):

Development dependencies

Continuous Integration

Service Badge Description
Travis Build Status Runs code sniff check and unit tests. Auto-generates API documentation.
Scrutinizer Scrutinizer Code Quality Code quality checker. Also validates API documentation quality.
Coveralls Coverage Status Unit Tests code coverage.
Sensiolabs SensioLabsInsight Another code quality checker, focused on PHP.

Coding Style

The Charcoal-Email module follows the Charcoal coding-style:

Coding style validation / enforcement can be performed with composer phpcs. An auto-fixer is also available with composer phpcbf.

Authors

License

Charcoal is licensed under the MIT license. See LICENSE for details.

All versions of charcoal-email with dependencies

PHP Build Version
Package Version
Requires php Version >=7.1
psr/log Version ^1.0
phpmailer/phpmailer Version ~6.0
locomotivemtl/charcoal-config Version ~0.6
locomotivemtl/charcoal-app Version ~0.6
locomotivemtl/charcoal-queue Version ~0.5
seld/jsonlint Version ^1.7
ext-pdo Version *
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 locomotivemtl/charcoal-email contains the following files

Loading the files please wait ....