README 1.2 KB

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