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

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

Join the conversation

You can post now and register later. If you have an account, sign in now to post with your account.

Guest
Reply to this topic...

×   Pasted as rich text.   Paste as plain text instead

  Only 75 emoji are allowed.

×   Your link has been automatically embedded.   Display as a link instead

×   Your previous content has been restored.   Clear editor

×   You cannot paste images directly. Upload or insert images from URL.


  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

    • 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-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 Process refunds and send customer notifications 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 (alpha version only available via GitHub) 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 ----
       
    • By d'Hinnisdaël
      Happy new year, everybody 🥬
      I've been sitting on this Dashboard module I made for a client and finally came around to cleaning it up and releasing it to the wider public. This is how it looks.
      ProcessWire Dashboard

      If anyone is interested in trying this out, please go ahead! I'd love to get some feedback on it. If this proves useful and survives some real-world testing, I'll add this to the module directory.
      Download
      You can find the latest release on Github.
      Documentation
      Check out the documentation to get started. This is where you'll find information about included panel types and configuration options.
      Custom Panels
      My goal was to make it really simple to create custom panels. The easiest way to do that is to use the panel type template and have it render a file in your templates folder. This might be enough for 80% of all use cases. For anything more complex (FormBuilder submissions? Comments? Live chat?), you can add new panel types by creating modules that extend the DashboardPanel base class. Check out the documentation on custom panels or take a look at the HelloWorld panel to get started. I'm happy to merge any user-created modules into the main repo if they might be useful to more than a few people.
       Disclaimer
      This is a pre-release version. Please treat it as such — don't install it on production sites. Just making sure 🍇
      Roadmap
      These are the things I'm looking to implement myself at some point. The wishlist is a lot longer, but those are the 80/20 items that I probably won't regret spending time on.
      Improve documentation & add examples ⚙️ Panel types Google Analytics ⚙️ Add new page  🔥 Drafts 🔥 At a glance / Page counter 404s  Layout options Render multiple tabs per panel panel groups with heading and spacing between ✅ panel wrappers as grid item (e.g. stacked notices) ✅ Admin themes support AdminThemeReno and AdminThemeDefault ✅ Shortcuts panel add a table layout with icon, title & summary ✅ Chart panel add default styles for common chart types ✅ load chart data from JS file (currently passed as PHP array) Collection panel support image columns ✅ add buttons: view all & add new ✅
    • By Robin S
      This module is inspired by and similar to the Template Stubs module. The author of that module has not been active in the PW community for several years now and parts of the code for that module didn't make sense to me, so I decided to create my own module. Auto Template Stubs has only been tested with PhpStorm because that is the IDE that I use.
      Auto Template Stubs
      Automatically creates stub files for templates when fields or fieldgroups are saved.
      Stub files are useful if you are using an IDE (e.g. PhpStorm) that provides code assistance - the stub files let the IDE know what fields exist in each template and what data type each field returns. Depending on your IDE's features you get benefits such as code completion for field names as you type, type inference, inspection, documentation, etc.
      Installation
      Install the Auto Template Stubs module.
      Configuration
      You can change the class name prefix setting in the module config if you like. It's good to use a class name prefix because it reduces the chance that the class name will clash with an existing class name.
      The directory path used to store the stub files is configurable.
      There is a checkbox to manually trigger the regeneration of all stub files if needed.
      Usage
      Add a line near the top of each of your template files to tell your IDE what stub class name to associate with the $page variable within the template file. For example, with the default class name prefix you would add the following line at the top of the home.php template file:
      /** @var tpl_home $page */ Now enjoy code completion, etc, in your IDE.

      Adding data types for non-core Fieldtype modules
      The module includes the data types returned by all the core Fieldtype modules. If you want to add data types returned by one or more non-core Fieldtype modules then you can hook the AutoTemplateStubs::getReturnTypes() method. For example, in /site/ready.php:
      // Add data types for some non-core Fieldtype modules $wire->addHookAfter('AutoTemplateStubs::getReturnTypes', function(HookEvent $event) { $extra_types = [ 'FieldtypeDecimal' => 'string', 'FieldtypeLeafletMapMarker' => 'LeafletMapMarker', 'FieldtypeRepeaterMatrix' => 'RepeaterMatrixPageArray', 'FieldtypeTable' => 'TableRows', ]; $event->return = $event->return + $extra_types; }); Credits
      Inspired by and much credit to the Template Stubs module by mindplay.dk.
       
      https://github.com/Toutouwai/AutoTemplateStubs
      https://modules.processwire.com/modules/auto-template-stubs/
    • By Mike Rockett
      Jumplinks for ProcessWire
      Release: 1.5.60
      Composer: rockett/jumplinks
      ⚠️ NOTICE: 1.5.60 is an important security patch-release for an XSS vulnerability discovered by @phlp. It's HIGHLY RECOMMENDED that all Jumplinks users update to the latest version as soon as possible.
      Jumplinks is an enhanced version of the original ProcessRedirects by Antti Peisa.
      The Process module manages your permanent and temporary redirects (we'll call these "jumplinks" from now on, unless in reference to redirects from another module), useful for when you're migrating over to ProcessWire from another system/platform. Each jumplink supports wildcards, shortening the time needed to create them.
      Unlike similar modules for other platforms, wildcards in Jumplinks are much easier to work with, as Regular Expressions are not fully exposed. Instead, parameters wrapped in curly braces are used - these are described in the documentation.
      Under Development: 2.0, to be powered by FastRoute
      As of version 1.5.0, Jumplinks requires at least ProcessWire 2.6.1 to run.
      View on GitLab
      Download via the Modules Directory
      Read the docs
      Features
      The most prominent features include:
      Basic jumplinks (from one fixed route to another) Parameter-based wildcards with "Smart" equivalents Mapping Collections (for converting ID-based routes to their named-equivalents without the need to create multiple jumplinks) Destination Selectors (for finding and redirecting to pages containing legacy location information) Timed Activation (activate and/or deactivate jumplinks at specific times) 404-Monitor (for creating jumplinks based on 404 hits) Additionally, the following features may come in handy:
      Stale jumplink management Legacy domain support for slow migrations An importer (from CSV or ProcessRedirects) Feedback & Feature Requests
      I’d love to know what you think of this module. Please provide some feedback on the module as a whole, or even regarding smaller things that make it whole. Also, please feel free to submit feature requests and their use-cases.
      Note: Features requested so far have been added to the to-do list, and will be added to 2.0, and not the current dev/master branches.
      Open Source

      Jumplinks is an open-source project, and is free to use. In fact, Jumplinks will always be open-source, and will always remain free to use. Forever. If you would like to support the development of Jumplinks, please consider making a small donation via PayPal.
      Enjoy! 🙂
    • By Robin S
      Add Image URLs
      Allows images/files to be added to Image/File fields by pasting URLs.

      Usage
      Install the Add Image URLs module.
      A "Paste URLs" button will be added to all image and file fields. Use the button to show a textarea where URLs may be pasted, one per line. Images/files are added when the page is saved.
       
      https://github.com/Toutouwai/AddImageUrls
      https://modules.processwire.com/modules/add-image-urls/
×
×
  • Create New...