atm/mailbundle

Mailing management bundle

1.0.20 2019-03-13 08:53 UTC

Requires

• php: >=5.3.9

Requires (Dev)

• dyninc/dyn-php: ^0.9.0
• friendsofsymfony/jsrouting-bundle: ^1.6
• symfony/asset: ~2.7|~3.0.0
• symfony/console: ~2.8|~3.0.0
• symfony/expression-language: ~2.4|~3.0.0
• symfony/finder: ~2.3|~3.0.0
• symfony/form: ^2.8.23
• symfony/http-kernel: ~2.8|~3.0.0
• symfony/polyfill-intl-icu: ~1.0
• symfony/routing: ~2.2|~3.0.0
• symfony/security: ~2.6|~3.0.0
• symfony/security-acl: ~2.6|~3.0.0
• symfony/stopwatch: ~2.2|~3.0.0
• symfony/templating: ~2.1|~3.0.0
• symfony/translation: ~2.7|~3.0.0
• symfony/var-dumper: ~2.7.16|~2.8.9|~3.0.9
• symfony/yaml: ^2.0.5|~3.0.0
• xlabs/rabbitmqbundle: ^1.0

Suggests

• symfony/asset: For using the AssetExtension
• symfony/expression-language: For using the ExpressionExtension
• symfony/finder: For using the finder
• symfony/form: For using the FormExtension
• symfony/http-kernel: For using the HttpKernelExtension
• symfony/routing: For using the RoutingExtension
• symfony/security: For using the SecurityExtension
• symfony/stopwatch: For using the StopwatchExtension
• symfony/templating: For using the TwigEngine
• symfony/translation: For using the TranslationExtension
• symfony/var-dumper: For using the DumpExtension
• symfony/yaml: For using the YamlExtension

MIT

• Alberto Tuzon

• atm mail bundle

README

A Mail Manager System

Installation

Install through composer:

php -d memory_limit=-1 composer.phar require atm/mailbundle

In your AppKernel

public function registerbundles()
{
    return [
    	...
    	...
    	new ATM\MailBundle\ATMMailBundle(),
    ];
}

Routing

Append to main routing file:

# app/config/routing.yml
  
atm_mail:
    resource: "@ATMMailBundle/Resources/config/routing.yml"
    prefix:   /

You also have to put outside of your firewalls the following route for unsubscribing users

atm_mail_unsubscribe_user:
    path: /unsubscribe/{userId}
    defaults: { _controller: "ATMMailBundle:Mail:unsubscribeUser" }

Configuration sample

Default values are shown below:

# app/config/config.yml
  
atm_mail:
    class:
        model:
            user: YourBundle\Entity\User
    # Domain of your site
    site_domain: 'atmbundles.com'
    # Folder name where the mail templates are gonna be stored
    templates_folder: 'mail_templates'
    # From address to use for sending mails
    from_address: '[e-mail]'
    # From name to use for sending mails
    from_name: 'EXAMPLE'
    # To Address to use for checking that the commands had been executed successfully 
    checking_to_address: '[e-mail]'
    # Your DYN Key
    dyn_api_key: 'yourkeygoeshere'
    # User types to use for mailings
    user_types: ['girls','exmembers','active_users','all']

User Types Conditions

You must define the following function in your User Repository for filtering the different types of users you have for sending mails.

namespace YourBundle\Repository;

use Doctrine\ORM\EntityRepository;

class UserRepository extends EntityRepository
{
    public function getAtmMailingUserTypeWhereClause($qb,$andX,$userType){

        switch($userType){
            case 'usertype1':
                $andX->add($qb->expr()->like('u.roles',$qb->expr()->literal('%ROLE1%')));
                $andX->add($qb->expr()->eq('u.locked',0));
                $andX->add($qb->expr()->eq('u.enabled',1));
                break;
            case 'usertype2':
                $andX->add($qb->expr()->notLike('u.roles',$qb->expr()->literal('%ROLE2%')));
                $andX->add($qb->expr()->eq('u.locked',0));
                $andX->add($qb->expr()->eq('u.enabled',1));
                break;
            case 'usertype3':
                $andX->add($qb->expr()->notLike('u.roles',$qb->expr()->literal('%ROLE3%')));
                $andX->add($qb->expr()->lte('u.expiresAt','CURRENT_TIMESTAMP()'));
                break;
            case 'all':
                return null;
                break;
        }

        return $andX;
    }
}