Bridge - Discussion Lists and Email Sending from your Mail Reader
- Bridge
- User Guide
- Obtaining The Plugin
- Installation
- Mailing List Configuration
- Advanced Topics
- Plugin Configuration Settings
- Debugging
- COPYRIGHT
- LICENSE
Bridge
Bridge connects your mail reader with Dada Mail, allowing you to send both announce-only messages from your mail reader as well as enabling discussion mailing lists, where each member of your mailing list may send messages out which will then be sent to the entire mailing list.
How Bridge Works
Messages are received by sending these messages to the List Email, which you will have to set up separately to this plugin.
The List Email can be either a regular POP3 email account, which Bridge will log into on a schedule (cronjob), or an Email Forward, which will forward the message directly to the Bridge.
User Guide
The below documentation goes into detail on how to install and configure Bridge. A user guide for Bridge is available in the Dada Mail Manual chapter, Using Bridge:
http://dadamailproject.com/pro_dada/using_bridge.html
For more information on Pro Dada/Dada Mail Manual:
http://dadamailproject.com/purchase/pro.html
Obtaining The Plugin
Bridge is located in the, dada/plugins directory of the Dada Mail distribution, under the name: bridge
Installation
Bridge can be installed using the included installer that comes with Dada Mail. In the Installer look under, Plugins/Extensions and check Bridge.
Mailing List Configuration
Once you've installed Bridge, you may access it via the List Control Panel. Bridge can be accessed via the left hand menu under, Plugins - Discussion Lists
Before you can start using Bridge for your mailing list, there's two things that you will need to do for each mailing list you would like to use Bridge for:
Enable Bridge
Create and Configure the List Email
Enable Bridge
In Bridge's control panel, under, General, uncheck the option: Disable sending using this method. Save your changes.
Create and Configure the List Email
The List Email is the address that you will be sending your email messages to for them to be broadcasted to your entire mailing list.
There's a few constraints you want to keep in mind when creating the List Email. Most likely, the address is going to be on the same domain that you install Dada Mail and it's going to be an address that you're not already using; either somewhere else in Dada Mail, or as another general email address.
The List Email can either be a normal POP3 Email Account, or a Mail Forward.
A POP3 account is fairly easy to set up and Bridge basically acts as a mail reader: Bridge will log in via POP3, check any messages that may be available, process them, then delete them when they've been read.
A Mail Forward may be slightly trickier to set up, but messages will br processed much quicker, as it's not waiting for the schedule to run, as you do, with a POP3 setup.
Before attempting, make sure that you can set up a mail forward that can Pipe to a Program, and not simply forward to another email address.
Setup As: POP3 Account
Toggle the radio buttons labeled, Setup As to, POP3 Account.
Create a new POP3 Account. This email account will be the email address you will send messages to. Additional fields should be shown, where you may plug in the POP3 Login information for this email address ( POP3 Server, POP3 Username, POP3 Password, etc.). You may test that the login credentials are working by clicking the button labeled, Test POP3 Login Information....
Once the login information works with Bridge, Save your changes.
Setup As: Mail Forward
Toggle the radio buttons labeled, Setup As to, Email Forward. An example of the command you'll need to work with Bridge will be shown.
Create a new Mail Forward, and use the example shown as a starting point for the piped command. Here's an example,
|/home/youraccount/public_html/cgi-bin/dada/mail.cgi --inject --list yourlist
If you're setting the command in cPanel (or something similar) and it asks you to, "enter a path relative to your home directory", you may need to simply remove the Pipe Character (|) and the path to your home directory /home/youraccount, and plugging in this instead:
public_html/cgi-bin/dada/mail.cgi --inject --list yourlist
Cronjob
Bridge runs in the background on a schedule. Make sure to set Dada Mail's cronjob:
http://dadamailproject.com/d/features-scheduled_cronjobs.pod.html
DMARC Policies and Bridge
Bridge has a very important option labeled, Send messages, "On Behalf Of" (p.p. mode) . If you are running a discussion list, you will want this option checked, to make sure mail delivery works.
This feature was introduced in v7.3.0 of Dada Mail and has been refined since. If you're running a version of Dada Mail below v7.3.0 and are running a discussion list, it's important to upgrade to make sure your discussion list is running correctly.
Testing Bridge
Once you've enabled Bridge, and have set up the List Email, it's time to test the plugin. Simply send a message to your List Email. To make things easier, make sure to send the message from the List Owner's email address, which is allowed to send to both announce-only and discussion type mailing lists. If a message is sent out to your entire mailing list, congratulations: Bridge is working.
Additional Mailing List Configuration
In Bridge's List Control Panel and below, List Email Configuration section, there are additional settings you may customize, depending on how you'd like your mailing list to function.
Advanced Topics
Plugin Configuration Settings
The below settings are available to you, if you wish to further configure Bridge. These settings can be configured inside your .dada_config
file.
First, search and see if the following lines are present in your .dada_config
file:
# start cut for plugin configs
=cut
=cut
# end cut for plugin configs
If they are present, remove them.
You can then configure the plugin variables on these lines:
Bridge => {
Plugin_Name => undef,
MessagesAtOnce => undef,
Allow_Open_Discussion_List => undef,
Room_For_One_More_Check => undef,
Enable_POP3_File_Locking => undef,
Check_List_Owner_Return_Path_Header => undef,
Check_Multiple_Return_Path_Headers => undef,
},
Plugin_Name
The name of the plugin. By default, Bridge.
MessagesAtOnce
You can specify how many messages you want to have the program actually handle per execution of the script by changing the, MessagesAtOnce
variable. By default, it's set conservatively to, 1
.
Allow_Open_Discussion_List
If set to, 1
a new option will be available in Bridge's list control panel to allow you to have a discussion list that anyone can send messages to.
Room_For_One_More_Check
Room_For_One_More_Check
looks to see how many mass mailings are currently in the mass mailing queue. If its at or above the limit set in $MAILOUT_AT_ONCE_LIMIT
, Bridge will not attempt to look for and (possibly) create another mass mailing to join the queue.
Enable_POP3_File_Locking
When set to, 1
, Bridge will use a simple lockfile scheme to make sure that it does not check the same POP3 account at the same time another copy of the plugin is doing the exact same thing, saving you from potentially sending out multiple copies of the same message.
Sometimes, the simple POPp3 lock in Dada Mail gets stale, and a deadlock happens. Setting this configuration to, 0
disables lockfiles. Stale locks will be deleted by the app after a day of being stale.
Check_List_Owner_Return_Path_Header
When testing the validity of a received message, Dada Mail will look to see if the, Return-Path
header matches what's set in the, From
header. If they do not match, this test fails and the message will be rejected. Setting, Check_List_Owner_Return_Path_Header
to, 0
will disable this test.
Check_Multiple_Return_Path_Headers
Check_Multiple_Return_Path_Headers
is another validity test for received messages. This time, the message is looked to see if it has more than one Return-Path
header. If it does, it is rejected. If you set, Check_Multiple_Return_Path_Headers
to, 0
, this test will be disabled.
Debugging
Debugging your POP3 account information
The easiest way to debug your POP3 account info is to actually test it out.
Try logging into your List Email, via the command line:
prompt:]telnet pop3.example.com 110
Trying 12.123.123.123...
Connected to pop3.example.com.
Escape character is '^]'.
+OK <37892.1178250885@hedwig.summersault.com>
user user%example.com
+OK
pass sneaky
+OK
list
In the above example, pop3.example.com is your POP3 server. You'll be typing in:
user user%example.com
and:
pass sneaky
(changing them to their real values) when prompted. This is basically what bridge.cgi does itself.
If you don't have command line access, try adding an account in a desktop mail reader. If these credentials work there, they'll most likely work for Bridge.
If your account information is correct and also logs in when you test the pop3 login information through bridge.cgi yourself, check to see if there isn't an email filter attached the account that looks at messages before they're delivered to the POP3 Mailbox and outright deletes messages because it triggered a flag.
This could be the cause of mysterious occurences of messages never reaching the POP3 Mailbox.
COPYRIGHT
Copyright (c) 1999 - 2015 Justin Simoni All rights reserved.
LICENSE
This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.