Download the PHP package 2amigos/mailer without Composer
On this page you can find all versions of the php package 2amigos/mailer. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download 2amigos/mailer
More information about 2amigos/mailer
Files in 2amigos/mailer
Package mailer
Short Description Mailer adapter for the Symphony Mailer library with queuing capabilities.
License
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 mailer
Mailer
Many times we face a requirement to implement queue mail functionality in our projects. There are queue and
mailing libraries, but there seemed to be none that could actually suit our needs and moreover, we always had to sync their
functionality together.
The Mailer library was built to fill the gaps that we have faced when implementing queue and/or mailing systems. It
features:
- message encryption/decryption just in case a mail message contains data that should not be publicly exposed. Perfect for SAS systems.
- queueing on different backends (currently supporting beanstalkd, pdo, redis, sqs and rabbitmq) so we are not forced to use a queue storage due to the narrowed capabilities of the framework and/or libraries
- unified system. Basic to Middle size projects do have mailing but they do not require another type of queue system. That's the reason the queue system is not standalone and is coupled with this system.
Installation
The preferred way to install this extension is through composer.
Either run
or add
to the require section of your composer.json file.
Usage
Configuration
All the configuration needed to set up the message broker connections as the mailer transport should be performed on the .env file. A .env.example file is provided, you can just copy it and start over!
The keys MESSAGE_BROKER and MAIL_TRANSPORT defines the default message broker
and mail transport, and they are mandatory to be filled. By default, its
set to use Redis broker with SMTP transport.
You can access the related configuration values by calling:
Mail Messages
The MailMessage class is an abstraction for an email
content. Beside the attachments, you can specify the email content
directly by the constructor or directly accessor.
You can also use our EmailAddress class to define emails with related name:
And to add attachments, you can make use of the method addAttachment(path, name):
Also, you can set text or html body as a resource path.
Available public properties:
| Property | Type |
|---|---|
| from | string, array |
| to | string, array |
| cc | string, array |
| bcc | string, array |
| subject | string |
| bodyText | string |
| bodyHtml | string |
enqueue MailMessage
You can easily assess the message enqueue by calling the method enqueue.
The message will enqueued to the default message broker, and use the default transport.
MailJob
The MailJob class will abstract the message behavior for our queue application.
You can create a new MailJob with the MailJobBuilder class:
Behind the hoods, the builder will build the MailJob specialized to the
default broker you've defined on your .env file. If you ever want a
mail job to be created to a different broker than your default, you
can set it as the second argument, using one value
from the \Da\Mailer\Enum\MessageBrokerEnum enum:
The MailJob class has a set of methods to manipulate it's content and also to check its status. The next piece of code cover them all:
Mailer
The Mailer class is the one we use for sending the emails.
Queues
To create a queue, you can make use of our QueueBuilder class. It will return
a queue object with a few methods to handle the queue. They are:
- enqueue(MailJob $job): bool
- dequeue(): mailjob
- ack(MailJob $job): void
- isEmpty(): bool
Advanced usage
If you want to handle your message broker and smtp manually, you can follow through the following topics:
- Beanstalkd Backend
- Pdo Backend
- RabbitMq Backend
- Redis Backend
- SQS Backend
Contributing
Please see CONTRIBUTING for details.
Clean code
We have added some development tools for you to contribute to the library with clean code:
- PHP mess detector: Takes a given PHP source code base and look for several potential problems within that source.
- PHP code sniffer: Tokenizes PHP, JavaScript and CSS files and detects violations of a defined set of coding standards.
- PHP code fixer: Analyzes some PHP source code and tries to fix coding standards issues.
And you should use them in that order.
Using php mess detector
Sample with all options available:
Using code sniffer
Using code fixer
We have added a PHP code fixer to standardize our code. It includes Symfony, PSR-12 and some contributors rules.
Testing
Credits
License
The BSD License (BSD). Please see License File for more information.
web development has never been so fun
www.2amigos.us
All versions of mailer with dependencies
phpseclib/phpseclib Version ^3.0
aws/aws-sdk-php Version ^3.296
predis/predis Version ^2.2
pda/pheanstalk Version ^4.0
php-amqplib/php-amqplib Version 2.*
vlucas/phpdotenv Version ^5.6
marc-mabe/php-enum Version ^4.7
symfony/mailer Version ^5.4
symfony/event-dispatcher Version ^5.4