wiki:Email2tracConfiguration

Version 31 (modified by bas, 14 years ago) (diff)

--

Configuration

After installation, edit email2trac.conf;; for your site. Most important parameter is project. below is a table which options there are with a short description and the default value:

NAME VALUE Description
[DEFAULT] REQUIRED
project: /data/trac/jouvin REQUIRED
debug: 1 OPTIONAL, if set print some DEBUG info
spam_level: 4 OPTIONAL, if set check for SPAM mail
drop_spam: 0 OPTIONAL:, if set then reject mail marked as SPAM
reply_all: 1 OPTIONAL, if set then put all CC-addresses in ticket CC-field
umask: 022 OPTIONAL, Use this umask for saving attachments
mailto_link: 1 OPTIONAL, if set then [mailto:reporter] in description
mailto_cc: ticket@… OPTIONAL, Use ths address as CC in mailto line
ticket_update: 1 OPTIONAL, if set then check if this is an update for a ticket
email_header: 1 OPTIONAL, if set then show TO/CC fields in description
trac_version: 0.9 OPTIONAL. if set then use this as version number, default 0.10
alternate_notify_template a_ticket.css OPTIONAL if set then use this style sheet for notify
enable_syslog 1 OPTIONAL, if set log errors to syslog, note they are not mailed back to the reporter
verbatim_format 1 OPTIONAL, default: 1, if unset then do not use format: {{{ mail body text }}]
strip_signature 1 OPTIONAL, It will try to remove the user signature from the mail, default: 0
use_textwrap 70 OPTIONAL, It will wrap line longer then 70 chars. default: 0/off
python_egg_cache OPTIONAL, When set use this setting as environment variable, some installations depend on it.
tmpdir /tmp OPTIONAL, if set use this as temporary directory, default: /tmp
[bas] OPTIONAL project declaration, also set project and use --project option
project: /data/trac/bas
spam_level: 2 Override DEFAULT spam_level, can also be done for other options

Spam

There are two configuration options to handle spam. Both options depend on the X-Spam-Score line in the message header. This line is set by a spam detecting program like SpamAssassin. It count the * in the X-Spam-Score line, eg:

spam_level: 4
drop_spam: 1   

This setup drops all email with Spam-score greater the 4. With this setting the email below is rejected:

From lijuydru@example.com Tue Dec  5 12:47:04 2006
To: test@example.com
Subject: Test
MIME-Version: 1.0
Content-Type: text/plain;
List-Id: 8
X-Scanned-By: MIMEDefang 2.56 on 145.100.16.144
X-Scanned-By: MIMEDefang 2.51 on 145.100.16.26
X-Scanned-By: MIMEDefang 2.56 on 145.100.16.144
X-Spam-Score: ***************************** (29.334) BAYES_99,
        HELO_DYNAMIC_DHCP,HELO_DYNAMIC_IPADDR,MSGID_FROM_MTA_ID,
        RCVD_IN_BL_SPAMCOP_NET,RCVD_IN_SORBS_DUL,RCVD_IN_XBL,
        SUBJ_ILLEGAL_CHARS, URIBL_JP_SURBL, URIBL_SBL, URIBL_SC_SURBL,
        WEIRD_PORT, autolearn=spam

Ticket Update

If you have enabled ticket_update in email2trac.conf then you have one of the two options explained below. Email2trac will scan the subject field to determine if this is a ticket update. It will parse the subject field to see if we must update the ticket and update some ticket fields, eg:

  • This will update ticket number 1529:
    Subject: [hic] #1529: Re: LRZ
    
  • This will update ticket 1529 and will set owner to bas and priority to medium
    Subject: [hic] #1529?owner=bas,priority=medium: Re: LRZ
    

Email address

This is the preferred method. This will setup an email address where the ticket information will be sent to. This is a different email address then the ticket email address. When you reply on this email a copy will be sent to the ticket email address. Here is an example setup:

      (ticket address: ticket@test.nl)
      [notification]
      smtp_enabled = true
      smtp_always_cc = test@test.nl
      smtp_server = localhost
      smtp_from =  ticket@test.nl
      always_notify_reporter = true

smtp_always_cc is the adress where the ticket information is sent to and smtp_from is the ticket email address. So if somebody replies a copy is sent to this address

html code

Use the mailto_cc and mailto_link in email2trac.conf. This will add a html mailto link in the description field. If you click on this link it will open the default mail program which will send an email to the reporter and Carbon COpy to the ticket address.

Formatting options

There are several options that control the behaviour of the format of a ticket. Below there is a brief explanation of the options:

verbatim_format::

Default this option is enabled. When mail is inserted in the trac ticket system the plain text is between {{{ ''body_text'' }}}. Then trac does not process the body_text. You can disable this option in email2trac.conf:

verbatim_format : 0

strip_signature::

When enabled it will try to strip the signatures from the email. It scans the message for a -- line. All lines after this line will be skipped.

strip_signature : 1

use_textwrap::

When enabled it will break lines greater then the the number specified, eg:

use_textwrap : 40 

input:

This is an example of a line that has more then 40 characters

output:

This is an example of a line that has
more then 40 characters