Jump to content
Pete

ProcessEmailToPage

Recommended Posts

Hi all

This module was sponsored by Jason as per this topic: http://processwire.com/talk/topic/3566-email-image-module-development/

It's quite similar to horst & ryan's EmailImage module, but supports multiple email addresses for sending emails to different parts of your site, also allowing you to select different templates. There is also a delimiter option whereby you can split up the email's content and have text appear in the body or sidebar etc.

Here's a video to show you what I mean.

The video may well be of interest to other module authors as I used some Ajax to push what can normally be done in the module config - hope you like it :)

There was the temptation to build on the EmailImage module with this one, but I already had code for my Helpdesk module (work in progress) that parsed emails using Flourishlib and wanted to use that code instead for this one.

EDIT: Also worth noting is that unlike the EmailImage module, this doesn't come with a pre-built gallery template for the front-end. This is intentional as you could pipe emails into any part of a site you like, so I couldn't make assumptions as to usage of the content.

You can download it via the modules directory.

  • Like 22

Share this post


Link to post
Share on other sites

Pete this is incredibly well done and beautifully put together–nice job! 

  • Like 1

Share this post


Link to post
Share on other sites

Pete, this looks fantastic (just watched the video).

Few questions popped on my mind while watching: why is parent page called category on module settings page? "Images" field name seems to be hardcoded? Does (or will it) support other attachments than images?

Again, brilliant work. Thanks Pete & Jason.

  • Like 1

Share this post


Link to post
Share on other sites

Thanks ryan!

And thanks again to Jason for letting my run with some ideas. I could just as easily completed this by making the admin enter comma separated values in a textarea field (the easy way to go) but I wanted to make input foolproof and the idea was already in my head.

And now some techy stuff:

I had some fun working out the ajax behind adding new rows and settling on saving the field data as a JSON string in the end (which is fine because nobody is going to set up dozens of email accounts!) but if there are any suggestions for improvement there then please let me know as it seems to me now that there are endless possibilities for "add another row" type setups in module configuration.

Before that I was trying to overcomplicate things and have the new rows save in the background as an array, but if I intercepted the page save, ran the ajax request and then use jQuery to finish submitting the form then it wouldn't save the other form data. I abandoned that idea completely (but left the function in the module file for reference). In the end, keeping it simple worked out better as running ajax upon saving the config page slowed the page save process down as it essentially sent two requests - converting the data to a json string and saving to a hidden field is instantaneous by comparison :D

To those not following all that, my eventual solution was to KISS :)

  • Like 3

Share this post


Link to post
Share on other sites

Antti - to answer your questions:

  1. This grated on me every time I wrote the word "category" and I should probably just change it to "parent page" as that's more in keeping with ProcessWire's terminology (to newcomers "Category" makes sense, but PW is all about enticing people to learn new things after all ;)). I'll change this in the next update.
  2. It is hardcoded to the images field for now. I realise this is a bit of a gamble that they haven't renamed/deleted this field, so should probably add an extra config option for this. The reason I didn't for now is that it then led me to thinking (as you have) about other file types and then I thought about allowing different fields for different templates and started to get a headache :D I should at least do the first part and allow the admin to select a different field, plus add more checks for attachment filetypes.

As a result of those two points, the next version really needs:

  • Rename "category" to "parent page" throughout
  • Allow admin to select image field
  • Add more checks for filetypes attached to emails
  • Add field for whitelist of email addresses
  • Maybe allow for other attachments (why not? It's simple enough ;))

Not sure when I might get around to these as there may be other stuff in the pipeline before then :)

  • Like 3

Share this post


Link to post
Share on other sites

Glad you guys like it, Pete did a phenomenal job and was great to work with. More modules to follow soon, standby! :-)

  • Like 5

Share this post


Link to post
Share on other sites

thanks for the module Jason & Pete!

I got a problem running the cron job via module hash though:

Error:     Exception: There was an error connecting to the server (in /[...]/site/modules/ProcessEmailToPage/flourishlib/fMailbox.php
line 981)

#0 /[...]/site/modules/ProcessEmailToPage/flourishlib/fMailbox.php(1227): fMailbox->connect()

#1 /[...]/site/modules/ProcessEmailToPage/ProcessEmailToPage.module(265): fMailbox->listMessages()

#2 /[...]/wire/core/Wire.php(293): ProcessEmailToPage->importFromEmail(Object(HookEvent))

#3 /[...]/wire/core/Wire.php(229): Wire->runHooks('render', Array)

