Merge pull request #2025 from matthewrmshin/6.11.x-event-mail-footer

Configurable event mail footer

doc/siterc.tex

@@ -859,6 +859,8 @@ \subsection{[cylc]}
 
 \subparagraph[mail events]{[cylc] \textrightarrow [[events]] \textrightarrow mail events}
 
+\subparagraph[mail footer]{[cylc] \textrightarrow [[events]] \textrightarrow mail footer}
+
 \subparagraph[mail from]{[cylc] \textrightarrow [[events]] \textrightarrow mail from}
 
 \subparagraph[mail smtp]{[cylc] \textrightarrow [[events]] \textrightarrow mail smtp}

doc/suiterc.tex

@@ -329,6 +329,26 @@ \subsection{[cylc]}
     \item {\em example:} \lstinline@handler = startup, shutdown, timeout@
 \end{myitemize}
 
+\paragraph[mail footer]{[cylc] \textrightarrow [[events]] \textrightarrow mail footer}
+
+Specify a string or string template to insert to footers of notification emails
+for both suite events and task events.
+
+A template string may have any or all of these patterns which will be
+substituted with actual values:
+\begin{myitemize}
+    \item \%(host)s: suite host name
+    \item \%(port)s: suite port number
+    \item \%(owner)s: suite owner name
+    \item \%(suite)s: suite name
+\end{myitemize}
+
+\begin{myitemize}
+    \item {\em type:} 
+    \item {\em default:} (none)
+    \item {\em example:} \lstinline@mail footer = see: http://localhost/%(owner)s/notes-on/%(suite)s/@
+\end{myitemize}
+
 \paragraph[mail from]{[cylc] \textrightarrow [[events]] \textrightarrow mail from}
 
 Specify an alternate \lstinline=from:= email address for suite event notifications.

lib/cylc/cfgspec/globalcfg.py

@@ -78,6 +78,7 @@
             'mail from': vdr(vtype='string'),
             'mail smtp': vdr(vtype='string'),
             'mail to': vdr(vtype='string'),
+            'mail footer': vdr(vtype='string'),
             'startup handler': vdr(vtype='string_list', default=[]),
             'timeout handler': vdr(vtype='string_list', default=[]),
             'inactivity handler': vdr(vtype='string_list', default=[]),

lib/cylc/cfgspec/suite.py

@@ -258,6 +258,7 @@ def _coerce_parameter_list(value, keys, _):
             'mail from': vdr(vtype='string'),
             'mail smtp': vdr(vtype='string'),
             'mail to': vdr(vtype='string'),
+            'mail footer': vdr(vtype='string'),
         },
         'simulation mode': {
             'disable suite event hooks': vdr(vtype='boolean', default=True),