Jump to content
Martijn Geerts

WireMailBranding (module)

Recommended Posts

WireMailBranding
Add email templates to wireMail
 
From this:

$mail->bodyHTML("<h1>Hello</h1><p>I'm WireMailBranding</p>");

To this:
post-577-0-38841600-1446043663_thumb.png
(or whatever template you create)
 
How it works?
Create an email template without content. On the spot where you wish to have your content place the tag {bodyHTML}.The markup you've set with $mail->bodyHTML('<p>Markup</p>'); will replace that tag.
 
You could set the defaults in the Module configuration or set the properties with the API. (See below) The API will overwrite the default settings :-)

$mail = wireMail();
$mail->to('user@some-domain.ext')->from('you@own-domain.ext');
$mail->subject('Mail Subject');
// Set path to template (overwrites default settings)
$mail->template('/site/templates/template_wrapper.php');
// Enable/Overwrite the Emogrifier CSS inliner. (0, bodyHTML, wrapper)
$mail->inlineCSS('bodyHTML');
$mail->bodyHTML('<p>This paragraph will replace the {bodyHTML} tag in the mail template.</p>');
$mail->send();

CSS inliner 

We have added the beautiful css inliner Emogrifier to inline the CSS styles. When using the Emogrifier CSS inliner applying it on the bodyHTML only is the most efficient way. We recommend you to write the inline styles for the wrapper manually.
 
The module is sponsored by Calago.nl. Thanks guys !


Updates

0.1.2

Bug fixes :

- Fixed redeclare Emogrifier bug.

Improvement

- Added error logging for Emogrifier

- Added inputfield error for the lack of PHP's mbstring in the module configuration.

- Some code cleaning and other cosmetics

 

0.1.3

Bug fixes :

- Fixed bug when module couldn't grab bodyHTML (resulted in doing nothing at all).


 
GitHub
https://github.com/Da-Fecto/WireMailBranding

Modules directory

http://modules.processwire.com/modules/wire-mail-branding/

  • Like 18

Share this post


Link to post
Share on other sites

Great module, Martjin! And thanks for the hat-tip on Emogrifier - I can definitely make use of that in SimpleForms.

Share this post


Link to post
Share on other sites

When SimpleForms use wireMail you only have to install this module and create a template.

On the place you want to have your markup place the {bodyHTML} tag.

Share this post


Link to post
Share on other sites

I could indeed do that, but I have already implemented a templating system which gives flexibility in terms of defining plain and rich templates. Inlining CSS (as opposed to prepending a stylesheet) is a great thing for email templates, as it ensures client compatiability. So I'd like to include that specific class in SimpleForms.

That said, I could look into providing the option of using your module in SimpleForms, provided it is installed.

Will look into this soon.

(Side note: Development of SimpleForms (and the new Jumplinks) is paused at the moment as I cannot dedicate enough time in my day to working on it. Hope to start again soon - it is still fresh in my mind.)

  • Like 2

Share this post


Link to post
Share on other sites

Martijn I have a problem when I have installed Mail Branding and wireMailSMTP together I get the below error :

Error: Exception: Method WireMailSmtp::template does not exist or is not callable in this context (in /home/omegatel/public_html/wire/core/Wire.php line 358)

My Silly mistake downloaded the module but didn't installed it :D

  • Like 1

Share this post


Link to post
Share on other sites

Martjin one question is there anyway to send some dynamic data also to the wrapper it self ?for example we have placed the {bodyHTML} inside our content box and I want to also send data to another part of my template. How can I achieve this?

Best Regards,

Ali.M

Share this post


Link to post
Share on other sites

Not sending to the wrapper. Maybe you could access what you want from the wrapper with the wire('') functions.

When you use this module from a normal page page is available with wire('page').

You could also add your variable to the config, later-on in the wrapper you could access that with wire('config')

Edited by Martijn Geerts

Share this post


Link to post
Share on other sites

no I have a form that after save I send an email to client I want to send some of the data from the form to wrapper itself for example in the footer

Share this post


Link to post
Share on other sites

Thank you very much I will take look and poke it a little bit and will update the topic.

Great module and thank you for making such a cool module.

Share this post


Link to post
Share on other sites

Martijn another issue I have WireMailSMTP and also using your module too now when I have such code as below:

$mail = wireMail();
$mail->sendSingle(true);
$mail->to('sradesign.net@gmail.com', 'Ali Mahmoudi');
$mail->cc(array('ali@vinsonfinancials.com'));
$mail->from = 'info@vinsonfinancials.com'; 
$mail->fromName = 'Vinson Financials';
$mail->subject('Test');
$mail->bodyHTML($fullname.' Account Details Have Been Updated Successfully');
$numSent = $mail->send();

