From ba7a7b144d192c9e7a178ff0cc7eceddaa06a214 Mon Sep 17 00:00:00 2001 From: "terry%mozilla.org" Date: Tue, 7 Mar 2000 17:36:48 +0000 Subject: [PATCH] Submission by Klaas Freitag . --- webtools/bugzilla/contrib/README | 8 + webtools/bugzilla/contrib/README.Mailif | 68 ++++++ webtools/bugzilla/contrib/bugmail_help.html | 223 ++++++++++++++++++++ 3 files changed, 299 insertions(+) create mode 100644 webtools/bugzilla/contrib/README.Mailif create mode 100644 webtools/bugzilla/contrib/bugmail_help.html diff --git a/webtools/bugzilla/contrib/README b/webtools/bugzilla/contrib/README index 89ad2c58d01..32ec834a9e5 100644 --- a/webtools/bugzilla/contrib/README +++ b/webtools/bugzilla/contrib/README @@ -8,3 +8,11 @@ This directory includes: gnats2bz.pl -- a perl script to help import bugs from a GNATS database into a Bugzilla database. Contributed by Tom Schutter + + bug_email.pl -- a perl script that can receive email containing + bug reports (email-interface). Contributed by + Klaas Freitag + + README.Mailif -- Readme describing the mail interface. + bugmail_help.html -- User help page for the mail interface. + diff --git a/webtools/bugzilla/contrib/README.Mailif b/webtools/bugzilla/contrib/README.Mailif new file mode 100644 index 00000000000..c058b0e16d5 --- /dev/null +++ b/webtools/bugzilla/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\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 \ No newline at end of file diff --git a/webtools/bugzilla/contrib/bugmail_help.html b/webtools/bugzilla/contrib/bugmail_help.html new file mode 100644 index 00000000000..00b0f515373 --- /dev/null +++ b/webtools/bugzilla/contrib/bugmail_help.html @@ -0,0 +1,223 @@ + + + + + Bugzilla Mail Interface + +

The Bugzilla Mail Interface

+Contributor: Klaas Freitag, SuSE GmbH +
+

+The bugzilla Mail interface allows the registered bugzilla users to submit bugs by +sending email with a bug description. This is usefull for people, who do not work +inhouse and want to submitt bugs to the bugzilla system. +

+ + +I know, show me the example-mail ! + + +

What do you need to do to submitt a bug by mail ?

+You need to send a email in the described format to the bugmail-user of the +bugzilla-system. This is yourbugzilla@here.com + +You receive a reply mail with the new bug-ID if your request was ok. +If not, you get a mail with +some help on the bugmail system and a specific analysis of your request. +

+Please dont refuse to send one or two wrong mails, you will get all the information +you need in the replies, and only in the mail replies. The information on this +page, concerning available products, versions and so on, is not dynamicly generated and +may be old therefore. + +

The Mail Format

+The bugmail needs a special format , which consists of some keywords and suitable +values for them and a description text. Note that the keyword block needs to be +above of the description text. + +

Keywords

+You need to tell bugzilla some properties of the bugs. This is done by keywords, which +start on a new line with a @, followed by the keyword and and equal-sign, followed by a +hopefully valid value. + + ++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
KeywordValue descriptionrequired and default value
@productThe product which has a bugyes.
This is the most important information. Many other + fields depend on the product.
@componentthe desired component which is affected by the bugyes.
As the @product, this is a very important + field.
@versionThe version of the productyes.
See @product and @component
@short_descA summary of your bug reportyes.
This summary of the error you want to report + describes what happen. You may skip the long description, + but not this summary.
+ Note:The short description may be given in the mail subject + instead of using the keyword !
@rep_platformThe desired platformno.
If you dont give a value, this field is set to All.
@bug_severityThe severity of the bugno.
If you dont give a value, this field is set to + normal
@priorityThe priority of the bugno.
If you dont give a value, this field is set to P3
@op_sysThe operating systemno.
If you dont give a value, this field is set to Linux.
@assigned_toThe one to whom the bug is assigned tono.
There is an initial owner for every product/version/component. + He owns the bug by default. The initial owner can only be found if + product, version and component are valid.
@bug_file_loc?no.
@status_whiteboard?no.
@target_milestone?no.
@groupsetrules the visibility of the bug.no.
This value defaults to the smallest of the available groups, + which is readInternal.
@qa_contactthe quality manager for the productno.
This value can be retrieved from product, component and + version
+

Valid values

+Give string values for the most keys above. Some keywords require special values:
+
    +
  1. E-Mail adresses: If you want to set the qa-contact, specify a email-adress for @qa_contact. The email must be known by bugzilla of course.
    2. +
  2. Listvalues: Most of the values have to be one of a list of valid values. Try by sending +a mail and read the reply. Skip fields if you dont get help for them unless you dont know +which values you may choose.
    3. +
  3. free Text: The descriptions may be free text.
    4. +
  4. Special: The field groupset may be specified in different in three different kinds: +
      +
    1. A plain numeric way, which is one usually huge number, e. g. 65536
      2. +
    2. a string with added numbers e.g. 65536+131072
      3. +
    3. a string list, e.g. ReadInternal, ReadBeta
      4. +
    +
    5. +
+ +

+ +But most of them need valid values. +

+Sorry, you will not find lists of valid products, components and the other stuff +here. Send a mail to with any text, and you will get a list of valid keywords in the reply. + +

+Some of the values must be choosen from a list:
+

    +
  1. bug_severity: blocker, critical, major, normal, minor, trivial, enhancement
    2. +
  2. op_sys: Linux
    3. +
  3. priority: P1, P2, P3, P4, P5
    4. +
  4. rep_platform: All, i386, AXP, i686, Other
+ + +

+ +After you have specified the required keywords and maybe some other value, you may +describe your bug. You dont need a keyword for starting your bug description. All +text which follows the keyword block is handled as long description of the bug. +

+ +The bugmail interface is able to find required information by itself. E.g. if you specify +a product which has exactly one component, this component will be found by the interface +automatically. + +

Attachments

+ +The mail interface is able to cope with MIME-attachments. +People could for example add a logfile as a mail attachment, and it will appear in +bugzilla as attachment. A comment for the attachment should be added, it will describe +the attachment in bugzilla. + +

Example Mail

+ +See the example of the mail body (Dont forget to specify the short description +in the mail subject):
+
+  @product      = Bugzilla
+  @component    = general
+  @version      = All
+  @groupset     = ReadWorld ReadPartners
+  @op_sys       = Linux
+  @priority     = P3
+  @rep_platform = i386
+
+
+  This is the description of the bug I found. It is not neccessary to start
+  it with a keyword. 
+
+  Note: The short_description is neccessary and may be given with the keyword
+  @short_description or will be retrieved from the mail subject.
+
+
+
+ + +