Added documentation for EVENT_DISPLAY_EMAIL_BUILD_SUBJECT

mantisbt · Oct 24, 2015 · 0ebdfa4 · 0ebdfa4
1 parent bc61326
commit 0ebdfa4
Showing 1 changed file with 20 additions and 0 deletions.
diff --git a/docbook/Developers_Guide/en-US/Events_Reference_Output.xml b/docbook/Developers_Guide/en-US/Events_Reference_Output.xml
@@ -61,6 +61,26 @@
 			</blockquote>
 		</blockquote>
 
+		<blockquote id="dev.eventref.output.display.email.subject">
+			<title>EVENT_DISPLAY_EMAIL_BUILD_SUBJECT (Chained)</title>
+
+			<blockquote>
+				<para>
+					This is an event to format the subject line of an email before being sent.
+				</para>
+
+				<itemizedlist>
+					<title>Parameters</title>
+					<listitem><para>String: input string for email subject</para></listitem>
+				</itemizedlist>
+
+				<itemizedlist>
+					<title>Return Value</title>
+					<listitem><para>String: modified subject string</para></listitem>
+				</itemizedlist>
+			</blockquote>
+		</blockquote>
+
 		<blockquote id="dev.eventref.output.display.formatted">
 			<title>EVENT_DISPLAY_FORMATTED (Chained)</title>