Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Stampie/Stampie
Library for using online Email providers
https://github.com/Stampie/Stampie
mailer mailjet mandrill mandrill-api-wrapper php postmark sendgrid sparkpost stampie
Last synced: 4 days ago
JSON representation
Library for using online Email providers
- Host: GitHub
- URL: https://github.com/Stampie/Stampie
- Owner: Stampie
- License: mit
- Created: 2011-11-28T18:52:39.000Z (almost 13 years ago)
- Default Branch: main
- Last Pushed: 2022-06-27T14:00:24.000Z (over 2 years ago)
- Last Synced: 2024-07-08T05:47:45.058Z (4 months ago)
- Topics: mailer, mailjet, mandrill, mandrill-api-wrapper, php, postmark, sendgrid, sparkpost, stampie
- Language: PHP
- Homepage: https://stampie.github.io
- Size: 1.24 MB
- Stars: 293
- Watchers: 9
- Forks: 30
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: Changelog.md
- License: LICENSE
Awesome Lists containing this project
- awesome-php - Stampie - A library for email services such as [SendGrid](https://sendgrid.com/), [PostMark](https://postmarkapp.com), [MailGun](https://www.mailgun.com/) and [MailChimp](https://mailchimp.com/features/transactional-email/). (Table of Contents / Email)
- awesome-php-cn - Stampie - 图书馆的电子邮件服务,如[SendGrid] (https://sendgrid.com/) (目录 / 电子邮件 Email)
- awesome-opensource-email - Stampie - Library for using online Email providers for PHP (Code / Library)
- awesome-projects - Stampie - A library for email services such as [SendGrid](https://sendgrid.com/), [PostMark](https://postmarkapp.com), [MailGun](https://www.mailgun.com/) and [MailChimp](https://mailchimp.com/features/transactional-email/). (PHP / Email)
- awesome-php - Stampie - A library for email services such as [SendGrid](https://sendgrid.com/en-us), [PostMark](https://postmarkapp.com), [MailGun](https://www.mailgun.com/) and [MailChimp](https://mailchimp.com/features/transactional-email/). (Table of Contents / Email)
README
# Stampie
[](https://github.com/Stampie/Stampie/actions/workflows/ci.yml)
Stampie is a simple API Wrapper for different email providers such as [Postmark](https://postmarkapp.com) and [SendGrid](https://sendgrid.com).
It is very easy to use and to integrate into your application as demonstrated below with a `SendGrid` mailer.
## Providers
* [Postmark](https://postmarkapp.com)
* [SendGrid](https://sendgrid.com)
* [MailGun](https://www.mailgun.com)
* [Mandrill](https://mandrill.com/)
* [SparkPost](https://sparkpost.com)
* [Mailjet](https://www.mailjet.com)
```php
send(new Message('[email protected]'));
```
This simple example shows a few different things about how Stampie works under the hood and is developed. Because others
are **so much** better than us to do HTTP communication, Stampie uses the [PSR-18](https://www.php-fig.org/psr/psr-18/) abstraction so
you are free to choose between any library like [Buzz](https://github.com/kriswallsmith/Buzz) or [Guzzle](https://docs.guzzlephp.org).
See the full list here: https://packagist.org/providers/psr/http-client-implementation
Every mailer takes a `$serverToken` as the second argument in their constructor. This is what is used for authentication.
In the Postmark mailer this is a hash but in SendGrid it is a `username:password` pattern that is split into two pieces
and send as arguments. A mailer is responsible for formatting the request needed for a given API.
A `Message` or `MessageInterface` is a simple storage class that holds information about the message sent to an API such
as the email address this is from and who should receive it together with html and text bodies.
Last there is an interface for every type of class or abstract implementation that should be used when adding new Mailer's
or Adapter's.
## Installation
Stampie is not hard coupled to Guzzle or any other library that sends HTTP messages. It uses an abstraction
called PSR-18. This will give you the flexibility to choose what PSR-7 implementation and HTTP client to use.
If you just want to get started quickly you should run the following command:
```bash
composer require stampie/stampie php-http/curl-client nyholm/psr7
```
### Why requiring so many packages?
Stampie has a dependency on the virtual package [psr/http-client-implementation](https://packagist.org/providers/psr/http-client-implementation)
which requires to you install **an** adapter, but we do not care which one. That is an implementation detail in your application.
We also need **a** [PSR-17 implementation](https://packagist.org/providers/psr/http-factory-implementation).
You do not have to use the `php-http/curl-client` if you do not want to. You may use the `php-http/guzzle6-adapter` or any
other library in [this list](https://packagist.org/providers/psr/http-client-implementation).
## Documentation
There is generated API documentation for all tags and released versions. Those can be found at [stampie.github.io/Stampie/api/main/](https://stampie.github.io/Stampie/api/main/).
## Extensions
* [Stampie Extra](https://github.com/Stampie/extra) provides extensions to Stampie using the Symfony EventDispatcher component.
## Framework integration
Stampie is itself completely decoupled and does not depend on any framework.
### Integrations
* [StampieBundle](https://github.com/Stampie/stampie-bundle) it is also [on packagist](https://packagist.org/packages/stampie/stampie-bundle)
## Testing
Stampie is [Continuous Integration](https://en.wikipedia.org/wiki/Continuous_integration) tested with GitHub Actions and aims for a high coverage percentage.
## Developing
As mentioned above if integrating new mailers or adapters please rely on the interfaces or abstract classes already in this package. Furthermore unit tests should be provided as well.
## Feedback
This is a project created to test TDD along the way and maybe have some scars from that. But you are always welcome to send feedback or GitHub, Twitter, GitHub issue or Pull Request. Same goes if something is wrong or you have ideas for a better or smarter implementation.