Changes between Version 2 and Version 3 of TracDev/NotificationApi

Timestamp:

Jul 25, 2010, 11:17:49 PM (14 years ago)

Author:

hasienda <hoff.st@…>

Comment:

add ticket system specific API info and another link to Trac plugins using TracNotification infrastructure

TracDev/NotificationApi

@@ -624 +624 @@
 {{{#!td
 includes methods {{{build_addresses}}} and {{{remove_dup}}}
+}}}
+
+Source: [source:trunk/trac/notification.py trac/notification.py]
+
+{{{#!th
+type
+}}}
+{{{#!th
+name
+}}}
+{{{#!th
+doc-string/notes
+}}}
+|----------------
+{{{#!td style="background: #efe"
+class
+}}}
+{{{#!td style="background: #efe"
+!TicketNotificationSystem(Component)
+}}}
+{{{#!td
+
+{{{#!th
+type
+}}}
+{{{#!th
+section
+}}}
+{{{#!th
+option name
+}}}
+{{{#!th
+default value
+}}}
+{{{#!th
+doc-string/notes
+}}}
+|----------------
+{{{#!td
+!BoolOption
+}}}
+{{{#!td
+notification
+}}}
+{{{#!td
+always_notify_owner
+}}}
+{{{#!td
+false
+}}}
+{{{#!td
+Always send notifications to the ticket owner (''since 0.9'').
+}}}
+|----------------
+{{{#!td
+!BoolOption
+}}}
+{{{#!td
+notification
+}}}
+{{{#!td
+always_notify_reporter
+}}}
+{{{#!td
+false
+}}}
+{{{#!td
+Always send notifications to any address in the ''reporter'' field.
+}}}
+|----------------
+{{{#!td
+!BoolOption
+}}}
+{{{#!td
+notification
+}}}
+{{{#!td
+always_notify_updater
+}}}
+{{{#!td
+true
+}}}
+{{{#!td
+Always send notifications to the person who causes the ticket property change and to any previous updater of that ticket.
+}}}
+|----------------
+{{{#!td
+Option
+}}}
+{{{#!td
+notification
+}}}
+{{{#!td
+ticket_subject_template
+}}}
+{{{#!td
+'$prefix #$ticket.id: $summary'
+}}}
+{{{#!td
+A Genshi text template snippet used to get the notification subject.[[BR]]
+By default, the subject template is `$prefix #$ticket.id: $summary`. `$prefix` being the value of the `smtp_subject_prefix` option. ''(since 0.11)''
+}}}
+
+}}}
+|----------------
+{{{#!td colspan="3"
+}}}
+|----------------
+{{{#!td style="background: #efe"
+class
+}}}
+{{{#!td style="background: #efe"
+!TicketNotifyEmail(NotifyEmail)
+}}}
+{{{#!td
+Notification of ticket changes.
+}}}
+|----------------
+{{{#!td
+method
+}}}
+{{{#!td
+{{{__init__}}}
+}}}
+{{{#!td
+}}}
+|----------------
+{{{#!td
+method
+}}}
+{{{#!td
+notify
+}}}
+{{{#!td
+Send ticket change notification e-mail (untranslated)
+}}}
+|----------------
+{{{#!td
+method
+}}}
+{{{#!td
+_notify
+}}}
+{{{#!td
+}}}
+|----------------
+{{{#!td
+method
+}}}
+{{{#!td
+send
+}}}
+{{{#!td
+}}}
+|----------------
+{{{#!td
+method
+}}}
+{{{#!td
+format_props
+}}}
+{{{#!td
+}}}
+|----------------
+{{{#!td
+method
+}}}
+{{{#!td
+parse_cc
+}}}
+{{{#!td
+}}}
+|----------------
+{{{#!td
+method
+}}}
+{{{#!td
+diff_cc
+}}}
+{{{#!td
+}}}
+|----------------
+{{{#!td
+method
+}}}
+{{{#!td
+format_hdr
+}}}
+{{{#!td
+}}}
+|----------------
+{{{#!td
+method
+}}}
+{{{#!td
+format_subj
+}}}
+{{{#!td
+}}}
+|----------------
+{{{#!td
+method
+}}}
+{{{#!td
+get_recipients
+}}}
+{{{#!td
+}}}
+|----------------
+{{{#!td
+method
+}}}
+{{{#!td
+get_message_id
+}}}
+{{{#!td
+Generate a predictable, but sufficiently unique message ID.
+}}}
+|----------------
+{{{#!td
+method
+}}}
+{{{#!td
+send
+}}}
+{{{#!td
 }}}
 
@@ -634 +860 @@
  * [th:wiki:FullBlogNotificationPlugin]
  * [th:wiki:PrivateCommentPlugin PrivateCommentPlugin]
+ * [th:wiki:WikiNotificationPlugin WikiNotificationPlugin]
 
 Trac plugins using '''!TicketNotifyEmail''' (as of 25-Jul-2010)