it trough me errors like below:

Error: Exception: Method WireMailBranding::sendSingle does not exist or is not callable in this context

or

Error: Exception: Method WireMailBranding::cc does not exist or is not callable in this context

Share this post


Link to post
Share on other sites

Both methods don't exist in my module. I'll create an issue on GitHub to remind my self.

Will take a look at later how to solve it. Maybe I can solve it with a magic method.

Share this post


Link to post
Share on other sites

How the class is written now it don't has access to WireMailSmtp, as WireMail is the parent class and not WireMailSmtp. To make it work with not known methods it needs a total rewrite, if even possible. But there's a work around.

// This don't work with methods not know by WireMail
$mail = wireMail();

// When you instantiate WireMailSmtp yourself it all works
$mail = $modules->get('WireMailSmtp');
 
  • Like 2

Share this post


Link to post
Share on other sites

How the class is written now it don't has access to WireMailSmtp, as WireMail is the parent class and not WireMailSmtp. To make it work with not known methods it needs a total rewrite, if even possible. But there's a work around.

// This don't work with methods not know by WireMail
$mail = wireMail();

// When you instantiate WireMailSmtp yourself it all works
$mail = $modules->get('WireMailSmtp');
 

This worked for me too.

Would really like if i could implement dynamic data in the email?

Not sending to the wrapper. Maybe you could access what you want from the wrapper with the wire('') functions.

When you use this module from a normal page page is available with wire('page').

You could also add your variable to the config, later-on in the wrapper you could access that with wire('config')

Is this the only way to implement this at the moment?

Share this post


Link to post
Share on other sites

Is this the only way to implement this at the moment?

The Module is in the scope of the class, so you need the wire scope. All ProcessWire variables have those functions so things are reachable. That's for the wrapper.

The bodyHTML method can be used in a template, so it's up to you what you do there.

  • Like 1

Share this post


