diff doc/notify-signals.dox @ 18675:cb91bb07eeff

Email notification signals from charkins. Fixes #1324
author Sean Egan <seanegan@gmail.com>
date Sat, 28 Jul 2007 05:30:19 +0000
parents 2177a11e169d
children e0613cf8c493
line wrap: on
line diff
--- a/doc/notify-signals.dox	Sat Jul 28 05:08:42 2007 +0000
+++ b/doc/notify-signals.dox	Sat Jul 28 05:30:19 2007 +0000
@@ -2,6 +2,8 @@
 
  @signals
   @signal displaying-userinfo
+  @signal displaying-email-notification
+  @signal displaying-emails-notification
  @endsignals
 
  @signaldef displaying-userinfo
@@ -18,5 +20,37 @@
   @param user_info The information to be displayed, as PurpleNotifyUserInfoEntry objects
  @endsignaldef
 
+ @signaldef displaying-email-notification
+  @signalproto
+void (*displaying_email_notification)(const char *subject,
+                                      const char *from,
+                                      const char *to,
+                                      const char *url);
+  @endsignalproto
+  @signaldesc
+   Emitted before email notification is handed to the UI to display.
+  @param subject   Subject of email being notified of.
+  @param from      Who the email is from.
+  @param to        Who the email is to.
+  @param url       A url to view the email.
+ @endsignaldef
+
+ @signaldef displaying-emails-notification
+  @signalproto
+void (*displaying_emails_notification)(const char **subjects,
+                                       const char **froms,
+                                       const char **tos,
+                                       const char **urls,
+                                       guint count);
+  @endsignalproto
+  @signaldesc
+   Emitted before notification of multiple emails is handed to the UI to display.
+  @param subjects   Subjects of emails being notified of.
+  @param froms      Who the emails are from.
+  @param tos        Who the emails are to.
+  @param urls       The urls to view the emails.
+  @param count      Number of emails being notified of.
+ @endsignaldef
+
 */
 // vim: syntax=c tw=75 et