Author: _GeG_ Date: 2010-09-13 14:55:15 +0200 (Mon, 13 Sep 2010) New Revision: 30895
Added: plugins/ggEmailPlugin/trunk/CHANGELOG Modified: plugins/ggEmailPlugin/trunk/README plugins/ggEmailPlugin/trunk/package.xml.tmpl Log: Corrected some typos and changed the plugin's status to beta. Added: plugins/ggEmailPlugin/trunk/CHANGELOG =================================================================== --- plugins/ggEmailPlugin/trunk/CHANGELOG (rev 0) +++ plugins/ggEmailPlugin/trunk/CHANGELOG 2010-09-13 12:55:15 UTC (rev 30895) @@ -0,0 +1,4 @@ +0.1.0 First releaser +0.1.1 Get PHP syntax highligting in the README file +0.2.0 Updated README: fixed typos + The plugin is now status beta, as there are no open issues for the last three weeks. \ No newline at end of file Modified: plugins/ggEmailPlugin/trunk/README =================================================================== --- plugins/ggEmailPlugin/trunk/README 2010-09-13 12:42:39 UTC (rev 30894) +++ plugins/ggEmailPlugin/trunk/README 2010-09-13 12:55:15 UTC (rev 30895) @@ -3,13 +3,15 @@ This plugin helps you to use the MVC pattern for emails also. This means that you can send the same email from any application or task, with or without decoration by a layout. It also provides the functionality to combine plain text and html mail parts in one mail (nearly) automatically. +It is now in beta state, but some people use it already in production without issues. Please discuss all issues on [http://forum.symfony-project.org/viewtopic.php?f=12&t=29462](http://forum.symfony-project.org/viewtopic.php?f=12&t=29462). + ## Installation ## * Install the plugin symfony plugin:install ggEmailPlugin -s=beta - Since the plugin is still in alpha mode, the install requires a `-s=beta` parameter. + Since the plugin is still in beta mode, the install requires a `-s=beta` parameter. * Add the plugin to config/ProjectConfiguration.class.php @@ -33,26 +35,18 @@ ## Usage ## -To send an email, get the mailer first(!) and then create the email message +To send an email, initialize the mailer __first__(call $this->getMailer(), which initializes the Swift auto loader) and then create the email message - <?php - $mailer = $this->getMailer(); // this works in actions and in tasks the same way $message = new ggEmailMessage('The subject'); - ?> This message is a normal Swift_Message with one additional method setBodyFromTemplate(). - <?php - public function setBodyFromTemplate(sfController $controller, $module, $name, array $params, $layout = null, $contentType = null, $charset = null) {} - ?> If you compose a message in an action like this - <?php - $mailer = $this->getMailer(); $message = new ggEmailMessage('Serious break in attempt'); $message->setBodyFromTemplate($this->getController(), // controller @@ -61,7 +55,6 @@ array('user' => 'georg', 'attempt' => 'SQL injection'), // variables for the template 'emergenceny_layout' // name of the layout ); - ?> the plugin works like this: @@ -75,8 +68,6 @@ In a task, you would use it like this: - <?php - class sendAlertsTask extends sfDoctrineBaseTask { protected function configure() { @@ -91,11 +82,10 @@ $mailer = $this->getMailer(); $controller = sfContext::createInstance($this->configuration)->getController(); $message = new ggEmailMessage('Serious break in attempt'); - $message->setBodyFromTemplate(controller, 'emergency', 'serious_break_in', + $message->setBodyFromTemplate($controller, 'emergency', 'serious_break_in', array('user' => 'georg', 'attempt' => 'SQL injection'), 'emergceny_layout'); } } - ?> In this case the plugin would first try to find the template and layout in the directories of the application `app_where_to_look_for_templates`, and they are not found, in the directories defined by it's configuration. Modified: plugins/ggEmailPlugin/trunk/package.xml.tmpl =================================================================== --- plugins/ggEmailPlugin/trunk/package.xml.tmpl 2010-09-13 12:42:39 UTC (rev 30894) +++ plugins/ggEmailPlugin/trunk/package.xml.tmpl 2010-09-13 12:55:15 UTC (rev 30895) @@ -2,7 +2,7 @@ <package packagerversion="1.4.1" version="2.0" xmlns="http://pear.php.net/dtd/package-2.0"; xmlns:tasks="http://pear.php.net/dtd/tasks-1.0"; xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; xsi:schemaLocation="http://pear.php.net/dtd/tasks-1.0 http://pear.php.net/dtd/tasks-1.0.xsd http://pear.php.net/dtd/package-2.0 http://pear.php.net/dtd/package-2.0.xsd";> <name>ggEmailPlugin</name> <channel>plugins.symfony-project.org</channel> - <summary>Template/layout functionality for Email</summary> + <summary>Template/layout functionality for Emails</summary> <description>ggEmailPlugin helps using the symfony template/layout system for emails. The template and the layout directory can be configured, and the templates and the layouts can be accessed from everywhere in a symfony project, either application or task. It also provides an easy way to add alternative text and html message parts to an email.</description> -- You received this message because you are subscribed to the Google Groups "symfony SVN" group. To post to this group, send email to [email protected]. To unsubscribe from this group, send email to [email protected]. For more options, visit this group at http://groups.google.com/group/symfony-svn?hl=en.