#4 /[...]/wire/modules/Process/ProcessPageView.module(97): Wire->__call('render', Array)

#5 /[...]/wire/modules/Process/ProcessPageView.module(97): Page->render()

#6 [internal function]: Pro
 

... guess the email/host settings aren't right

the email account is set up for the same domain the actual website is on.

any ideas what I could have missed?

thanks a lot, cheers

Share this post


Link to post
Share on other sites

I'd probably need to see your configuration for the module, as well as exactly what you've put as the link in CRON - you can PM me a screenshot of the config if you like.

  • Like 1

Share this post


Link to post
Share on other sites

Thanks for this amazing Module Pete!

I have a site but don't have an email server/service running on the domain where a site is.

Am I being thick by assuming I can setup say a Gmail address and use the IMAP or POP instructions for accessing that Gmail in your Modules fields and it should work, or am I missing something basic (I've assumed the fields Password, Type, Host, Port Number mean the Module is going to go and read emails from an email server, such as Gmail)?

I went with the above assumptions but got errors but rather than bore you with detail I thought I'd ask the above first.

Thanks in advance for any comments ^_^

Share this post


Link to post
Share on other sites

Hi Alan

It should work with a Gmail account, though I've not tried yet - all mine have rather too much mail in to give it a go without consuming vast amounts of server memory :D

Share this post


Link to post
Share on other sites

;) I *know* what you're saying there Pete about Gmail!

Good to know it should work.

One question before I go back and try again, does the Module look for unread Emails, act on those, mark them as read and hence not post the same thing twice on successive cron runs, or is there some other mechanism that manages this?

Share this post


Link to post
Share on other sites

It will read in anything from the mailbox and delete the emails once it's done, so be careful with that!

Share this post


Link to post
Share on other sites

Excellent, understood, thanks Pete!

Share this post


Link to post
Share on other sites

I can confirm that it does work with Gmail. Configuring Gmail took a tad more tinkering than my POP3 account. I think this was the information I used a couple months back when checking it out -

Incoming Mail (POP3) Server - requires SSL: pop.gmail.com
Use SSL: Yes
Port: 995

Share this post


Link to post
Share on other sites

Hmm. I am not getting IMAP or POP to work, with POP I am getting when I run the CRON

Internal Server Error

The server encountered an internal error or misconfiguration and was unable to complete your request.
Please contact the server administrator to inform of the time the error occurred and of anything you might have done that may have caused the error.

More information about this error may be available in the server error log. 

I *think* it may be that the webserver in question has no email access or server (so I think for instance that the usual ports for POP are closed in the firewall).

Maybe this means I just can't use this Module (sad).

Share this post


Link to post
Share on other sites

Pete, have you tried (or had any problems) with Flourish incorrectly converting non-standard ASCII characters in your emails? I was enjoying their Mailbox classes for something else up until I had this problem, then checked their GitHub issues page and was a lot more skeptical. I'll be checking out Zend's classes now to see if it works any better, but was curious with your own results in using this.

Dealing with mail and all the different variations on what should be a strict format is kind of a pain. :)

== EDIT ==

Nevermind. I just noticed that in my super-quick test page to see how Flourish would work I did not set up the proper PHP settings for UTF-8 rendering (header and meta). It would be worth noting that a site (or page) layout using the Flourish library must be rendered in UTF-8 due to how it was developed. I feel silly, but am glad that I was mistaken. I may still look at Zend, but only if Flourish doesn't handle all of my use-cases properly.

Share this post


Link to post
Share on other sites

Brendon - was going to say I hadn't noticed any issues but glad it's not an issue anyway.

When testing I'd used webmail like Gmail, as well as self-hosted webmail RoundCube and finally Outlook. I've not tried every combination of email program though as there are too many variations as you say.

In an ideal world, someone would invent "Email 2.0" to fix non-standard formats and banish spam forever somehow, but until then we're stuck with non-standard programs all doing slightly different things ;)

  • Like 1

Share this post


Link to post
Share on other sites

Hi

I've been installing this great module, and it does appear to be mostly working; except for an issue.

The subject line parses ok and forms the title of the new page, but anything after that doesn't seem to process. I've tried just general text and using the delimiter ==blog==, but anything other than the title doesn't seem to appear in the new pages?

Share this post


Link to post
Share on other sites

Can you post an example of the body of the email please?

Theoretically, if you have a field called "blog" then anything in the email before ==blog== will be posted to the "body" field, and anything after ==blog== to the blog field.

Share this post


