Download the PHP package multidialogo/raw-mailer-sdk without Composer
On this page you can find all versions of the php package multidialogo/raw-mailer-sdk. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download multidialogo/raw-mailer-sdk
More information about multidialogo/raw-mailer-sdk
Files in multidialogo/raw-mailer-sdk
Package raw-mailer-sdk
Short Description A flexible library for sending emails using various drivers (AWS SES, SMTP, and a fake client for testing).
License MIT
Informations about the package raw-mailer-sdk
Multidialogo Raw Mailer SDK
Welcome to the Multidialogo Raw Mailer SDK! This library provides a flexible and robust way to send emails using various drivers, including AWS SES, standard SMTP, and a fake mail client for testing purposes.
Table of Contents
- Installation
- Usage
- Configuration
- Features
- Contributing
- License
Installation
To install the library, clone the repository and run:
Ensure you have the required dependencies installed, including the AWS SDK for PHP if you plan to use the SES driver.
Usage
Basic Setup
To get started, include the necessary namespaces and create an instance of the Facade
class:
Configuration
Drivers
The SDK supports three drivers:
- FAKE: A fake mail client for testing purposes.
- SES: AWS Simple Email Service.
- STD: Standard SMTP.
Attachment Size Limits
- AWS SES: Maximum attachment size is 6.5 MB.
- Standard SMTP: Maximum attachment size is 25 MB.
Features
- Send emails in parallel for better performance.
- Handle attachments with MIME types.
- Customizable email headers and boundaries.
- Catch-all domain modification for non-production environments.
- Error handling for invalid email configurations.
Contributing
Contributions are welcome! Please open an issue or submit a pull request for any enhancements or bug fixes.
- Fork the repository.
- Create your feature branch (
git checkout -b feature/MyFeature
). - Commit your changes (
git commit -m 'Add some feature'
). - Push to the branch (
git push origin feature/MyFeature
). - Open a pull request.
Development Environment
This repository includes a devcontainer configuration to streamline the development environment setup. You can use either PhpStorm or Visual Studio Code (VSCode) to take advantage of the development container.
Easy jump start with docker compose
Install php dependencies
(From the root directory)
Launch test suite
(From the root directory)
This will run the unit test suite.
Check mailcatcher web ui to debug messages sent with STD driver
Using the DevContainer with VSCode
Install Docker: Ensure that Docker is installed on your machine. Download Docker
Install Visual Studio Code: If you don't have VSCode installed, you can download it from here.
Install the Dev Containers extension: In VSCode, go to the Extensions view (⇧⌘X or Ctrl+Shift+X), search for Dev Containers, and install the extension by Microsoft.
Clone the Repository:
Open the Repository in VSCode: Open the project folder in VSCode.
Reopen in Container: Once the repository is opened in VSCode, a pop-up will appear asking to "Reopen in Container". If not, you can manually reopen by clicking on the green icon in the bottom-left corner and selecting "Reopen in Container".
Start Development: The container will automatically install the necessary PHP dependencies and set up the environment.
Using the DevContainer with PhpStorm
Install Docker: Ensure that Docker is installed on your machine. Download Docker
Install PhpStorm: You can download PhpStorm from here.
Clone the Repository:
Open the Project in PhpStorm: Open the repository folder in PhpStorm.
Configure Dev Container:
Open Settings in PhpStorm. Go to Build, Execution, Deployment > Docker and ensure Docker is properly configured. Go to File > Settings > PHP > CLI Interpreter, click Add..., and choose From Docker, Vagrant, VM, WSL, or Remote. Then select the appropriate container configuration. Start Development: PhpStorm will utilize the devcontainer and set up the environment, allowing you to work on the project seamlessly within the Dockerized PHP environment.
License
This project is licensed under the MIT License - see the LICENSE file for details.
All versions of raw-mailer-sdk with dependencies
symfony/mailer Version ^6.0
aws/aws-sdk-php Version ^3.0
ext-fileinfo Version *