Changes between Version 33 and Version 34 of Email2tracConfiguration


Ignore:
Timestamp:
10/04/07 13:30:33 (17 years ago)
Author:
kiniry@…
Comment:

cleanup for clarity, grammar, typos, and more (more edits to follow as I install and configure at my site)

Legend:

Unmodified
Added
Removed
Modified

  • Email2tracConfiguration

    v33 v34  
    44= Configuration =
    55
    6 After installation, edit ''email2trac.conf;; for your site. Most important
    7 parameter is ''project''. below is a table which options there are with a short description and the default value:
    8 || NAME || VALUE || Description ||
    9 || [DEFAULT]  || ||  REQUIRED ||
    10 || project:  || /data/trac/jouvin || REQUIRED ||
    11 || debug: || 1                 ||  OPTIONAL, if set print some DEBUG info ||
    12 || spam_level: || 4          || OPTIONAL, if set check for SPAM mail ||
    13 || drop_spam: || 0           || OPTIONAL:, if set then reject mail marked as SPAM ||
    14 || reply_all: || 1 || OPTIONAL, if set then put all CC-addresses in ticket CC-field ||
    15 || umask: || 022             || OPTIONAL, Use this umask for saving attachments ||
    16 || mailto_link: || 1          || OPTIONAL, if set then {{{[mailto:reporter]}}} in description ||
    17 || mailto_cc: || ticket@test.nl ||  OPTIONAL, Use ths address as CC in mailto line ||
    18 || ticket_update: || 1    || OPTIONAL, if set then check if this is an update for a ticket ||
    19 || email_header: || 1       || OPTIONAL, if set then show TO/CC fields in description||
    20 || trac_version: || 0.9     || OPTIONAL. if set then use this as version number, default 0.10
    21 || alternate_notify_template || a_ticket.css || OPTIONAL if set then use this style sheet for notify ||
    22 || enable_syslog || 1    ||  OPTIONAL, if set log errors to syslog, note they are ''not'' mailed back to the reporter ||
    23 || verbatim_format || 1 || OPTIONAL, default: 1, if unset then do not use format: ''{{{'' mail body text ''}}]'' ||
    24 || strip_signature || 1 || OPTIONAL, It will try to remove the user signature from the mail, default: 0 ||
    25 || use_textwrap    || 70 || OPTIONAL, It will wrap line longer then 70 chars. default: 0/off ||
    26 || python_egg_cache ||   || OPTIONAL, When set use this setting as environment variable, some installations depend on it.||
    27 || tmpdir || /tmp || OPTIONAL, if set use this as temporary directory, default: ''/tmp'' ||
     6After installation, edit [wiki:Email2tracConfiguration email2trac.conf]
     7for your site.  The
     8most important parameter is ''project''.  Below is a table
     9of options with short descriptions and their default value:
     10|| NAME             || DEFAULT VALUE  || Description ||
     11|| [DEFAULT]        ||                ||  REQUIRED ||
     12|| project:         || `/data/trac/jouvin` || REQUIRED ||
     13|| debug:           || 0              ||  OPTIONAL, if set print some DEBUG info ||
     14|| spam_level:      || 0              || OPTIONAL, if set check for SPAM mail ||
     15|| drop_spam:       || 0              || OPTIONAL:, if set then reject mail marked as SPAM ||
     16|| reply_all:       || 0              || OPTIONAL, if set then put all CC-addresses in ticket CC-field ||
     17|| umask:           || process's umask  || OPTIONAL, if set use this umask for saving attachments.  E.g., `022`. ||
     18|| mailto_link:     || 0              || OPTIONAL, if set then {{{[mailto:reporter]}}} in description ||
     19|| mailto_cc:       ||                || OPTIONAL, use this address as CC in mailto line.  E.g., `ticket@test.nl` ||
     20|| ticket_update:   || 0              || OPTIONAL, if set then check if this is an update for a ticket (see below) ||
     21|| email_header:    || 0              || OPTIONAL, if set then show TO/CC fields in description ||
     22|| trac_version:    || 0.10           || OPTIONAL, if set then use this as version number ||
     23|| alternate_notify_template          || None || OPTIONAL if set then use this style sheet for notify.  E.g., `a_ticket.css` ||
     24|| enable_syslog    || 0              ||  OPTIONAL, if set log errors to syslog, note they are ''not'' mailed back to the reporter ||
     25|| verbatim_format  || 1              || OPTIONAL, default: 1, if unset then do not use format: ''{{{'' mail body text ''}}]'' ||
     26|| strip_signature  || 0              || OPTIONAL, if set try to remove the user signature from the mail, default: 0 ||
     27|| use_textwrap     || 0              || OPTIONAL, if set wrap text lines longer then the indicated number of characters.  A value of 0 disables wrapping. ||
     28|| python_egg_cache || `$PYTHON_EGG_CACHE` || OPTIONAL, if set use this setting as environment variable; some installations depend on this. ||
     29|| tmpdir           || `/tmp`         || OPTIONAL, if set use this as temporary directory, default: ''/tmp'' ||
     30|| emacs_comment    || >              || OPTIONAL, prefix used to comment original text of ticket when using mailto_link ||
    2831
    2932
    30 || || ||
    31 || || ||
    32 || [bas] ||                               || OPTIONAL project declaration, also set project and use --project option  ||
    33 || project:||  /data/trac/bas  || ||
    34 || spam_level:|| 2                 || Override DEFAULT spam_level, can also be done for other options ||
     33|| FURTHER ENTRIES || EXAMPLE VALUE  || DESCRIPTION ||
     34||                 ||                ||            ||
     35|| [bas]           ||                || OPTIONAL next project declaration, also set project and use --project option  ||
     36|| project:        || `/data/trac/bas` || path to Trac project `bas` ||
     37|| spam_level:     || 2              || Override DEFAULT spam_level for project `bas`.  All above settings also can be set for project `bas`. ||
    3538
    3639
    3740== Spam ==
    3841
    39 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:
     42There are two configuration options to handle spam.  Both
     43options depend on the {{{X-Spam-Score}}} line in the message
     44header. This line is set by a spam detecting program like
     45''!SpamAssassin''. Email2trac counts the number of '''*'''
     46characters in the {{{X-Spam-Score}}} line.
     47
     48For example, with the configuration:
    4049{{{
    4150spam_level: 4
    4251drop_spam: 1   
    4352}}}
    44 This setup drops all email with ''Spam-score'' greater the 4. With this setting the email below is rejected:
     53Email2trac drops all email with ''Spam-score'' greater the 4. 
     54Given this setting, an email with the below header is rejected:
    4555{{{
    4656From lijuydru@example.com Tue Dec  5 12:47:04 2006
    … …  
    6373== Ticket Update ==
    6474
    65 If you have enabled ''ticket_update'' in email2trac.conf then you have to configure
    66 one of the two options explained below. Email2trac will scan the subject field to
    67 determine if this is a ticket update and if we have to update ticket fields, eg:
    68  * This will update ticket number 1529:
     75If you have enabled ''ticket_update'' in
     76[wiki:Email2tracConfiguration email2trac.conf] then you have to configure
     77one of the two options explained below.  Email2trac will scan the subject field of
     78all emails to determine if a given email is a ticket update, and consequently it
     79must update ticket fields.
     80
     81For example:
     82 * This subject line will trigger an update of ticket number 1529:
    6983{{{
    7084Subject: [hic] #1529: Re: LRZ
    7185}}}
    7286
    73  * This will update ticket 1529 and will set owner to bas and priority to medium
     87 * This subject line will trigger an update of ticket number
     881529 and will set its owner to ''bas'' and priority to ''medium'':
    7489{{{
    7590Subject: [hic] #1529?owner=bas,priority=medium: Re: LRZ
    … …  
    7893=== Email address ===
    7994
    80 This is the preferred method. This will setup an email address where the ticket
    81 information will be sent to. This is a different email address then the ticket email address.
    82 When you reply on this email a copy will be sent to the ticket email address. Here is an example
    83 setup:
     95This is the preferred method. This will setup an email address
     96where the ticket information will be sent to. This is a different
     97email address than the ticket email address.  When you reply on
     98this email a copy will be sent to the ticket email address.
     99
     100Here is an example setup:
    84101{{{
    85102      (ticket address: ticket@test.nl)
    … …  
    91108      always_notify_reporter = true
    92109}}}
    93 ''smtp_always_cc'' is the adress where the ticket information is sent to and ''smtp_from'' is the ticket
    94 email address. So if somebody replies a copy is sent to this address
     110''smtp_always_cc'' is the address where the ticket information is
     111sent to and ''smtp_from'' is the ticket email address. So if
     112somebody replies a copy of the ticket is sent to this address.
    95113
    96114
    97115=== html code ===
    98116 
    99 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.
     117Use the ''mailto_cc'' and ''mailto_link'' in
     118[wiki:Email2tracConfiguration email2trac.conf].
     119This will add a ''html mailto link'' in the description field.
     120If you click on this link it will open the default mail program
     121which will send an email to the reporter and Carbon Copy to
     122the ticket address.
    100123
    101124== Formatting options ==
    102125
    103 There are several options that control the behaviour of the format of a ticket. Below there is a brief explanation of the options:
     126There are several options that control the behaviour of the
     127format of a ticket. Below there is a brief explanation of the options:
    104128
    105129verbatim_format::
    106  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 [wiki:Email2tracConfiguration email2trac.conf]:
     130 By default, this option is enabled. When mail is inserted in the
     131trac ticket system the message's body is inserted as plain text
     132in between !{{{ ''body_text'' }}}. Thus, Trac does not process
     133the body text. You can disable this option in
     134[wiki:Email2tracConfiguration email2trac.conf]:
    107135{{{
    108136verbatim_format : 0
    … …  
    110138
    111139strip_signature::
    112  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.
     140 When enabled it will try to strip the signatures from the email.
     141It scans the message for a line containing the string `--`.  All lines after this
     142line will be skipped.
    113143{{{
    114144strip_signature : 1
    … …  
    116146
    117147use_textwrap::
    118   When enabled it will break lines greater then the the number specified, eg:
     148 When enabled it will break lines greater then the the number specified.
     149For example:
    119150{{{
    120151use_textwrap : 40