- (Feature) Added ability to create a front-end form that will trigger the "Front-end Email Form" parcel type to send emails dynamically from users

Author: objectivehtml

PostmasterPlugin.php

@@ -38,6 +38,7 @@ public function addTwigExtension()
     public function registerSiteRoutes()
     {
         $routes = array(
+            'postmaster/send' => array('action' => 'postmaster/forms/send'),
             'postmaster/queue/marshal' => array('action' => 'postmaster/queue/marshal'),
             'postmaster/notifications/marshal' => array('action' => 'postmaster/notification/marshal'),
             'postmaster/notification/marshal/(?P<notificationId>\d+)' => array('action' => 'postmaster/notification/marshal'),

bootstrap.php

@@ -15,6 +15,7 @@
     'Craft\Plugins\Postmaster\ParcelTypes\DefaultParcelType',
     'Craft\Plugins\Postmaster\ParcelTypes\UserEmailParcelType',
     'Craft\Plugins\Postmaster\ParcelTypes\SystemEmailParcelType',
+    'Craft\Plugins\Postmaster\ParcelTypes\EmailFormParcelType',
     // 'Craft\Plugins\Postmaster\ParcelTypes\TestParcelType',
 ));
 

controllers/Postmaster_FormsController.php

@@ -0,0 +1,30 @@
+<?php
+namespace Craft;
+
+class Postmaster_FormsController extends BaseController
+{
+	public function actionSend()
+	{
+		$model = new Postmaster_EmailFormModel(craft()->request->getPost());
+
+		if(!$model->validate())
+		{ 
+			// Prepare a flash error message for the user.
+            craft()->userSession->setError(Craft::t('The email could not be sent.'));
+
+            craft()->urlManager->setRouteVariables(array(
+            	'email' => $model
+            ));
+		}
+		else
+		{
+			$event = new Event($this, array(
+				'email' => $model
+			));
+
+			craft()->postmaster_forms->onEmailFormSend($event);
+
+			$this->redirect(craft()->request->getPost('redirect'));
+		}
+	}
+}

core/parcel_types/EmailFormParcelType.php

@@ -0,0 +1,57 @@
+<?php
+namespace Craft\Plugins\Postmaster\ParcelTypes;
+
+use Craft\Event;
+use Craft\Postmaster_TransportModel;
+use Craft\PostmasterHelper;
+use Craft\Plugins\Postmaster\Components\BaseParcelType;
+
+class EmailFormParcelType extends BaseParcelType {
+	
+	public $name = 'Frontend Email Form';
+
+	public $id = 'emailForm';
+
+	public function init()
+	{
+		$parcelType = $this;
+
+		$this->craft()->on('postmaster_forms.emailFormSend', function(Event $event) use ($parcelType)
+		{
+			$parcelType->parcel->parse(array_merge($event->params, array(
+				'post' => $this->craft()->request->getPost()
+			)));
+
+			if($parcelType->validate())
+	        {
+	            $obj = new Postmaster_TransportModel(array(
+	                'service' => $parcelType->parcel->service,
+	                'settings' => $parcelType->settings,
+	                'data' => $event->params
+	            ));
+				
+	           	$parcelType->parcel->send($obj);
+	        }
+		});
+	}
+
+	public function validate()
+	{
+		return PostmasterHelper::validateExtraConditionals($this->settings->extraConditionals);
+	}
+
+	public function getInputHtml(Array $data = array())
+	{
+		return $this->craft()->templates->render('postmaster/parcel_types/email_form/fields', $data);
+	}
+
+	public function getSettingsInputHtml(Array $data = array())
+	{
+		return $this->craft()->templates->render('postmaster/parcel_types/email_form/settings', $data);
+	}
+
+	public function getSettingsModelClassName()
+	{
+		return '\Craft\Postmaster_EmailFormParcelTypeSettingsModel';
+	}
+}

models/Postmaster_EmailFormModel.php

@@ -0,0 +1,7 @@
+<?php
+namespace Craft;
+
+class Postmaster_EmailFormModel extends Postmaster_EmailModel
+{
+	
+}

models/Postmaster_EmailFormParcelTypeSettingsModel.php

@@ -0,0 +1,13 @@
+<?php
+namespace Craft;
+
+class Postmaster_EmailFormParcelTypeSettingsModel extends Postmaster_EmailModel
+{
+	protected function defineAttributes()
+    {
+    	$attributes = parent::defineAttributes();
+        $attributes['extraConditionals'] = array(AttributeType::String);
+
+        return $attributes;
+    }
+}

models/Postmaster_TransportModel.php

@@ -42,7 +42,7 @@ protected function defineAttributes()
             'service' => AttributeType::Mixed,
             'settings' => AttributeType::Mixed,
             'data' => AttributeType::Mixed,
-            'senderId' => AttributeType::String,
+            'senderId' => array(AttributeType::Mixed, 'default' => false),
             'sendDate' => array(AttributeType::Mixed, 'default' => false),
             'queueId' => array(AttributeType::Mixed, 'default' => false)
         );

services/Postmaster_FormsService.php

@@ -0,0 +1,13 @@
+<?php
+namespace Craft;
+
+class Postmaster_FormsService extends BaseApplicationComponent
+{
+    public function onEmailFormSend(Event $event)
+    {
+        $this->raiseEvent('onEmailFormSend', $event);
+
+        return $event;
+    }
+
+}

templates/parcel_types/email_form/fields.html

@@ -0,0 +1,7 @@
+{% import "postmaster/_includes/forms" as postmaster %}
+
+{{ postmaster.emailFields({
+	section: 'parcelTypeSettings',
+	name: 'emailForm',
+	settings: settings
+}) }}

templates/parcel_types/email_form/settings.html

@@ -0,0 +1,10 @@
+{% import "_includes/forms" as forms %}
+
+{{ forms.textareaField({
+	label: "Extra Conditionals"|t,
+	instructions: "What extra conditionals should be used to validate this parcel? Return `false` is you want to prevent the email from sending."|t,
+	id: 'extraConditionals',
+	name: 'settings[parcelTypeSettings][emailForm][extraConditionals]',
+	value: settings.extraConditionals,
+	rows: 10
+}) }}