Download the PHP package synergitech/postal without Composer
On this page you can find all versions of the php package synergitech/postal. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download synergitech/postal
More information about synergitech/postal
Files in synergitech/postal
Package postal
Short Description FuelPHP library to integrate Postal Email sending
License MIT
Homepage https://www.synergitech.co.uk
FAQ
Example:
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 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.
Informations about the package postal
FuelPHP Postal
FuelPHP-Postal is designed as a fully featured wrapper to the Postal email sending platform.
Currently it handles sending emails, with or without attachments, stores the message ID returned from Postal in a database, and also exposes a webhook receiver to handle notifications from Postal that messages have been delivered, opened etc.
Installation
The recommended way to install fuelphp-postal is using Composer.
Next, run the Composer command to install the latest stable version of fuelphp-postal.
You will then need database tables for storing the outbound email details and webhook notifications. We have provided FuelPHP migrations to make this easy.
Configuration
You need to configure your app to point to your Postal instance and the address from which to send. A basic config looks like this:
The template_text and template_html will be used by default as the view files into which your $data array will be merged using FuelPHP's built in View render() function.
You will need to add postal to the config and package autoloaders to ensure they are available to your classes.
You can also define an environment variable in your .htaccess file to send all emails to one address which will help you develop your app.
You can also achieve this by adding a config value sendallmessagesto if you would rather not adjust your environment variables.
Quick Sending Messages
You can call the send() function to send an email. Arguments after $to are optional.
Normal Sending Messages
If you want to access other features such as headers, attachments, and CC, you can forge() a new object which behaves similarly to Postals PHP library. The $data and $from arguments are optional.
Now you can use it to fill in the recipients and send. to(), cc(), and bcc() all function the same way.
If you want to store your message contents in another view file, send a null body and a 'body_view' item in the $data array. The view will receive either an $is_text variable or an $is_html variable if you need to slightly differentiate between the two.
Webhooks
You can configure a webhook receiving URL within Postal. You need to create a controller within your FuelPHP project that calls:
Example Controller file (be sure to allow unauthenticated requests to pass to this function):
Logging
Using this package means you store a history of email messages and the webhooks let you keep updated with the status of those messages.
To make use of the messages as part of an audit trail, you will be interested in the database objects for the messages you have just sent.
You can set return_email_objects to true and any calls to send() will return an array of database objects which you can do with what you wish.