Link to post
Share on other sites

Cheers Pete

It looks like this:

























Subject:   Title goes in this field From:   ###@####web.com Date:   Sun, October 20, 2013 12:24 am To:   ###@####web.com Priority:   Normal
Options: 



body goes in this field==blog==blog text goes in this field

and yet, every time, the title get successfully posted into the new page but anything else just seems to get ignored

Share this post


Link to post
Share on other sites

As long as there are fields called "body" and "blog" in the template these posts are being sent to I'm not sure what the issue might be. Does it definitely use the right template when creating the pages?

Does it do anything if you remove the ==blog== delimiter? Theoretically that should post all content to the body field.

Share this post


Link to post
Share on other sites

Yes, I've tried it without ==blog== written in also hoping it would just write the the body field but nothing. It's very odd, it successfully brings the title across. And as the title is coming across it would make sense that the connection to the mail server is successful. The mail server is on a separate box but connection appears to succeed.

I did have the module stored in the root of the modules directory, but since then I've uninstalled the module, moved the files to /site/modules/ProcessEmailToPage and reinstalled.

Is there anything else I can try as I really like the idea of the module.

Share this post


Link to post
Share on other sites

thanks for the module Jason & Pete!

I got a problem running the cron job via module hash though:

Error:     Exception: There was an error connecting to the server (in /[...]/site/modules/ProcessEmailToPage/flourishlib/fMailbox.php
line 981)
...
 
...

fenton, what was the problem in your case. Have the same here.

greetings,

martin

Share this post


Link to post
Share on other sites

fenton, what was the problem in your case. Have the same here.

greetings,

martin

