Changes between Version 37 and Version 38 of WikiNotificationPlugin


Ignore:
Timestamp:
Jun 2, 2016, 11:56:08 AM (8 years ago)
Author:
Mitar
Comment:

Updating.

Legend:

Unmodified
Added
Removed
Modified

  • WikiNotificationPlugin

    v37 v38  
    2222   wikinotification.* = enabled
    2323
    24 And optionally::
    25 
    26    ctxtnavadd.* = enabled
     24``smtp_enabled`` has to be enabled in ``notification`` configuration section.
    2725
    2826Available Configuration Options
    2927-------------------------------
    30 These are the options available to include in your ``trac.ini`` under
    31 ``wiki-notification``.
     28These are the options available to include on your ``trac.ini`` under
     29``wiki-notification``. You can configure them through the web admin interface, too.
    3230
    33 =====================  ====================  ================================
    34  **Config Setting**     **Default Value**     **Explanation**
    35 ---------------------  --------------------  --------------------------------
    36 *redirect_time*        5 (in seconds)        The default seconds a redirect
    37                                              should take when
    38                                              watching/un-watching a wiki page.
    39                                              This value is also definable per
    40                                              user, ie, user is able to
    41                                              configure this, of course for
    42                                              himself.
    43 ---------------------  --------------------  --------------------------------
    44 *smtp_always_bcc*      *empty*               Email address(es) to always send
    45                                              notifications to, addresses do
    46                                              not appear publicly (Bcc:).
    47 ---------------------  --------------------  --------------------------------
    48 *smtp_always_cc*       *empty*               Email address(es) to always send
    49                                              notifications to, addresses can
    50                                              be seen by all recipients (Cc:).
    51 ---------------------  --------------------  --------------------------------
    52 *smtp_from*            trac.wiki\@localhost  Sender address to use in
    53                                              notification emails.
    54 ---------------------  --------------------  --------------------------------
    55 *use_public_cc*        False                 Recipients can see email
    56                                              addresses of other CC'ed
    57                                              recipients. If this option is
    58                                              disabled(the default), recipients
    59                                              are put on BCC.
    60 =====================  ====================  ================================
     31=====================  ==========================  ==========================
     32 **Config Setting**     **Default Value**          **Explanation**
     33---------------------  --------------------------  --------------------------
     34*redirect_time*        5 (in seconds)              The default seconds a
     35                                                   redirect should take when
     36                                                   watching/un-watching a
     37                                                   wiki page.
     38                                                   This value is also
     39                                                   definable per user, ie,
     40                                                   user is able to configure
     41                                                   this, of course for
     42                                                   himself.
     43---------------------  --------------------------  --------------------------
     44*smtp_always_bcc*      *empty*                     Comma separated list of
     45                                                   email address(es) to
     46                                                   always send notifications
     47                                                   to, addresses do not
     48                                                   appear publicly (Bcc:).
     49---------------------  --------------------------  --------------------------
     50*smtp_always_cc*       *empty*                     Comma separated list of
     51                                                   email address(es) to
     52                                                   always send notifications
     53                                                   to, addresses can be seen
     54                                                   by all recipients (Cc:).
     55---------------------  --------------------------  --------------------------
     56*from_email*           trac.wiki\@localhost        Sender address to use in
     57                                                   notification emails.
     58---------------------  --------------------------  --------------------------
     59*from_name*            None                        Sender name to use in
     60                                                   notification emails.
     61                                                   Defaults to project name.
     62---------------------  --------------------------  --------------------------
     63*use_public_cc*        False                       Recipients can see email
     64                                                   addresses of other CC'ed
     65                                                   recipients. If this option
     66                                                   is disabled(the default),
     67                                                   recipients are put on BCC.
     68---------------------  --------------------------  --------------------------
     69*attach_diff*          False                       Send changes diff as an
     70                                                   attachment instead of on
     71                                                   the email text body.
     72---------------------  --------------------------  --------------------------
     73*subject_template*     $prefix $page.name $action  A Genshi text template
     74                                                   snippet used to get the
     75                                                   notification subject.
     76---------------------  --------------------------  --------------------------
     77*banned_addresses*     *empty*                     Comma separated list of
     78                                                   email addresses to never
     79                                                   send notifications to.
     80=====================  ==========================  ==========================
    6181
    6282If you want to override these settings then you can include it like the
    … …  
    6585   [wiki-notification]
    6686   redirect_time = 5
    67    smtp_always_bcc =
    68    smtp_always_cc =
    69    smtp_from = trac.wiki@localhost
     87   smtp_always_bcc = someone@somedomain, another.one@somedomain
     88   smtp_always_cc = someone.else@somedomain
     89   from_email = trac.wiki@localhost
     90   from_name = Custom Name
    7091   use_public_cc = false
     92   attach_diff = true
     93   subject_template = Foo $prefix $page.name $action
     94   banned_addresses = banned.user1@somedomain, banned.user2@somedomain
    7195
    7296Aditional Notes(from user input)
    7397~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    7498
    75 * ``easy_install`` is run from the command line (on Linux) not from within
     99* ``pip`` is run from the command line (on Linux) not from within
    76100  Python.
    77101
    … …  
    92116    [wiki-notification]
    93117    smtp_always_cc = someone@somedomain
    94     smtp_from = trac.wiki@localhost
     118    from_email = trac.wiki@localhost
    95119
    96120
    … …  
    102126  WNP 0.2.2, and if present will result in '`UndefinedError: "page" not defined`'.
    103127
    104 .. _read this: https://bitbucket.org/mitar/trac-wikinotification/overview
    105 .. _Easy Install: http://peak.telecommunity.com/DevCenter/EasyInstall
    106128.. _AnnouncerPlugin: http://www.trac-hacks.org/wiki/AnnouncerPlugin
    107129}}}