gnu-social

History

Siebrand Mazeland 57c28ba4d0 Update translator documentation and whitespace. Update file header comment.		2011-04-13 13:22:50 +02:00
..
locale	Localisation updates from http://translatewiki.net .	2011-04-11 15:10:09 +02:00
imapmailhandler.php	Update translator documentation and whitespace.	2011-04-13 13:22:50 +02:00
imapmanager.php	Update translator documentation and whitespace.	2011-04-13 13:22:50 +02:00
ImapPlugin.php	Update translator documentation and whitespace.	2011-04-13 13:22:50 +02:00
README	Add an IMAP daemon so StatusNet can process incoming user posts via catch-all mailbox (in addition to the pre-existing script alias method)	2010-01-08 18:52:43 -05:00

README

The IMAP plugin allows for StatusNet to check a POP or IMAP mailbox for
incoming mail containing user posts.

Installation
============
addPlugin('imap', array(
    'mailbox' => '...',
    'user' => '...',
    'password' => '...'
));
to the bottom of your config.php

Also, make sure:
$config['mail']['domain'] = 'yourdomain.example.net';
is set in your config.php

Create a catch-all account for your domain, and use this account with this
plugin. Whenever a user sends a message to their personal notice posting
address, the message should end up in this mailbox, and then the plugin daemon
will pick it up and post the notice on the user's behalf.

The daemon included with this plugin must be running. It will be started by
the plugin along with their other daemons when you run scripts/startdaemons.sh.
See the StatusNet README for more about queuing and daemons.

Settings
========
mailbox*: the mailbox specifier.
    See http://www.php.net/manual/en/function.imap-open.php for details
user*: username to use when authenticating to the mailbox
password*: password to use when authenticating to the mailbox
poll_frequency: how often (in seconds) to check for new messages