Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mailmotor/mailmotor-bundle
[Core] This Symfony bundle loads in Mailmotor as a service. So you can subscribe/unsubscribe members to any mailinglist managing API. F.e.: MailChimp, CampaignMonitor, ...
https://github.com/mailmotor/mailmotor-bundle
campaign-monitor mail-engine mailchimp mailinglist php symfony-bundle
Last synced: 2 months ago
JSON representation
[Core] This Symfony bundle loads in Mailmotor as a service. So you can subscribe/unsubscribe members to any mailinglist managing API. F.e.: MailChimp, CampaignMonitor, ...
- Host: GitHub
- URL: https://github.com/mailmotor/mailmotor-bundle
- Owner: mailmotor
- License: mit
- Created: 2015-06-17T09:47:12.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2023-11-27T18:06:02.000Z (about 1 year ago)
- Last Synced: 2024-09-30T08:22:58.347Z (3 months ago)
- Topics: campaign-monitor, mail-engine, mailchimp, mailinglist, php, symfony-bundle
- Language: PHP
- Homepage: https://packagist.org/packages/mailmotor/mailmotor-bundle
- Size: 135 KB
- Stars: 3
- Watchers: 3
- Forks: 6
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# MailMotorBundle
[](https://packagist.org/packages/mailmotor/mailmotor-bundle)
[](https://github.com/mailmotor/mailmotor-bundle/blob/master/LICENSE)
[](https://travis-ci.org/mailmotor/mailmotor-bundle)
[](https://scrutinizer-ci.com/g/mailmotor/mailmotor-bundle/?branch=master)
> Subscribing/Unsubscribing to your own mailinglist has never been this easy! Thanks to this Symfony bundle.
## Installation
### How to configure MailChimp
```bash
composer require mailmotor/mailchimp-bundle
```
```php
// In `app/AppKernel.php`
public function registerBundles()
{
$bundles = array(
// ...
new MailMotor\Bundle\MailMotorBundle\MailMotorMailMotorBundle(),
new MailMotor\Bundle\MailChimpBundle\MailMotorMailChimpBundle(),
);
```
```yaml
# In `app/config/parameters.yml`
parameters:
# ...
mailmotor.mail_engine: 'mailchimp' # or another mailmotor engine
mailmotor.api_key: xxx # enter your mailchimp api_key here
mailmotor.list_id: xxx # enter the mailchimp default list_id here
```
## Examples
### Subscribing
```php
$this->get('mailmotor.subscriber')->subscribe(
$email, // f.e.: '[email protected]'
$language, // f.e.: 'nl'
$mergeFields, // f.e.: ['FNAME' => 'Jeroen', 'LNAME' => 'Desloovere']
$interests, // f.e.: ['9A28948d9' => true, '8998ASAA' => false]
$doubleOptin, // OPTIONAL, default = true
$listId // OPTIONAL, default listId is in your config parameters
);
```
### Unsubscribing
```php
$this->get('mailmotor.subscriber')->unsubscribe(
$email,
$listId // OPTIONAL, default listId is in your config parameters
);
```
### Exists
```php
$this->get('mailmotor.subscriber')->exists(
$email,
$listId // OPTIONAL, default listId is in your config parameters
);
```
### Is subscribed
```php
$this->get('mailmotor.subscriber')->isSubscribed(
$email,
$listId // OPTIONAL, default listId is in your config parameters
);
```
### Full example for subscribing
```php
use MailMotor\Bundle\MailMotorBundle\Exception\NotImplementedException;
// Don't forget to add validation to your $email
$email = '[email protected]';
try {
if ($this->get('mailmotor.subscriber')->isSubscribed($email)) {
// Add error to your form
}
// Fallback for when no mailmotor parameters are defined
} catch (NotImplementedException $e) {
// Do nothing
}
if ($noErrors)
try {
// Subscribe the user to our default group
$this->get('mailmotor.subscriber')->subscribe(
$email,
$language,
$mergeFields
);
// Fallback for when no mailmotor parameters are defined
} catch (NotImplementedException $e) {
// Add you own code here to f.e.: send a mail to the admin
}
}
```
### Full example for unsubscribing
```php
use MailMotor\Bundle\MailMotorBundle\Exception\NotImplementedException;
// Don't forget to add validation to your $email
$email = '[email protected]';
try {
// Email exists
if ($this->get('mailmotor.subscriber')->exists($email)) {
// User is already unsubscribed
if ($this->get('mailmotor.subscriber')->isUnsubscribed($email)) {
// Add error to your form: "User is already unsubscribed"
}
// Email not exists
} else {
// Add error to your form: "email is not in mailinglist"
}
// Fallback for when no mailmotor parameters are defined
} catch (NotImplementedException $e) {
// Do nothing
}
if ($noErrors) {
try {
// Unsubscribe the user
$this->get('mailmotor.subscriber')->unsubscribe($email);
// Fallback for when no mailmotor parameters are defined
} catch (NotImplementedException $e) {
// We can send a mail to the admin instead
}
}
```
## Extending
### Creating a bundle for another mail engine.
F.e.: You want to use a mail engine called "Crazy".
```php
public function registerBundles()
{
$bundles = array(
// ...
new Crazy\Bundle\MailMotorBundle\CrazyMailMotorBundle(),
);
```
In **app/config/parameters.yml**
```yaml
mailmotor.mail_engine: 'crazy'
mailmotor.api_key: xxx # enter your crazy api_key here
mailmotor.list_id: xxx # enter the crazy default list_id here
```
Then you just need to duplicate all files from another mail engine, like f.e.: "mailmotor/mailchimp-bundle" and replace all the logic for your own mail engine.
## Credits
* Jeroen Desloovere - [Github](https://github.com/jeroendesloovere), [Website](http://jeroendesloovere.be)