add contrib plugin page for postal plugin

1 files changed, 39 insertions, 0 deletions

diff --git a/doc/plugins/contrib/postal.mdwn b/doc/plugins/contrib/postal.mdwn
new file mode 100644
index 000000000..b14c80d3b
--- /dev/null
+++ b/doc/plugins/contrib/postal.mdwn
@@ -0,0 +1,39 @@
+[[!template id=plugin name=postal author="[[DavidBremner]]"]]
+[[!tag type/useful]]
+
+The `postal` plugin allows users to send mail to
+a special address to comment on a page. It uses the [[mailbox]]
+plugin to display their comments in the wiki.
+
+This plugin is not in ikiwiki yet, but can be downloaded
+from <http://pivot.cs.unb.ca/git/ikipostal.git>
+
+Details:
+
+  * Adds a mailto: url to each page matching some pagespec
+    (currently every page gets a comment footer)
+
+  * This mailto url goes to an address identifying the page  (something like
+    user-iki-blog~I\_hate\_markdown@host.fqdn.tld).
+    [more details](http://www.cs.unb.ca/~bremner/blog/posts/encoding)         
+   
+  * on the mail receiving end, these messages are either deleted, or ran through
+    a filter to be turned into blog posts.  As a first step, I have
+[written](http://pivot.cs.unb.ca/git/?p=ikipostal.git;a=blob_plain;f=filters/postal-filer.pl;hb=010357a08e9)
+a filter that decodes the address and writes the message into an appropriate 
+mailbox. I would be interested in any ideas people have about security.
+
+  * the same plugin can check for comments on a particular page next time the wiki 
+    is generated, and add a link. (more or less done)
+    > If the filter just checks in the posts into revision control, the
+    > post-commit hook would handle updating the wiki to include those
+    > posts as they come in. --[[Joey]]
+  * work in progress can be 
+
+   - [cloned](http://pivot.cs.unb.ca/git/ikipostal.git), or 
+   - [browsed](http://pivot.cs.unb.ca/git/?p=ikipostal.git;a=summary)
+  
+The current version of this plugin is now running on my home page. See for example
+[a recent post in my blog](http://www.cs.unb.ca/~bremner/blog/posts/can-i-haz-a-distributed-rss/).  
+Unfortunately although the [[mailbox|todo/mbox]] renderer supports threading, I haven't had 
+a chance to implement comments on comments yet. --[[DavidBremner]]