forked from KyleAMathews/og_mailinglist
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathINSTALL.TXT
42 lines (22 loc) · 3.98 KB
/
INSTALL.TXT
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
OG Mailinglist - Turns Drupal into a multi-group email list.
OG Mailinglist allows users to start new posts by email and post comments on existing discussions by simply replying to emails. You get the best of both worlds: a browser-based discussion site and an email-based list.
REQUIREMENTS
* A Mail Transfer Agent (MTA) - This module plugs directly into your MTA so emails can be handled immediately upon receipt. Most modules use POP mailboxes, and while this adds portability, it adds a delay to the system. With the method this modules uses, the MTA triggers the module as part of its normal email delivery process.
Right now the only fully supported MTAs are Exim, QMail and Postfix. If you use another MTA, look in the issue queue for issues on other MTAs and offer help or start a new one.
* Organic Groups - This module assumes you are using a group-oriented web site. This module allows for one list per group.
* PHPMailer 5
* PHP libraries Mailparse and mimeDecode
* Sendmail-compatible MTA - At the moment, og_mailinglist directly executes the sendmail or sendmail-compatible binary to send emails. You will therefore need to have a sendmail-compatible binary in your path, and not have PHP set up to disable the system function. Work is underway to remove this requirement. See http://drupal.org/node/951018 for more information on this issue.
INSTALLATION INSTRUCTIONS:
* The module should (generally) be uploaded to the sites/all/modules/ directory. See http://drupal.org/getting-started/install-contrib/modules for more help in installing Drupal contrib modules.
* Download the latest PHPMailer 5.x to og_mailinglist/phpmailer or to libraries/phpmailer if you use the libraries module - http://kent.dl.sourceforge.net/project/phpmailer/phpmailer%20for%20php5_6/PHPMailer%20v5.1/PHPMailer_v5.1.tar.gz
* Install the PHP library mimeDecode. On Debian/Ubuntu run from the command line, "apt-get install php-mail-mimedecode". You can also download the file directly from http://pear.php.net/package/Mail_mimeDecode and add the file either as a subdirectory to og_mailinglist or to the libraries folder. Note, mimeDecode depends on PHP PEAR, which sould be installed on any recent install of PHP but if you get weird errors, this might be something worth checking.
* Go to the Modules page in Drupal and enable the module (like normal). After saving, navigate to admin/og/og_mailinglist and configure per your server setup.
* To setup og_mailinglist for incoming email, follow the installation instructions for your Mail Transfer Agent in the INSTALL.txt file found in its subdirectory (e.g. exim_og_mailinglist).
* To hide quoted parts of email messages, enable the provided input filter "Hide quoted text from comments created via email" at admin/settings/filter and rearrange the filters to set this one first. Note, that for this to work, your input filter(s) will need to allow both the <span> and <div> HTML tags.
* Congratulations. You're running og_mailinglist!
FAQ
Q: I have an existing OG site that I want to install OG Mailinglist on but I don't want people to be subscribed to the mailinglist right away when I install the module. How do I do this?
A: Once the OG Mailinglist is installed, you can set the default subscription setting for people joining a group on the OG Mailinglist admin page. But as OG Mailinglist automatically generates subscriptions for existing users on install, to change the default subscription to "no email" you'll need to change a bit of code. Open the og_mailinglist_api.inc file and find the og_mailinglist_save_group_subscriptions() function. Then for the insert function, change 'email' to 'no email'. See http://drupal.org/node/916934 for more on this.
Q: Users want to be able to post from email accounts other than the one they registered with on the site, is this possible?
A: Yes! OG Mailinglist supports the Mailalias module - http://drupal.org/project/mailalias. Install this on your site and users will be able to add additional email addresses they'd like to post from.