Changes between Version 24 and Version 25 of MailToTracPlugin


Ignore:
Timestamp:
Aug 2, 2017, 9:11:05 AM (6 years ago)
Author:
figaro
Comment:

Further cosmetic changes

Legend:

Unmodified
Added
Removed
Modified

  • MailToTracPlugin

    v24 v25  
    99 * an extension point that allows email messages to be handled by Trac plugins other than mail2trac.
    1010
    11 The bash script, `mail2tracAdmin` may be called by an [http://en.wikipedia.org/wiki/Mail_transfer_agent MTA], for example [http://www.postfix.org/ postfix].
     11The bash script, `mail2tracAdmin` may be called by an [wikipedia:Mail_transfer_agent MTA], for example [http://www.postfix.org/ postfix].
    1212
    1313It will open a Trac environment and run through each enabled [source:mailtotracplugin/0.12/plugin/mail2trac/interface.py IEmailHandler] and executes its `invoke()` method if its `match()` method returns `True`.
    1414If invoke returns an [http://docs.python.org/library/email email] message, then subsequent `IEmailHandler`s will also process the message. If `None` is returned, then the message is consumed and execution stops.
    1515
    16 To enable the plugin for `postfix`, add an appropriate line to the aliases file (usually `/etc/aliases` or `/etc/postfix/aliases` and then refreshing the aliases database (see [http://www.postfix.org/aliases.5.html man aliases]). The `mail2tracAdmin` script takes as argument the path to the project environment.  The incoming email address should be specified in the `trac.ini` file:
     16To enable the plugin for `postfix`, add an appropriate line to the aliases file, usually `/etc/aliases` or `/etc/postfix/aliases` and then refreshing the aliases database, see [http://www.postfix.org/aliases.5.html man aliases].
     17
     18The `mail2tracAdmin` script takes as argument the path to the project environment. The incoming email address should be specified in the `trac.ini` file:
    1719
    1820{{{#!ini
    … …  
    3335=== Permission
    3436
    35 mail2trac declares 4 permissions:
    36  * MAIL2TICKET_COMMENT : user authorized to comment,
    37  * MAIL2TICKET_PROPERTIES : user authorized to change properties (like 'owner', 'cc', etc ...),
    38  * MAIL2TICKET_CREATE : user authorized to create a ticket
    39  * MAIL2TICKET_ADMIN : all the above
    40 
    41 In order to post ticket :
    42  * the Trac address must be correctly configured (Mr Obvious)
     37This plugin declares the following permissions:
     38 * `MAIL2TICKET_COMMENT` : user authorized to comment
     39 * `MAIL2TICKET_PROPERTIES` : user authorized to change properties, like 'owner', 'cc', etc.
     40 * `MAIL2TICKET_CREATE` : user authorized to create a ticket
     41 * `MAIL2TICKET_ADMIN` : all the above
     42
     43In order to post a ticket :
     44 * the Trac address must be correctly configured (Mr Obvious).
    4345 * you must have declared your mail address in your user preferences.
    4446 * have the correct permission according what you intend to do.
    45  * the unix user launching the mail2tracAdmin should have permission on the trac files (even file creation for attachment)
     47 * the unix user launching the mail2tracAdmin should have permission on the Trac files, even file creation for attachment.
    4648
    4749=== mail parsing
    … …  
    5658
    5759 * Body :
    58    * any line begining with '''#field''' with field one of these: ''type'', ''priority'', ''milestone'', ''component'', ''version'', ''resolution'', ''keywords'', ''cc'', will be treated as request to change the 'field' property; works only with the `MAIL2TICKET_PROPERTIES` permission.
     60   * any line beginning with '''#field''' with field one of these: ''type'', ''priority'', ''milestone'', ''component'', ''version'', ''resolution'', ''keywords'', ''cc'', will be treated as request to change the 'field' property; works only with the `MAIL2TICKET_PROPERTIES` permission.
    5961   * mail2trac understand classic actions : resolve, reassign, accept and reopen, as in the classical web UI:
    6062     * '''#reassign : user''' , reassign to user
    … …  
    6466   * for usability, few actions have an alias :
    6567     * '''#fixed''' is interpreted as '''#resolve:fixed''',
    66      * '''#duplicate''' is interpreted as '''#resolve:duplicate'''',
     68     * '''#duplicate''' is interpreted as '''#resolve:duplicate''',
    6769     * '''#wontfix''' is interpreted as '''#resolve:wontfix''',
    6870     * '''#invalid''' is interpreted as '''#resolve:invalid''',
    … …  
    7072   * any '''#field''' or '''#end''' will be ignored, and what's left is the ticket's description if you create, or the comment if you comment.
    7173
    72 '''Rq''' : at the creation, you can assign a ticket by setting its owner with '''#owner : jdoe '''. In a response you have to use the action '''#reassign'''.
     74'''Rq''' : upon creation you can assign a ticket by setting its owner with '''#owner : jdoe'''. In a response you have to use the action '''#reassign'''.
    7375
    7476=== Attachments
    … …  
    9395we can do that with #cc:jdoe, #component: component2 and #priority :
    9496trivial .
    95 (note that this instruction are not on the begining of a line and will
     97(note that this instruction are not on the beginning of a line and will
    9698be seen as part of the description)
    9799
    … …  
    125127 we can do that with #cc:jdoe, #component: component2 and #priority :
    126128 trivial .
    127  (note that this instruction are not on the begining of a line and will
     129 (note that this instruction are not on the beginning of a line and will
    128130 be seen as part of the description)
    129131
    … …  
    167169>  we can do that with #cc:jdoe, #component: component2 and #priority :
    168170>  trivial .
    169 >  (note that this instruction are not on the begining of a line and will
     171>  (note that this instruction are not on the beginning of a line and will
    170172>  be seen as part of the description)
    171173>
    … …  
    254256> X-Mailer: Trac 0.12.2, by Edgewall Software
    255257
    256 
    257258}}}
    258259