Link to post
Share on other sites

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now

  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

    • By MoritzLost
      TrelloWire
      This is a module that allows you to automatically create Trello cards for ProcessWire pages and update them when the pages are updated. This allows you to setup connected workflows. Card properties and change handling behaviour can be customized through the extensive module configuration. Every action the module performs is hookable, so you can modify when and how cards are created as much as you need to. The module also contains an API-component that makes it easy to make requests to the Trello API and build your own connected ProcessWire-Trello workflows.
      Features
      All the things the module can do for you without any custom code: Create a new card on Trello whenever a page is added or published (you can select applicable templates). Configure the target board, target list, name and description for new cards. Add default labels and checklists to the card. Update the card whenever the page is updated (optional). When the status of the card changes (published / unpublished, hidden / unhidden, trashed / restored or deleted), move the card to a different list or archive or delete it (configurable). You can extend this through hooks in many ways: Modifiy when and how cards are created. Modify the card properties (Target board & list, title, description, et c.) before they are sent to Trello. Create your own workflows by utilizing an API helper class with many convenient utility methods to access the Trello API directly. Feedback & Future Plans
      Let me know what you think! In particular:
      If you find any bugs report them here or on Github, I'll try to fix them. This module was born out of a use-case for a client project where we manage new form submissions through Trello. I'm not sure how many use-cases there are for this module. If you do use it, tell me about it! The Trello API is pretty extensive, I'll try to add some more helper methods to the TrelloWireApi class (let me know if you need anything in particular). I'll think about how the module can support different workflows that include Twig – talk to me if you have a use-case! Next steps could be a dashboard to manage pages that are connected to a Trello card, or a new section in the settings tab to manage the Trello connection. But it depends on whether there is any interest in this 🙂 Links
      Repository on Github Complete module documentation (getting started, configuration & API documentation) [Module directory pending approval] Module configuration

    • By MoritzLost
      Process Cache Control
      This module provides a simple solution to clearing all your cache layers at once, and an extensible interface to perform various cache-related actions.
      The simple motivation behind this module was that I was tired of manually clearing caches in several places after deploying a change on a live site. The basic purpose of this module is a simple Clear all caches link in the Setup menu which clears out all caches, no matter where they hide. You can customize what exactly the module does through it's configuration menu:
      Expire or delete all cache entries in the database, or selectively clear caches by namespace ($cache API) Clear the the template render cache. Clear out specific folders inside your site's cache directory (/site/assets/cache) Clear the ProCache page render cache (if your site is using ProCache) Refresh version strings for static assets to bust client-side browser caches (this requires some setup, see the full documentation for details). This is the basic function of the module. However, you can also add different cache management action through the API and execute them through the module's interface. For this advanced usage, the module provides:
      An interface to see all available cache actions and execute them. A system log and logging output on the module page to see verify what the module is doing. A CacheControlTools class with utility functions to clear out different caches. An API to add cache actions, execute them programmatically and even modify the default action. Permission management, allowing you granular control over which user roles can execute which actions. The complete documentation can be found in the module's README.
      Plans for improvements
      If there is some interest in this, I plan to expand this to a more general cache management solution. I particular, I would like to add additional cache actions. Some ideas that came to mind:
      Warming up the template render cache for publicly accessible pages. Removing all active user sessions. Let me know if you have more suggestions!
      Links
      https://github.com/MoritzLost/ProcessCacheControl ProcessCacheControl in the Module directory CHANGELOG in the repository Screenshots


    • By Macrura
      PrevNextTabs Module
      Github: https://github.com/outflux3/PrevNextTabs
      Processwire helper modules for adding page navigation within the editor.
      Overview
      This is a very simple module that adds Previous and Next links inline with the tabs on the page editor. Hovering over the tab shows the title of the previous or next page (using the admin's built in jqueryUI tooltips.)
      Usage
      This module is typically used during development where you or your editors need to traverse through pages for the purpose of proofing, flagging and/or commenting. Rather than returning to the page tree or lister, they can navigate with these links.
      Warnings
      If you are using PW version 2.6.1 or later, the system will prevent you from leaving the page if you have unsaved edits.
      For earlier versions, to avoid accidentally losing changes made to a page that might occur if a user accidentally clicks on one of these, make sure to have the Form Save Reminder module installed.
      http://modules.processwire.com/modules/prev-next-tabs/
    • By Gadgetto
      SnipWire - Snipcart integration for ProcessWire
      Snipcart is a powerful 3rd party, developer-first HTML/JavaScript shopping cart platform. SnipWire is the missing link between Snipcart and the content management framework ProcessWire.
      With SnipWire, you can quickly turn any ProcessWire site into a Snipcart online shop. The SnipWire plugin helps you to get your store up and running in no time. Detailed knowledge of the Snipcart system is not required.
      SnipWire is free and open source licensed under Mozilla Public License 2.0! A lot of work and effort has gone into development. It would be nice if you could donate an amount to support further development:

      Status update links (inside this thread) for SnipWire development
      2020-03-21 -- SnipWire 0.8.5 (beta) released! Improves SnipWires webhooks interface and provides some other fixes and additions 2020-03-03 -- SnipWire 0.8.4 (beta) released! Improves compatibility for Windows based Systems. 2020-03-01 -- SnipWire 0.8.3 (beta) released! The installation and uninstallation process has been heavily revised. 2020-02-08 -- SnipWire 0.8.2 (beta) released! Added a feature to change the cart and catalogue currency by GET, POST or SESSION param 2020-02-03 -- SnipWire 0.8.1 (beta) released! All custom classes moved into their own namespaces. 2020-02-01 -- SnipWire is now available via ProcessWire's module directory! 2020-01-30 -- SnipWire 0.8.0 (beta) first public release! (module just submitted to the PW modules directory) 2020-01-28 -- added Custom Order Fields feature (first SnipWire release version is near!) 2020-01-21 -- Snipcart v3 - when will the new cart system be implemented? 2020-01-19 -- integrated taxes provider finished (+ very flexible shipping taxes handling) 2020-01-14 -- new date range picker, discount editor, order notifiactions, order statuses, and more ... 2019-11-15 -- orders filter, order details, download + resend invoices, refunds 2019-10-18 -- list filters, REST API improvements, new docs platform, and more ... 2019-08-08 -- dashboard interface, currency selector, managing Orders, Customers and Products, Added a WireTabs, refinded caching behavior 2019-06-15 -- taxes provider, shop templates update, multiCURL implementation, and more ... 2019-06-02 -- FieldtypeSnipWireTaxSelector 2019-05-25 -- SnipWire will be free and open source Plugin Key Features
      Fast and simple store setup Full integration of the Snipcart dashboard into the ProcessWire backend (no need to leave the ProcessWire admin area) Browse and manage orders, customers, discounts, abandoned carts, and more Multi currency support Custom order and cart fields Process refunds and send customer notifications from within the ProcessWire backend Process Abandoned Carts + sending messages to customers from within the ProcessWire backend Complete Snipcart webhooks integration (all events are hookable via ProcessWire hooks) Integrated taxes provider (which is more flexible then Snipcart own provider) Useful Links
      SnipWire in PW modules directory SnipWire Docs (please note that the documentation is a work in progress) SnipWire @GitHub (feature requests and suggestions for improvement are welcome - I also accept pull requests) Snipcart Website  
      ---- INITIAL POST FROM 2019-05-25 ----
       
×
×
  • Create New...