Download Report

Instructions for configuring Piping
for oemPro Bounce Tracking Module
oemPro comes with a very flexible bounce tracking module which can be processed in two ways:
Piping
POP3/IMAP
In this manual, Piping method configuration is described.
Piping
Piping is a push method within your MTA (Mail Transfer Agent) which directly transfers the incoming
email to a script. In this manual, piping installation for Qmail, Sendmail, Exim and Postfix is described.
Piping method is more stable than POP3/IMAP method because received email is directly dispatched
to defined script.
We strongly recommend all Unix based server owners to prefer this method instead of POP3/IMAP.
Requirements
To setup piping for oemPro bounce handling, you will need following access types to your server:
SSH access (root level) or access to your cPanel (if available)
step
1
oemPro Configuration
The first step is to change permission of bounce handling CLI (Command Line Interface) module:
In the above screenshot, we assumed that your oemPro is installed under
/virtualhosts/collaboration/oemprov3620/. Please change this to your oemPro path.
The above command sets cli_bounce.php as executable lets it to be executed through the shell.
step
2
Learn Your PHP Path
In order to run PHP scripts through shell, you need to enter the path of PHP CLI (Command Line
Interface) to the top of PHP scripts. In this step, we will learn where your PHP CLI is installed.
This image shows that php is installed under /usr/bin/php
us
directory. The first line of cli_bounce.php
must match this path:
step
3
Setup
p Pipi
Piping on Y
Your MTA
In this manual,
anual, w
we will
ill describ
describe
ibe how to setup piping
pipin for the following
owing MTAs:
Qmail
Sendmail
endmail
Exim
xim
Postfix
Addition to this, we will also describe how to setup piping for the following
ng envi
environments:
Plesk
CPanel
Qmail Piping Setup
In Qmail, you need to define piping in alias file which is usually found at:
/usr/local/qmail/mailnames/yourdomain.com/bounce/.qmail
The above alias file is for [email protected] email address.
Edit this file (see below) and enter the full path to cli_bounce.php file with a prefix of “|” (Pipe) character.
That’s all. Your alias file is set and now oemPro will immediately receive all emails arriving to
[email protected]
Sendmail Piping
ng Setup
Aliases of Sendmail is located
ocated in /etc/aliases file
file.
e.
We assume
are
piping
me that you ar
re going to create a pipin
ng for [email protected].
[email protected]
Edit /etc/aliases
and
file,
insert
aliases file an
d to thee bottom of this fi
le, inser
rt the following line:
bounce: ”|/virtualhosts/collaboration/oemprov3620/cli_bounce.php”
|/virtual
s/collabo
oration/oemprov3
3620/clii_bounce.php”
See below:
w:
Important
nt There mayy be some
me other lines in this
his file.
file Do NOT change
ange anything in this ffile other than
your new line.
Some Sendmail
dmail sy
systems are configured with SMRSH (Sendmail Restricted
tricted Shell) to preve
prevent third party
script execution.
message,
you will need to
cution. IIf you receive bounce messages
essages with SMRSH failure message
ssage, then yo
configure your Sendmail in the following way:
1. Learn your SMRSH path:
2. Cre
Create a symlink for cli_bounce.php
3. Update alias file
Now, you have configured your Sendmail with SMRSH.
As a final step, you will need to load your new aliases:
Exim Piping Setup
Aliases of Exim MTA is located in the following file:
/etc/valiases/yourdomain.com
Edit this file and add the following line to your alias file:
Bounce: “|/virtualhosts/collaboration/oemprov3620/cli_bounce.php”
362
As a final step, you will need to load your new aliases:
Postfix
x Piping
g Setup
Setu
up
Aliases of Postfix MTA iiss locate
located
d in the following
g file:
/etc/postfix/aliases
fix/aliase
Edit this file
following
file::
le and aadd the
he follow
wing line to your alias
a
file
|/virtual
s/collabo
oration/oemprov3620/cli_bounce.
ounce.php”
Bounce: “|/virtualhosts/collaboration/oemprov3620/cli_bounce.php”
As a final step, yo
you willll need to load
d your new aliases:
a
PLESK
K Pi
Piping
i
If you have a PLESK control panel provided by SWSoft on your server, you need to follow these steps
in order to setup piping:
1. Change CHMOD of httpdocs directory of your domain:
2. Edit /var/qmail/mailnames/yourdomain.com/.qmail-bounce file and set the content to:
”|/var/www/vhosts/yourdomain.com/httpdocs/oempro/cli_bounce.php”
That’s all for PLESK.
cPanel Piping
If you have a cPanel control panel on your server, please follow these steps in order to setup piping:
1. Login to your cPanel, click “Aliases and Forwarding” link
2. Click “Add Forwarder” link
3. Type “bounce” and select your domain. Then write the following command next to this
email address: |/path/to/oemPro/cli_bounce.php
4. Click “Add a new Forwarder” button..
Things You Shouldn’t Forget
. You shouldn’t have a POP3 mailbox corresponding
orresponding to alia
alias you have set.
. If you are configuring
nfiguring th
through PLESK, be sure that you have se
set chmod of httpdocs directory
to 755
Having Problems
ems with Pipin
Piping
ng Se
Setup?
tup?
If you aree having prob
problems
blems se
setting
etting up piping on
o your mail server or if your server
ser
path
paths are different
than described
cribed in this manual
manual,l, please contact your
y
ho
hosting
sting provider to get a h
help
elp for p
piping setup.