cliffparnitzky/birthday-mailer

Sends a birthday email to all the members having their birthday on the current day.

1.3.5 2018-10-30 18:52 UTC

Requires

• php: >=5.3
• contao-community-alliance/composer-plugin: ~2.4 || ~3.0
• contao/core-bundle: ~3.2 || ~4.4
• friends-of-contao/contao-associategroups: ~1.3

Conflicts

• contao/core: 3.4.0,3.4.1,3.4.2

Replaces

• contao-legacy/birthdaymailer: *

LGPL-3.0-or-later

• Cliff Parnitzky

• email
• members
• contao
• birthday
• birthdaymail

README

Contao Extension: BirthdayMailer

Sends a birthday email to all the members having their birthday on the current day.

Installation

Install the extension via composer: cliffparnitzky/birthday-mailer.

If you prefer to install it manually, download the latest release here: https://github.com/cliffparnitzky/BirthdayMailer/releases

Tracker

https://github.com/cliffparnitzky/BirthdayMailer/issues

Compatibility

• Contao version >= 3.2.0 ... < 3.6.0
• Contao version >= 4.4.0

Dependency

This extension is dependent on the following extensions:

• [friends-of-contao/contao-associategroups]

Inserttags

{{birthdaychild::*}} ... This tag returns all the values of the current member (replace * with any attribute of the member, e.g. firstname or company, the attribute password is not allowed).
{{birthdaychild::salutation}} ... This tag returns the salutation of the member (depending on gender).
{{birthdaychild::name}} ... This tag returns first and last name of the member.
{{birthdaychild::groupname}} ... This tag returns the name of the member group of the current configuration.
{{birthdaychild::age}} ... This tag returns the age of the member.
{{birthdaymailer::email}} ... This tag returns the e-mail the configured sender.
{{birthdaymailer::name}} ... This tag returns the name of the configured sender.

Hooks

birthdayMailerAbortSendMail

The "birthdayMailerAbortSendMail" hook is triggered for for checking if a birthday mail should be send. So custom checking for each birthday child is possible. It passes $birthdayChildConfig (the config of the current birthday child) and $blnAbortSendMail (the current value, if sending should be aborted). It expects a boolean return value.

// config.php

$GLOBALS['TL_HOOKS']['birthdayMailerAbortSendMail'][]   = array('MyClass', 'myAbortSendMail');

// MyClass.php

class MyClass
{
	public function myAbortSendMail($birthdayChildConfig, $blnAbortSendMail)
	{
		if ($blnAbortSendMail !== TRUE && $birthdayChildConfig->id == 1)
		{
			$blnAbortSendMail = true;
			$this->log('SEnding birthday mail to member with id "1" was aborted.', 'MyClass myAbortSendMail()', TL_INFO);
		}
		return $blnAbortSendMail;
	}
}