Changes between Version 125 and Version 126 of Email2tracConfiguration


Ignore:
Timestamp:
02/18/11 22:50:16 (13 years ago)
Author:
anonymous
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Email2tracConfiguration

    v125 v126  
    44After installation, edit [wiki:Email2tracConfiguration email2trac.conf]  for your site.  The  most important parameter is ''project''.  Below is a table  of options with short descriptions and their default value:
    55
    6 ||NAME||DEFAULT VALUE||Description||version||
    7 ||[DEFAULT]||||REQUIRED||||
    8 ||project:||`/data/trac/jouvin`||REQUIRED||||
    9 ||alternate_notify_template||None||OPTIONAL if set then use this style sheet for notify.  E.g., `ticket_alternate`||||
    10 ||alternate_notify_template_update||None||OPTIONAL if set then use this style sheet for notify ticket updates.  E.g., `ticket_alternate_update`||||
    11 ||applesingle||warn||OPTIONAL, [#Attachmentsoptions Attachments options], default: warn||deprecated  in 1.1.0||
    12 ||appledouble||warn||OPTIONAL, [#Attachmentsoptions Attachments options], default: warn||deprecated in 1.1.0||
    13 ||binhex||warn||OPTIONAL, [#Attachmentsoptions Attachments options], default: warn||deprecated in 1.1.0||
    14 ||black_list||None||Drop mail if sender/domain matches. Can have multiple values separated by '',''.||||
    15 ||debug:||0||OPTIONAL, if set prints DEBUG info. depends on log_type where the output is saved||1.5.0||
    16 ||drop_spam:||0||OPTIONAL:  see [#Spam Spam configuration]||||
    17 ||drop_alternative_html_version:||0||OPTIONAL, if set then drop the HTML part of the message that is t he same as the plain text version||||
    18 ||email_header:||0||OPTIONAL, if set then show TO/CC fields in description||||
    19 ||email_quote||>||OPTIONAL, if strip_quote is set, then remove email starting with this quote char||||
    20 ||email_triggers_workflow||1||OPTIONAL,  If set to 0 it will prevent closed tickets to be reopened or trigger a [#Workflow workflow]||1.6.0||
    21 ||enable_syslog||0||OPTIONAL, if set log errors to syslog, note they are ''not'' mailed back to the reporter||deprecated in 1.5.0||
    22 ||html2text_cmd||None||OPTIONAL. If set will convert html mail to text, See for [#HTMLtotextconversion examples]||2.0.0||
    23 ||ignore_trac_user_settings||0||OPTIONAL, if set it will skip the email address to trac user login name mapping||||
    24 ||inline_properties||0||OPTIONAL, This is used to set ticket fields within an email, see [wiki:Email2tracParse#Updateticketfields body text parsing] ||1.2.0||
    25 ||inline_properties_first_wins||0||OPTIONAL,  Only process the first inline property when an email want to change the same ticket field, see [wiki:Email2tracParse#Updateticketfields body text parsing] ||2.0.0||
    26 ||log_file||email2trac.log||OPTIONAL, can be set to the same values as [wiki:TracLogging trac logging]||1.5.0||
    27 ||log_format||Emailtrac: %(message)s||OPTIONAL, can be set to the same values as [wiki:TracLogging trac logging]||1.5.0||
    28 ||log_level||INFO||OPTIONAL, can be set to the same values as [wiki:TracLogging trac logging]||1.5.0||
    29 ||log_type||syslog||OPTIONAL, can be set to the same values as [wiki:TracLogging trac logging]||1.5.0||
    30 ||mailto_cc||||OPTIONAL, use this address as CC in mailto line.  E.g., `ticket@test.nl`||||
    31 ||mailto_link||0||OPTIONAL, if set then `[mailto:reporter]` in description||||
    32 ||notify_reporter||0||OPTIONAL, if set then always mail the reporter||2.0.0||
    33 ||notify_reporter_black_list||None||Do not send mail if reporter matches. Can have muliple values separated by '',''||2.0.0||
    34 ||parentdir||<directory>||OPTIONAL, Is the root directory of all trac projects, see [#Parentdir parentdir]||2.0.0||
    35 ||python_egg_cache||`$PYTHON_EGG_CACHE`||OPTIONAL, if set use this setting as environment variable; some installations depend on this.||||
    36 ||recipient_list||||If set then only accept mail when the ''to-field'' is in this list, usually only used in a dropbox configuration||||
    37 ||reflow||1||OPTIONAL, if set then soft line breaks will be removed from {{[format:flowed]}} email when creating the ticket with verbatim_format turned off||||
    38 ||reply_all:||0||OPTIONAL, if set then put all CC-addresses in ticket CC-field||||
    39 ||spam_level:||0||OPTIONAL, see [#Spam Spam configuration]||||
    40 ||spam_header||X-Spam-Score||OPTIONAL, see [#Spam Spam configuration]||||
    41 ||strip_quotes||0||OPTIONAL, if set strip quotes from the email, useful when replying to tickets (see also email_quote), default: 0||||
    42 ||strip_signature||0||OPTIONAL, if set try to remove the user signature from the mail, default: 0||||
    43 ||subject_field_separator||&||OPTIONAL.  This is used to split the subject line, see [wiki:Email2tracParse#Subjectfield Subject field parsing]||1.1.0||
    44 ||ticket_permission_system||||OPTIONAL. Select which [#PermissionSystem Permission System] must be used ''trac'' or ''update_restricted_to_participants''||1.5.0||
    45 ||ticket_update:||0||OPTIONAL, if set then check if this is an update for a ticket (see below)||||
    46 ||ticket_update_by_subject||0||Optional, When there is no ticket number found in the reply mail. It will try to find a ticket that matches the subject line. Default time 30 days back from time received||1.4.0||
    47 ||ticket_update_by_subject_lookback||30||Optional, see ticket_update_by_subject for explanation||1.4.0||
    48 ||tmpdir||`/tmp`||OPTIONAL, if set use this as temporary directory, default: ''/tmp''||||
    49 ||trac_version:||0.10||OPTIONAL, if set then use this as version number||deprecated in 1.4.0||
    50 ||umask:||process's umask||OPTIONAL, if set use this umask for saving attachments.  E.g., `022`.||||
    51 ||use_textwrap||0||OPTIONAL, if set wrap text lines longer then the indicated number of characters.  A value of 0 disables wrapping.||||
    52 ||verbatim_format||1||OPTIONAL, default: 1, if unset then do not use format: ''{{{'' mail body text ''}}]''||||
    53 ||white_list||None||If set only accept mail when sender matches. Can have multiple values separated by '',''||||
    54 
    55 ||FURTHER ENTRIES||EXAMPLE VALUE||DESCRIPTION||
    56 ||||||||
    57 ||[bas]||||OPTIONAL next project declaration, also set project and use --project option||
    58 ||project:||`/data/trac/bas`||path to Trac project `bas`||
    59 ||spam_level:||2||Override DEFAULT spam_level for project `bas`.  All above settings also can be set for project `bas`.||
     6|| NAME || DEFAULT VALUE || Description || version ||
     7|| [DEFAULT] |||| REQUIRED ||
     8|| project: || `/data/trac/jouvin` || REQUIRED ||
     9|| alternate_notify_template || None || OPTIONAL if set then use this style sheet for notify.  E.g., `ticket_alternate` ||
     10|| alternate_notify_template_update || None || OPTIONAL if set then use this style sheet for notify ticket updates.  E.g., `ticket_alternate_update` ||
     11|| applesingle || warn || OPTIONAL, [#Attachmentsoptions Attachments options], default: warn || deprecated  in 1.1.0 ||
     12|| appledouble || warn || OPTIONAL, [#Attachmentsoptions Attachments options], default: warn || deprecated in 1.1.0 ||
     13|| binhex || warn || OPTIONAL, [#Attachmentsoptions Attachments options], default: warn || deprecated in 1.1.0 ||
     14|| black_list || None || Drop mail if sender/domain matches. Can have multiple values separated by '',''. ||
     15|| debug: || 0 || OPTIONAL, if set prints DEBUG info. depends on log_type where the output is saved || 1.5.0 ||
     16|| drop_spam: || 0 || OPTIONAL:  see [#Spam Spam configuration] ||
     17|| drop_alternative_html_version: || 0 || OPTIONAL, if set then drop the HTML part of the message that is t he same as the plain text version ||
     18|| email_header: || 0 || OPTIONAL, if set then show TO/CC fields in description ||
     19|| email_quote || > || OPTIONAL, if strip_quote is set, then remove email starting with this quote char ||
     20|| email_triggers_workflow || 1 || OPTIONAL,  If set to 0 it will prevent closed tickets to be reopened or trigger a [#Workflow workflow] || 1.6.0 ||
     21|| enable_syslog || 0 || OPTIONAL, if set log errors to syslog, note they are ''not'' mailed back to the reporter || deprecated in 1.5.0 ||
     22|| html2text_cmd || None || OPTIONAL. If set will convert html mail to text, See for [#HTMLtotextconversion examples] || 2.0.0 ||
     23|| ignore_trac_user_settings || 0 || OPTIONAL, if set it will skip the email address to trac user login name mapping ||
     24|| inline_properties || 0 ||OPTIONAL, This is used to set ticket fields within an email, see [wiki:Email2tracParse#Updateticketfields body text parsing] || 1.2.0 ||
     25|| inline_properties_first_wins || 0 ||OPTIONAL,  Only process the first inline property when an email want to change the same ticket field, see [wiki:Email2tracParse#Updateticketfields body text parsing] || 2.0.0 ||
     26|| log_file || email2trac.log || OPTIONAL, can be set to the same values as [wiki:TracLogging trac logging] || 1.5.0 ||
     27|| log_format || Emailtrac: %(message)s || OPTIONAL, can be set to the same values as [wiki:TracLogging trac logging] || 1.5.0 ||
     28|| log_level || INFO || OPTIONAL, can be set to the same values as [wiki:TracLogging trac logging] || 1.5.0 ||
     29|| log_type || syslog || OPTIONAL, can be set to the same values as [wiki:TracLogging trac logging] || 1.5.0 ||
     30|| mailto_cc |||| OPTIONAL, use this address as CC in mailto line.  E.g., `ticket@test.nl` ||
     31|| mailto_link || 0 || OPTIONAL, if set then `[mailto:reporter]` in description ||
     32|| notify_reporter || 0 || OPTIONAL, if set then always mail the reporter || 2.0.0 ||
     33|| notify_reporter_black_list || None || Do not send mail if reporter matches. Can have muliple values separated by '','' || 2.0.0 ||
     34|| parentdir || <directory> || OPTIONAL, Is the root directory of all trac projects, see [#Parentdir parentdir] || 2.0.0 ||
     35|| python_egg_cache || `$PYTHON_EGG_CACHE` || OPTIONAL, if set use this setting as environment variable; some installations depend on this. ||
     36|| recipient_list |||| If set then only accept mail when the ''to-field'' is in this list, usually only used in a dropbox configuration ||
     37|| reflow || 1 || OPTIONAL, if set then soft line breaks will be removed from {{[format:flowed]}} email when creating the ticket with verbatim_format turned off ||
     38|| reply_all: || 0 || OPTIONAL, if set then put all CC-addresses in ticket CC-field ||
     39|| spam_level: || 0 || OPTIONAL, see [#Spam Spam configuration] ||
     40|| spam_header || X-Spam-Score || OPTIONAL, see [#Spam Spam configuration] ||
     41|| strip_quotes || 0 || OPTIONAL, if set strip quotes from the email, useful when replying to tickets (see also email_quote), default: 0 ||
     42|| strip_signature || 0 || OPTIONAL, if set try to remove the user signature from the mail, default: 0 ||
     43|| subject_field_separator || & || OPTIONAL.  This is used to split the subject line, see [wiki:Email2tracParse#Subjectfield Subject field parsing] || 1.1.0 ||
     44|| ticket_permission_system |||| OPTIONAL. Select which [#PermissionSystem Permission System] must be used ''trac'' or ''update_restricted_to_participants'' || 1.5.0 ||
     45|| ticket_update: || 0 || OPTIONAL, if set then check if this is an update for a ticket (see below) ||
     46|| ticket_update_by_subject || 0 || Optional, When there is no ticket number found in the reply mail. It will try to find a ticket that matches the subject line. Default time 30 days back from time received || 1.4.0 ||
     47|| ticket_update_by_subject_lookback || 30 || Optional, see ticket_update_by_subject for explanation || 1.4.0 ||
     48|| tmpdir || `/tmp` || OPTIONAL, if set use this as temporary directory, default: ''/tmp'' ||
     49|| trac_version: || 0.10 || OPTIONAL, if set then use this as version number || deprecated in 1.4.0 ||
     50|| umask: || process's umask || OPTIONAL, if set use this umask for saving attachments.  E.g., `022`. ||
     51|| use_textwrap || 0 || OPTIONAL, if set wrap text lines longer then the indicated number of characters.  A value of 0 disables wrapping. ||
     52|| verbatim_format || 1 || OPTIONAL, default: 1, if unset then do not use format: ''{{{'' mail body text ''}}]'' ||
     53|| white_list || None || If set only accept mail when sender matches. Can have multiple values separated by '','' ||
     54
     55|| FURTHER ENTRIES || EXAMPLE VALUE || DESCRIPTION ||
     56|| [bas] |||| OPTIONAL next project declaration, also set project and use --project option ||
     57|| project: || `/data/trac/bas` || path to Trac project `bas` ||
     58|| spam_level: || 2 || Override DEFAULT spam_level for project `bas`.  All above settings also can be set for project `bas`. ||
    6059
    6160== Spam ==
     
    152151
    153152=== html code ===
    154   Use the ''mailto_cc'' and ''mailto_link'' in  [wiki:Email2tracConfiguration 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.
     153  Use the ''   mailto_cc''    and ''   mailto_link''    in  [wiki:Email2tracConfiguration 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.
    155154
    156155== Formatting options ==
     
    159158verbatim_format::
    160159
    161   By default, this option is enabled. When mail is inserted in the trac ticket system the message's body is inserted as plain text  in between !{{{ ''body_text'' }}}. Thus, Trac does not process  the body text. You can disable this option in  [wiki:Email2tracConfiguration email2trac.conf]:
     160  By default, this option is enabled. When mail is inserted in the trac ticket system the message's body is inserted as plain text  in between !{{{ ''body_text'' }}}   . Thus, Trac does not process  the body text. You can disable this option in  [wiki:Email2tracConfiguration email2trac.conf]   :
    162161{{{
    163162verbatim_format : 0
     
    166165strip_signature::
    167166
    168   When enabled it will try to strip the signatures from the email. It scans the message for a line containing the string `--`.  All lines after this  line will be skipped.
     167  When enabled it will try to strip the signatures from the email. It scans the message for a line containing the string `--`   .  All lines after this  line will be skipped.
    169168{{{
    170169strip_signature : 1
    171170}}}
     171
    172172use_textwrap::
    173173
     
    192192  * This is a very very very very very very very very very very very very very very very very very very very very very very very very very very very very very very very very long list item
    193193}}}
     194
    194195may get incorrectly rendered as
    195196
     
    242243
    243244== Permission System ==
    244 There are two options to choose from:
    245 
    246  1. trac: This will honor the permission set via ''trac-admin'' or the web-interface
    247  1. update_restricted_to_participants: This will only update a ticket if one the following conditions is met:
     245The ticket_permission_system option can be set to one of two options:
     246
     247 * '''trac''': This will honor the permission set via ''trac-admin'' or the web-interface
     248 * '''update_restricted_to_participants''': Anyone can create a ticket, but this option will only allow the updating of a ticket if one the following conditions is met:
    248249   * the updater is the ticket reporter
    249250   * the updater is listed in the CC field of a ticket
     
    280281
    281282== Parentdir ==
    282 
    283283This variable is set in the ''[DEFAULT]'' section of email2trac.conf, eg:
     284
    284285{{{
    285286[DEFAULT]
     
    292293project: /data/trac/pbs_python/project
    293294}}}
    294 
    295295In this example the parent directory is ''/data/trac/oss/projects''.  You can override the project directory per section, see ''section pbs-python''.  In the above example the project directory for ''section email2trac'' is ''/data/trac/oss/projects/email2trac''
    296296
    297297With this new feature you can use one script for aliases. Here is an example from ''sto add iti dot upvdot es''
     298
    298299{{{
    299300To avoid touching the postfix alias database I'm using addresses of the form trac+PROJECT@mail.domain
     
    311312exit 67 # Unknown user
    312313}}}
    313 
    314314== HTML to text conversion ==
    315 
    316315email2trac use an external program to convert HTML to ASCII/text. This conversion must output the result to ''stdout''. Here are some examples which programs can be used for the conversion:
     316
    317317 * html2text_cmd: /usr/bin/html2text -nobs
    318318 * html2text_cmd: /usr/bin/w3m -dump
    319319 * html2text_cmd: /usr/bin/lynx -dump
    320320 * html2text_cmd: /usr/bin/links -dump
    321 
    322