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 joshua
      This module is (yet another) way for implementing a cookie management solution.
      Of course there are several other possibilities:
      - https://processwire.com/talk/topic/22920-klaro-cookie-consent-manager/
      - https://github.com/webmanufaktur/CookieManagementBanner
      - https://github.com/johannesdachsel/cookiemonster
      - https://www.oiljs.org/
      - ... and so on ...
      In this module you can configure which kind of cookie categories you want to manage:

      You can also enable the support for respecting the Do-Not-Track (DNT) header to don't annoy users, who already decided for all their browsing experience.
      Currently there are four possible cookie groups:
      - Necessary (always enabled)
      - Statistics
      - Marketing
      - External Media
      All groups can be renamed, so feel free to use other cookie group names. I just haven't found a way to implement a "repeater like" field as configurable module field ...
      When you want to load specific scripts ( like Google Analytics, Google Maps, ...) only after the user's content to this specific category of cookies, just use the following script syntax:
      <script type="text/plain" data-type="text/javascript" data-category="statistics" data-src="/path/to/your/statistic/script.js"></script> <script type="text/plain" data-type="text/javascript" data-category="marketing" data-src="/path/to/your/mareketing/script.js"></script> <script type="text/plain" data-type="text/javascript" data-category="external_media" data-src="/path/to/your/external-media/script.js"></script> <script type="text/plain" data-type="text/javascript" data-category="marketing">console.log("Inline scripts are also working!");</script> The type has to be "optin" to get recognized by PrivacyWire, the data-attributes are giving hints, how the script shall be loaded, if the data-category is within the cookie consents of the user. These scripts are loaded asynchronously after the user made the decision.
      If you want to give the users the possibility to change their consent, you can use the following Textformatter:
      [[privacywire-choose-cookies]] It's planned to add also other Textformatters to opt-out of specific cookie groups or delete the whole consent cookie.
      You can also add a custom link to output the banner again with a link / button with following class:
      <a href="#" class="privacywire-show-options">Show Cookie Options</a> <button class="privacywire-show-options">Show Cookie Options</button> This module is still in development, but we already use it on several production websites.
      You find it here: PrivacyWire Git Repo
      Download as .zip
      I would love to hear your feedback 🙂
      CHANGELOG
      0.1.1 Debugging: fixed error during uninstall 0.1.0 Added new detection of async scripts for W3C Validation 0.0.6 CSS-Debugging for hiding unused buttons, added ProCache support for the JavaScript tag 0.0.5 Multi-language support included completely (also in TextFormatter). Added possibility to async load other assets (e.g. <img type="optin" data-category="marketing" data-src="https://via.placeholder.com/300x300">) 0.0.4 Added possibility to add an imprint link to the banner 0.0.3 Multi-language support for module config (still in development) 0.0.2 First release 0.0.1 Early development
    • By bernhard
      --- Please use RockFinder3 ---
    • By MoritzLost
      Cacheable Placeholders
      This module allows you to have pieces of dynamic content inside cached output. This aims to solve the common problem of having a mostly cacheable site, but with pieces of dynamic output here and there.  Consider this simple example, where you want to output a custom greeting to the current user:
      <h1>Good morning, <?= ucfirst($user->name) ?></h1> This snippet means you can't use the template cache (at least for logged-in users), because each user has a different name. Even if 99% of your output is static, you can only cache the pieces that you know won't include this personal greeting. A more common example would be CSRF tokens for HTML forms - those need to be unique by definition, so you can't cache the form wholesale.
      This module solves this problem by introducing cacheable placeholders - small placeholder tokens that get replaced during every request. The replacement is done inside a Page::render hook so it runs during every request, even if the response is served from the template cache. So you can use something like this:
      <h1>Good morning, {{{greeting}}}</h1> Replacement tokens are defined with a callback function that produces the appropriate output and added to the module through a simple hook:
      // site/ready.php wire()->addHookAfter('CachePlaceholders::getTokens', function (HookEvent $e) { $tokens = $e->return; $tokens['greeting'] = [ 'callback' => function (array $tokenData) { return ucfirst(wire('user')->name); } ]; $e->return = $tokens; }); Tokens can also include parameters that are parsed and passed to the callback function. There are more fully annotated examples and step-by-step instructions in the README on Github!
      Features
      A simple and fast token parser that calls the appropriate callback and runs automatically. Tokens may include multiple named or positional parameters, as well as multi-value parameters. A manual mode that allows you to replace tokens in custom pieces of cached content (useful if you're using the $cache API). Some built-in tokens for common use-cases: CSRF-Tokens, replacing values from superglobals and producing random hexadecimal strings. The token format is completely customizable, all delimiters can be changed to avoid collisions with existing tag parsers or template languages. Links
      Github Repository & documentation Module directory (pending approval) If you are interested in learning more, the README is very extensive, with more usage examples, code samples and usage instructions!
    • By Craig
      I've been using Fathom Analytics for a while now and on a growing number of sites, so thought it was about time there was a PW module for it.
      WayFathomAnalytics
      WayFathomAnalytics is a group of modules which will allow you to view your Fathom Analytics dashboard in the PW admin panel and (optionally) automatically add and configure the tracking code on front-end pages.
      Links
      GitHub Readme & documentation Download Zip Modules directory Module settings screenshot What is Fathom Analytics?
      Fathom Analytics is a simple, privacy-focused website analytics tool for bloggers and businesses.

      Stop scrolling through pages of reports and collecting gobs of personal data about your visitors, both of which you probably don't need. Fathom is a simple and private website analytics platform that lets you focus on what's important: your business.
      Privacy focused Fast-loading dashboards, all data is on a single screen Easy to get what you need, no training required Unlimited email reports Private or public dashboard sharing Cookie notices not required (it doesn't use cookies or collect personal data) Displays: top content, top referrers, top goals and more
    • By daniels
      This is a lightweight alternative to other newsletter & newsletter-subscription modules.
      You can find the Module in the Modules directory and on Github
      It can subscribe, update, unsubscribe & delete a user in a list in Mailchimp with MailChimp API 3.0. It does not provide any forms or validation, so you can feel free to use your own. To protect your users, it does not save any user data in logs or sends them to an admin.
      This module fits your needs if you...
      ...use Mailchimp as your newsletter / email-automation tool ...want to let users subscribe to your newsletter on your website ...want to use your own form, validation and messages (with or without the wire forms) ...don't want any personal user data saved in any way in your ProcessWire environment (cf. EU data regulation terms) ...like to subscribe, update, unsubscribe or delete users to/from different lists ...like the Mailchimp UI for creating / sending / reviewing email campaigns *I have only tested it with PHP 7.x so far, so use on owners risk
      EDIT:
      Since 0.0.4, instructions and changelog can be found in the README only. You can find it here  🙂
      If you have questions or like to contribute, just post a reply or create an issue or pr on github, thanks!
×
×
  • Create New...