|
Table of Contents IntroductionCiviMail installation consists of four parts: enabling the CiviMail component, setting up the SMTP configuration options, defining a cron job that will actually send the scheduled mailing, and choosing and setting up the return email channel. If you want to have a system that works properly, we strongly suggest you to read this chapter, and to apply the various steps. Unless you are a super sysadmin, don't try to save time an skip some. If you have problems with your installation, if you have high bounce rates, if you have been blacklisted, if something doesn't work, read it again, and check that your install is properly done. http://en.flossmanuals.net/CiviCRM/SystemConfiguration Setting Up CiviMailIf the CiviMail component is not enabled, go to CiviCRM, then Administer → Configure → Global Settings → Enable Components and add the CiviMail component to the enabled components. Go to CiviCRM, then Administer → Configure → Domain Information and edit the values to your liking. Go to CiviCRM → Contacts → Manage Groups and click the "settings" link for the group you want to make available to CiviMail. Check the box that says "Mailing List". Save your settings and repeat for each additional group you would like to send mailings. If you do not complete this step, you will not see any groups when you try to send a mailing. Setting Up the SMTP ConfigurationGo to CiviCRM, then Administer → Configure → Global Settings → Outbound Email and provide proper values. Setting Up the Cron JobTo have your mailing actually send, set up a cron job that will periodically poke CiviMail to send all of the mailings that are past their scheduled date. This requires setting up a secure key for the site, and configuring a Drupal or Joomla user account which has permissions to access CiviCRM and CiviMail. See http://wiki.civicrm.org/confluence/display/CRMDOC/Command-line+Script+Configuration for more details. The script to process CiviMail messages is civimail.cronjob.php in CiviCRM's bin directory. You can run this script using either "GET" or "POST" methods. However, using "POST" with the authentication values stored in a file on your server is generally considered to be better security practice. When using the POST method, the username, password and site-key values are written to a text file, and then that filename is specified when running the script. The user and password values must be the user name and password of a Drupal/Joomla user that has permissions to access CiviCRM and CiviMail and the groups used for mailings (via "view all contacts" permission or ACLs). 1) Create a file named civicrm-wgetrc that contains this line (replacing username, password and site-key with the actual values). 2) You can then run the script using these commands Joomla installs 3. Now setup the cron job (this example runs the script every 5 minutes) and then enter the following line: where yourLinuxUserName is replaced by your Linux user name with privileges to execute wget, and with wget in your path. The equivalent cron job to set up for a Joomla installation is:
Setting Up the Return ChannelDo You Need the Return Channel?If you send emails and don't manage the bounce, you will be flagged as a spammer at one point or another. If you don't want that, you do want a return channel. The return channel is required at least in two cases. First, the return channel is required to track bounces and have the bouncing emails put on hold, as well as to track replies; if you don't need this functionality (you will still get the replies, you just won't be able to have stats about them), you don't need return channel handling. Second, the return channel is required if you want to handle SMTP (i.e., email-based) actions such as (un-, re-)subscribes and opt-outs - note that these actions have their HTTP (i.e., link-based) equivalents. Possible Solutions for the Return ChannelThere are four possible solutions for handling of the return channel. The current supported CiviCRM solution is CiviMail Processor, which polls the email account specified in Administer CiviCRM → Mail Accounts in defined intervals. If you absolutely need real-time return channel handling, there's our patched AMaViS solution. If you prefer a CiviMail-Processor-like solution in Perl for polling a given IMAP account, the community-supported imap2soap can handle the return channel for you. Finally, the easiest and most hands-free (albeit paid) solution is to setup an CiviSMTP account.
|
CiviMail Installation
Skip to end of metadata
Go to start of metadata
Labels:

2 Comments
Hide/Show CommentsMar 18, 2009
Alan Dixon
What are the implications in a multi-site setup? Can you mix and match return channel solutions? Or is it per-code base?
Mar 19, 2009
David Greenberg
Alan - I'm not sure if the folks who might be able to answer this are monitoring wiki comments. If you haven't already posted this on the CiviMail forum - would be good to do so.