ikiwiki (3.20130711) unstable; urgency=low
[ikiwiki.git] / doc / plugins / contrib / postal.mdwn
1 [[!template id=plugin name=postal author="[[DavidBremner]]"]]
2 [[!tag type/special-purpose]]
3
4 The `postal` plugin allows users to send mail to
5 a special address to comment on a page. It uses the [[mailbox]]
6 plugin to display their comments in the wiki.
7
8 This plugin is not in ikiwiki yet, but can be downloaded
9 from <http://pivot.cs.unb.ca/git/ikipostal.git>
10
11 Details:
12
13   * Adds a mailto: url to each page matching some pagespec
14     (currently every page gets a comment footer)
15
16   * This mailto url goes to an address identifying the page  (something like
17     user-iki-blog~I\_hate\_markdown@host.fqdn.tld).
18     [more details](http://www.cs.unb.ca/~bremner/blog/posts/encoding)         
19    
20   * on the mail receiving end, these messages are either deleted, or ran through
21     a filter to be turned into blog posts.   I have
22 [written](http://pivot.cs.unb.ca/git/?p=ikipostal.git;a=blob_plain;f=filters/postal-accept.pl;hb=HEAD)
23   a filter that decodes the address and writes the message into an appropriate 
24 mailbox. The changes are then checked into version control; typically a hook then updates the html version of the wiki.
25   * work in progress can be 
26
27    - [cloned](http://pivot.cs.unb.ca/git/ikipostal.git), or 
28    - [browsed](http://pivot.cs.unb.ca/git/?p=ikipostal.git;a=summary)
29   
30  * I would be interested in any ideas people have about security.
31
32 The current version of this plugin is now running on my home page. See for example
33 [a recent post in my blog](http://www.cs.unb.ca/~bremner/blog/posts/can-i-haz-a-distributed-rss/).  
34 Unfortunately although the [[mailbox|todo/mbox]] renderer supports threading, I haven't had 
35 a chance to implement comments on comments yet. --[[DavidBremner]]