Submission by Klaas Freitag <freitag@suse.de>.

1 files changed, 68 insertions, 0 deletions

diff --git a/contrib/README.Mailif b/contrib/README.Mailif
new file mode 100644
index 000000000..c058b0e16
--- /dev/null
+++ b/contrib/README.Mailif
@@ -0,0 +1,68 @@
+
+The Bugzilla Mail interface
+===========================
+The Bugzilla Mail interface allows to submit bugs to Bugzilla by email.
+
+The Mail Interface Contribution consists of three files:
+README.Mailif - this readme.
+bug_email.pl  - the script
+bugmail_help.html - a user help html site
+
+Installation:
+
+Copy the files
+ bugmail_help.html
+ bug_email.pl
+to your bugzilla-directory, where all your bugzilla cgi-files reside.
+
+Next is to add a user who receives the bugmails, e. g. bugmail. Create a 
+mail account and a home directory for the user. 
+
+The mailinterface script bug_email.pl needs to get the mail through stdin.
+I use procmail for that, with the following line in the .procmailrc:
+
+BUGZILLA_HOME=/usr/local/httpd/htdocs/bugzilla
+:0 c
+|(cd $BUGZILLA_HOME/contrib; ./bug_email.pl)
+
+This defines the Bugzilla directory as the variable BUGZILLA_HOME and passes
+all incoming mail to the script after cd'ing into the bugzilla home.
+
+Customation:
+
+There are some values inside the script which need to be customized for your
+needs:
+
+1. In sub-routine Reply (search 'sub Reply':
+there is the line
+    print MAIL "From: Bugzilla Mailinterface<yourmail\@here.com>\n";
+                                            ^^^^^^^^^^^^^^^^^^^^
+Fill in your correct mail here. That will make it easy for people to reply
+to the mail.
+
+2. check, if your sendmail resides in /usr/sbin/sendmail, change the path if neccessary.
+Search the script after 'default' - you find some default-Settings for bug
+reports, which are used, if the sender did not send a field for it. The defaults
+should be checked and changed.
+
+Thats hopefully all, we will come up with any configuration file or something.
+
+
+If your mail works, your script will insert mails from now on.
+
+The mailinterface supports two commandline switches:
+
+There are two command line switches :
+
+-t: Testmode
+    The mailinterface does not really insert the bug into the database, but
+    writes some debug output to stdout and writes the mail into the file
+    bug_email_test.log in the data-dir.
+
+-r: restricted mode
+    All lines before the first line with a keyword character are skipped.
+    In not restricted, default mode, these lines are added to the long 
+    description of the bug.
+
+
+02/2000 - Klaas Freitag, SuSE GmbH <freitag@suse.de>
\ No newline at end of file