You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@vcl.apache.org by bu...@apache.org on 2019/06/14 14:49:26 UTC

svn commit: r1046288 - in /websites/staging/vcl/trunk/content: ./ docs/htmlemailmessages.html

Author: buildbot
Date: Fri Jun 14 14:49:26 2019
New Revision: 1046288

Log:
Staging update by buildbot for vcl

Added:
    websites/staging/vcl/trunk/content/docs/htmlemailmessages.html
Modified:
    websites/staging/vcl/trunk/content/   (props changed)

Propchange: websites/staging/vcl/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Fri Jun 14 14:49:26 2019
@@ -1 +1 @@
-1860979
+1861345

Added: websites/staging/vcl/trunk/content/docs/htmlemailmessages.html
==============================================================================
--- websites/staging/vcl/trunk/content/docs/htmlemailmessages.html (added)
+++ websites/staging/vcl/trunk/content/docs/htmlemailmessages.html Fri Jun 14 14:49:26 2019
@@ -0,0 +1,155 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<head>
+<!--
+
+    Licensed to the Apache Software Foundation (ASF) under one or more
+    contributor license agreements.  See the NOTICE file distributed with
+    this work for additional information regarding copyright ownership.
+    The ASF licenses this file to You under the Apache License, Version 2.0
+    (the "License"); you may not use this file except in compliance with
+    the License.  You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE- 2.0
+
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+-->
+
+  <link href="/css/vcl.css" rel="stylesheet" type="text/css">
+  <link href="/css/code.css" rel="stylesheet" type="text/css">
+  <title>Apache VCL - Customization of Email messages with HTML content</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+</head>
+
+<body>
+  <div id="sitetitle">
+    <table width="100%" border="0" cellspacing="0" cellpadding="5">
+      <tr>
+         <td><a href="/index.html"><img src="/img/vcl-logo.png" height="100" align="left" alt="Apache VCL logo"></a></td>
+         <td><a href="http://www.apache.org"><img src="/img/asf-logo.png" align="right" alt="Apache Software Foundation logo"></a></td>
+      </tr>
+    </table>
+  </div>
+  
+  <div id="left-column">
+    <div id="navigation"> 
+      <style type="text/css">
+/* The following code is added by mdx_elementid.py
+   It was originally lifted from http://subversion.apache.org/style/site.css */
+/*
+ * Hide class="elementid-permalink", except when an enclosing heading
+ * has the :hover property.
+ */
+.headerlink, .elementid-permalink {
+  visibility: hidden;
+}
+h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style>
+<ul>
+<li><a href="/index.html">Information</a><ul>
+<li><a href="/info/features.html">Features</a></li>
+<li><a href="/info/architecture.html">Architecture</a></li>
+<li><a href="/downloads/download.cgi">Download</a></li>
+<li><a href="http://www.apache.org/licenses/">License</a></li>
+<li><a href="http://www.apache.org/security/">Security</a></li>
+</ul>
+</li>
+<li><a href="/docs/index.html">Documentation</a><ul>
+<li><a href="https://cwiki.apache.org/confluence/x/yQdG">Using VCL</a></li>
+<li><a href="https://cwiki.apache.org/confluence/x/ywdG">Administration</a></li>
+<li><a href="/docs/installation.html">Installation</a></li>
+</ul>
+</li>
+<li><a href="https://cwiki.apache.org/confluence/display/VCL/Apache+VCL" target="_blank">Confluence Wiki</a><ul>
+<li></li>
+</ul>
+</li>
+<li><a href="https://issues.apache.org/jira/browse/VCL" target="_blank">Jira Issue Tracking</a><ul>
+<li></li>
+</ul>
+</li>
+<li><a href="/comm/index.html">Community</a><ul>
+<li><a href="/comm/index.html#getInvolved">Getting Involved</a></li>
+<li><a href="/comm/index.html#mail-list">Mailing Lists</a></li>
+<li><a href="/dev/index.html">Development</a><ul>
+<li><a href="/dev/code-documentation.html">Code Documentation</a></li>
+<li><a href="/dev/roadmap.html">Roadmap</a></li>
+</ul>
+</li>
+</ul>
+</li>
+<li><a href="http://www.apache.org">Apache Software Foundation</a><ul>
+<li><a href="http://www.apache.org/foundation/thanks.html">Thanks</a></li>
+<li><a href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a></li>
+</ul>
+</li>
+</ul>
+    </div>
+    <div id="current-event"> 
+      <a  href="https://www.apache.org/events/current-event.html"><img src="https://www.apache.org/events/current-event-125x125.png"/></a>
+    </div>
+  </div>
+  
+  <div id="content">
+    <h1 class="title">Customization of Email messages with HTML content</h1>
+    <style type="text/css">
+/* The following code is added by mdx_elementid.py
+   It was originally lifted from http://subversion.apache.org/style/site.css */
+/*
+ * Hide class="elementid-permalink", except when an enclosing heading
+ * has the :hover property.
+ */
+.headerlink, .elementid-permalink {
+  visibility: hidden;
+}
+h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style>
+<h1 id="customization-of-email-messages-with-html-content">Customization of Email messages with HTML content<a class="headerlink" href="#customization-of-email-messages-with-html-content" title="Permanent link">&para;</a></h1>
+<p>Email messages sent out to VCL users can be customized under the Site Configuration part of the
+site. However, HTML content is not allowed to be entered via the web form for security reasons. 
+VCL 2.5.1 introduced a method of including HTML content in the email messages using a command 
+line script run from a management node. The script is in the bin directory of the management node 
+code. The same substitution available in plain text messages can be used in the HTML messages.</p>
+<p>Usage:
+<pre><code>
+vclmessages.pl --getmessagenames
+vclmessages.pl --dumpmessage '&lt;name of message&gt;'
+vclmessages.pl --setmessage '&lt;name of message&gt;' --htmlfile &lt;filename&gt; --subject &lt;message subject&gt;
+vclmessages.pl --resetmessage '&lt;name of message&gt;'</p>
+<p>vclmessages.pl --help|-?
+</code></pre></p>
+<p>Where</p>
+<p>--getmessagenames displays a list of all available names that can be used<br>
+--dumpmessage displays the current value of a message<br>
+--setmessage sets the value of a message to the contents of the specified file<br>
+--resetmessage sets the value of a message back to the original value as distributed with VCL<br></p>
+<p>&lt;name of message&gt; = the name of the message from the database (enclose in single quotes)<br>
+<span style="margin-left:40px;">(use --getmessagenames to get a list of message names)</span></p>
+<p>&lt;filename&gt; = filename (including path) of file containing html contents for email message</p>
+<p>&lt;message subject&gt; = subject for email message (enclose in single quotes)</p>
+<p>So, use "--getmessagenames" to get a list of all of the messages that can be set.  Use 
+"--dumpmessage" to see the current contents of a message.</p>
+<p>To set a new message, create a file containing the HTML that you would like used as the message. 
+Then, use "--setmessage" to set the contents of the message, specifying both a message subject and 
+the file containing the contents of the HTML message.  To reset a message back to the stock message 
+supplied at VCL installation, use "--resetmessage".  Only the "Global" messages can be reset.</p>
+<p>To set a new message for a specific affiliation, an affiliation specific message, plain text 
+message needs to be created through the web UI first. Then, that message can be converted to HTML 
+using the script.</p>
+  </div>
+  
+  <div id="footer">
+    <div class="copyright">
+      <p>
+        Copyright &copy; 2019 The Apache Software Foundation, Licensed under 
+        the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.
+        <br />
+        Apache and the Apache feather logo are trademarks of The Apache Software Foundation.
+      </p>
+    </div>
+  </div>
+  
+</body>
+</html>