got ist. secure wasn`t recognised, changed port to 143 and works fine.

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 teppo
      Needed a really simple solution to embed audio files within page content and couldn't find a module for that, so here we go. Textformatter Audio Embed works a bit like Textformatter Video Embed, converting this:
      <p>https://www.domain.tld/path/to/file.mp3</p> Into this:
      <audio controls class="TextformatterAudioEmbed"> <source src="https://www.domain.tld/path/to/file.mp3" type="audio/mpeg"> </audio> The audio element has pretty good browser support, so quite often this should be enough to get things rolling 🙂
      GitHub repository: https://github.com/teppokoivula/TextformatterAudioEmbed Modules directory: https://modules.processwire.com/modules/textformatter-audio-embed/
    • By Richard Jedlička
      Tense    
      Tense (Test ENvironment Setup & Execution) is a command-line tool to easily run tests agains multiple versions of ProcessWire CMF.
      Are you building a module, or a template and you need to make sure it works in all supported ProcessWire versions? Then Tense is exactly what you need. Write the tests in any testing framework, tell Tense which ProcessWire versions you are interested in and it will do the rest for you.

      See example or see usage in a real project.
      How to use?
      1. Install it: 
      composer global require uiii/tense 2. Create tense.yml config:
      tense init 3. Run it:
      tense run  
      For detailed instructions see Github page: https://github.com/uiii/tense
       
      This is made possible thanks to the great wireshell tool by @justb3a, @marcus and others.
       
      What do you think about it? Do you find it useful? Do you have some idea? Did you find some bug? Tell me you opinion. Write it here or in the issue tracker.
    • By Chris Bennett
      Hi all, I am going round and round in circles and would greatly appreciate if anyone can point me in the right direction.
      I am sure I am doing something dumb, or missing something I should know, but don't. Story of my life 😉

      Playing round with a module and my basic problem is I want to upload an image and also use InputfieldMarkup and other Inputfields.
      Going back and forth between trying an api generated page defining Fieldgroup, Template, Fields, Page and the InputfieldWrapper method.

      InputfieldWrapper method works great for all the markup stuff, but I just can't wrap my head around what I need to do to save the image to the database.
      Can generate a Field for it (thanks to the api investigations) but not sure what I need to do to link the Inputfield to that. Tried a lot of stuff from various threads, of varying dates without luck.
      Undoubtedly not helped by me not knowing enough.

      Defining Fieldgroup etc through the api seems nice and clean and works great for the images but I can't wrap my head around how/if I can add/append/hook the InputfieldWrapper/InputfieldMarkup stuff I'd like to include on that template as well. Not even sure if it should be where it is on ___install with the Fieldtype stuff or later on . Not getting Tracy errors, just nothing seems to happen.
      If anyone has any ideas or can point me in the right direction, that would be great because at the moment I am stumbling round in the dark.
       
      public function ___install() { parent::___install(); $page = $this->pages->get('name='.self::PAGE_NAME); if (!$page->id) { // Create fieldgroup, template, fields and page // Create new fieldgroup $fmFieldgroup = new Fieldgroup(); $fmFieldgroup->name = MODULE_NAME.'-fieldgroup'; $fmFieldgroup->add($this->fields->get('title')); // needed title field $fmFieldgroup->save(); // Create new template using the fieldgroup $fmTemplate = new Template(); $fmTemplate->name = MODULE_NAME; $fmTemplate->fieldgroup = $fmFieldgroup; $fmTemplate->noSettings = 1; $fmTemplate->noChildren = 1; $fmTemplate->allowNewPages = 0; $fmTemplate->tabContent = MODULE_NAME; $fmTemplate->noChangeTemplate = 1; $fmTemplate->setIcon(ICON); $fmTemplate->save(); // Favicon source $fmField = new Field(); $fmField->type = $this->modules->get("FieldtypeImage"); $fmField->name = 'fmFavicon'; $fmField->label = 'Favicon'; $fmField->focusMode = 'off'; $fmField->gridMode = 'grid'; $fmField->extensions = 'svg png'; $fmField->columnWidth = 50; $fmField->collapsed = Inputfield::collapsedNever; $fmField->setIcon(ICON); $fmField->addTag(MODULE_NAME); $fmField->save(); $fmFieldgroup->add($fmField); // Favicon Silhouette source $fmField = new Field(); $fmField->type = $this->modules->get("FieldtypeImage"); $fmField->name = 'fmFaviconSilhouette'; $fmField->label = 'SVG Silhouette'; $fmField->notes = 'When creating a silhouette/mask svg version for Safari Pinned Tabs and Windows Tiles, we recommend setting your viewbox for 0 0 16 16, as this is what Apple requires. In many cases, the easiest way to do this in something like illustrator is a sacrificial rectangle with no fill, and no stroke at 16 x 16. This forces the desired viewbox and can then be discarded easily using something as simple as notepad. Easy is good, especially when you get the result you want without a lot of hassle.'; $fmField->focusMode = 'off'; $fmField->extensions = 'svg'; $fmField->columnWidth = 50; $fmField->collapsed = Inputfield::collapsedNever; $fmField->setIcon(ICON); $fmField->addTag(MODULE_NAME); $fmField->save(); $fmFieldgroup->add($fmField); // Create: Open Settings Tab $tabOpener = new Field(); $tabOpener->type = new FieldtypeFieldsetTabOpen(); $tabOpener->name = 'fmTab1'; $tabOpener->label = "Favicon Settings"; $tabOpener->collapsed = Inputfield::collapsedNever; $tabOpener->addTag(MODULE_NAME); $tabOpener->save(); // Create: Close Settings Tab $tabCloser = new Field(); $tabCloser->type = new FieldtypeFieldsetClose; $tabCloser->name = 'fmTab1' . FieldtypeFieldsetTabOpen::fieldsetCloseIdentifier; $tabCloser->label = "Close open tab"; $tabCloser->addTag(MODULE_NAME); $tabCloser->save(); // Create: Opens wrapper for Favicon Folder Name $filesOpener = new Field(); $filesOpener->type = new FieldtypeFieldsetOpen(); $filesOpener->name = 'fmOpenFolderName'; $filesOpener->label = 'Wrap Folder Name'; $filesOpener->class = 'inline'; $filesOpener->collapsed = Inputfield::collapsedNever; $filesOpener->addTag(MODULE_NAME); $filesOpener->save(); // Create: Close wrapper for Favicon Folder Name $filesCloser = new Field(); $filesCloser->type = new FieldtypeFieldsetClose(); $filesCloser->name = 'fmOpenFolderName' . FieldtypeFieldsetOpen::fieldsetCloseIdentifier; $filesCloser->label = "Close open fieldset"; $filesCloser->addTag(MODULE_NAME); $filesCloser->save(); // Create Favicon Folder Name $fmField = new Field(); $fmField->type = $this->modules->get("FieldtypeText"); $fmField->name = 'folderName'; $fmField->label = 'Favicon Folder:'; $fmField->description = $this->config->urls->files; $fmField->placeholder = 'Destination Folder for your generated favicons, webmanifest and browserconfig'; $fmField->columnWidth = 100; $fmField->collapsed = Inputfield::collapsedNever; $fmField->setIcon('folder'); $fmField->addTag(MODULE_NAME); $fmField->save(); $fmFieldgroup->add($tabOpener); $fmFieldgroup->add($filesOpener); $fmFieldgroup->add($fmField); $fmFieldgroup->add($filesCloser); $fmFieldgroup->add($tabCloser); $fmFieldgroup->save(); /////////////////////////////////////////////////////////////// // Experimental Markup Tests $wrapperFaviconMagic = new InputfieldWrapper(); $wrapperFaviconMagic->attr('id','faviconMagicWrapper'); $wrapperFaviconMagic->attr('title',$this->_('Favicon Magic')); // field show info what $field = $this->modules->get('InputfieldMarkup'); $field->name = 'use'; $field->label = __('How do I use it?'); $field->collapsed = Inputfield::collapsedNever; $field->icon('info'); $field->attr('value', 'Does this even begin to vaguely work?'); $field->columnWidth = 50; $wrapperFaviconMagic->add($field); $fmTemplate->fields->add($wrapperFaviconMagic); $fmTemplate->fields->save(); ///////////////////////////////////////////////////////////// // Create page $page = $this->wire( new Page() ); $page->template = MODULE_NAME; $page->parent = $this->wire('pages')->get('/'); $page->addStatus(Page::statusHidden); $page->title = 'Favicons'; $page->name = self::PAGE_NAME; $page->process = $this; $page->save(); } }  
    • By Sebi
      Since it's featured in ProcessWire Weekly #310, now is the time to make it official:
      Here is Twack!
      I really like the following introduction from ProcessWire Weekly, so I hope it is ok if I use it here, too. Look at the project's README for more details!
      Twack is a new — or rather newish — third party module for ProcessWire that provides support for reusable components in an Angular-inspired way. Twack is implemented as an installable module, and a collection of helper and base classes. Key concepts introduced by this module are:
      Components, which have separate views and controllers. Views are simple PHP files that handle the output for the component, whereas controllers extend the TwackComponent base class and provide additional data handling capabilities. Services, which are singletons that provide a shared service where components can request data. The README for Twack uses a NewsService, which returns data related to news items, as an example of a service. Twack components are designed for reusability and encapsulating a set of features for easy maintainability, can handle hierarchical or recursive use (child components), and are simple to integrate with an existing site — even when said site wasn't originally developed with Twack.
      A very basic Twack component view could look something like this:
      <?php namespace ProcessWire; ?> <h1>Hello World!</h1> And here's how you could render it via the API:
      <?php namespace Processwire; $twack = $modules->get('Twack'); $hello = $twack->getNewComponent('HelloWorld'); ?> <html> <head> <title>Hello World</title> </head> <body> <?= $hello->render() ?> </body> </html> Now, just to add a bit more context, here's a simple component controller:
      <?php namespace ProcessWire; class HelloWorld extends TwackComponent { public function __construct($args) { parent::__construct($args); $this->title = 'Hello World!'; if(isset($args['title'])) { $this->title = $args['title']; } } } As you can see, there's not a whole lot new stuff to learn here if you'd like to give Twack a try in one of your projects. The Twack README provides a really informative and easy to follow introduction to all the key concepts (as well as some additional examples) so be sure to check that out before getting started. 
      Twack is in development for several years and I use it for every new project I build. Also integrated is an easy to handle workflow to make outputs as JSON, so it can be used to build responses for a REST-api as well. I will work that out in one section in the readme as well. 
      If you want to see the module in an actual project, I have published the code of www.musical-fabrik.de in a repository. It runs completely with Twack and has an app-endpoint with ajax-output as well.
      I really look forward to hear, what you think of Twack🥳!
      Features Installation Usage Quickstart: Creating a component Naming conventions & component variants Component Parameters directory page parameters viewname Asset handling Services Named components Global components Ajax-Output Configuration Versioning License Changelog
    • By Robin S
      Page Reference Default Value
      Most ProcessWire core inputfield types that can be used with a Page Reference field support a "Default value" setting. This module extends support for default values to the following core inputfield types:
      Page List Select Page List Select Multiple Page Autocomplete (single and multiple) Seeing as these inputfield types only support the selection of pages a Page List Select / Page List Select Multiple is used for defining the default value instead of the Text / Textarea field used by the core for other inputfield types. This makes defining a default value a bit more user-friendly.
      Note that as per the core "Default value" setting, the Page Reference field must be set to "required" in order for the default value to be used.
      Screenshot

       
      https://github.com/Toutouwai/PageReferenceDefaultValue
      https://modules.processwire.com/modules/page-reference-default-value/
×
×
  • Create New...