]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - plugins/Imap/README
Merge remote-tracking branch 'upstream/master' into social-master
[quix0rs-gnu-social.git] / plugins / Imap / README
1 The IMAP plugin allows for StatusNet to check a POP or IMAP mailbox for
2 incoming mail containing user posts.
3
4 Installation
5 ============
6 addPlugin('imap', array(
7     'mailbox' => '...',
8     'user' => '...',
9     'password' => '...'
10 ));
11 to the bottom of your config.php
12
13 Also, make sure:
14 $config['mail']['domain'] = 'yourdomain.example.net';
15 is set in your config.php
16
17 Create a catch-all account for your domain, and use this account with this
18 plugin. Whenever a user sends a message to their personal notice posting
19 address, the message should end up in this mailbox, and then the plugin daemon
20 will pick it up and post the notice on the user's behalf.
21
22 The daemon included with this plugin must be running. It will be started by
23 the plugin along with their other daemons when you run scripts/startdaemons.sh.
24 See the StatusNet README for more about queuing and daemons.
25
26 Settings
27 ========
28 mailbox*: the mailbox specifier.
29     See http://www.php.net/manual/en/function.imap-open.php for details
30 user*: username to use when authenticating to the mailbox
31 password*: password to use when authenticating to the mailbox
32 poll_frequency: how often (in seconds) to check for new messages