Author: keith
Date: Thu May 1 08:29:21 2008
New Revision: 16441
Log:
Adding the correct css cause it was not picking the css
Modified:
trunk/mashup/java/xdocs/emailhostobject.html
Modified: trunk/mashup/java/xdocs/emailhostobject.html
==============================================================================
--- trunk/mashup/java/xdocs/emailhostobject.html (original)
+++ trunk/mashup/java/xdocs/emailhostobject.html Thu May 1 08:29:21 2008
@@ -2,140 +2,67 @@
<html>
<head>
-
-
-
-
-
-
<meta http-equiv="content-type" content="">
+ <title>Email Host Object</title>
+ <link href="css/mashup-docs.css" rel="stylesheet" type="text/css"
media="all">
-
-
-
-
-
-
-
-
- <title>Email Host Object</title>
- <link href="styles.css" rel="stylesheet" type="text/css" media="all">
</head>
<body>
-
-
-
<div id="main-content">
<h1>Email Host Object</h1>
-
-
-
<h3>1.0 Introduction</h3>
-
-
-
-<p>The Email host object allows users to send out email from their
+<p>The Email host object allows users to send out email from
+their
mashups. It helps notify users of certain events and acts
as a bridge between mashups and users.</p>
-
-
-
<h3>1.1 Example</h3>
-
-
-
<div class="code">
var email = new Email("host", "port", "username", "password");<br>
-
-
-
var file = new File("temp.txt");<br>
-
-
-
email.from = "[EMAIL PROTECTED]";<br>
-
-
-
email.to = "[EMAIL PROTECTED]"; // alternatively message.to can be a array
of strings. Same goes for cc and bcc<br>
-
-
-
email.cc = "[EMAIL PROTECTED]";<br>
-
-
-
email.bcc = "[EMAIL PROTECTED]";<br>
-
-
-
email.subject = "WSO2 Mashup server 1.0 Released";<br>
-
-
-
email.addAttachement(file, "temp.txt"); // Optionally can add
attachements, it has a variable number of arguments. each argument can
be a File hostObject or a string representing a file.<br>
-
-
-
email.text = "WSO2 Mashup server 1.0 was Released on 28th January 2008";<br>
-
-
-
email.send();<br>
-
-
-
</div>
-
-
-
<h3>2.0 Email Object</h3>
-
-
<h4>2.1 Email Object Constructors
</h4>
-
-
-<p>The Email Object has three different constructors. Choose one depending
+<p>The Email Object has three different constructors. Choose one
+depending
on your configuration and your needs. </p>
-
-
-
<ol>
-
-
-
<li>
-
-
-
<p>The first constructor takes no parameters and uses
configuration information specified in the server.xml. Using a
configuration such as this is useful if you want to use a default
@@ -143,506 +70,294 @@
hassle of having to key in the configuration details each time you need
a new email object.</p>
-
-
-
-
-
-
<div class="code">var email = new Email();</div>
-
-
-
<br>
-
-
-
The configuration in the server.xml should be in the
following form: (The default server.xml has some prepopulated dummy
values. Please update them as required.)<br>
-
-
-
-
-
-
<div style="margin-left: 40px;"><br>
-
-
-
</div>
-
-
-
-
-
-
<div class="code">
<!--Used to
configure your default email account that
will be used to send emails from mashups<br>
-
-
-
using the Email host Object--><br>
-
-
-
<EmailConfig><br>
-
-
-
<host>smtp.gmail.com</host><br>
-
-
-
<port>25</port><br>
-
-
-
<username>[EMAIL PROTECTED]</username><br>
-
-
-
<password>password</password><br>
-
-
-
</EmailConfig></div>
-
-
-
-
-
-
<p>Note: Changes to the
server.xml require a server restart.</p>
-
-
-
</li>
-
-
-
<li>
-
-
-
- <p>The second constructor, unlike the first, requires the user
+ <p>The second constructor, unlike the first, requires the
+user
to provide the configuration details each time he creates a new email
object. The benefit is that no server configuration is
needed and you can use diffent accounts when ever you need. The
configuration details should be given as follows:<br>
-
-
-
</p>
-
-
-
-
-
-
<div class="code">var email = new
Email("smtp.gmail.com",
"25", "[EMAIL PROTECTED]", "password"); // host, port, username,
password</div>
-
-
-
-
-
-
<p>Note: If the configuration
details are given in the server.xml and the user invokes the above
constructor, the details given by the user when creating the email
object take precedence.</p>
-
-
-
</li>
-
-
-
<li>
-
-
-
<p>The third is a slight variant of the second. It does not
require a port to be specified:</p>
-
-
-
-
-
-
<div class="code">var email = new
-Email("smtp.gmail.com", "[EMAIL PROTECTED]", "password"); // host, username,
+Email("smtp.gmail.com", "[EMAIL PROTECTED]", "password"); // host,
+username,
password</div>
-
-
-
</li>
-
-
-
</ol>
-
-
-
<br>
-
-
<h4>2.2 API Documentation</h4>
-
-
<br>
-
-
<table style="text-align: left;" border="1" cellpadding="2" cellspacing="2">
-
-
<tbody>
-
-
<tr>
-
-
<td>Member</td>
-
-
<td>Description</td>
-
-
</tr>
-
-
<tr>
-
-
<td><b>void from(string from</b>)*</td>
-
- <td>An optional property to set the "from" address of the email to
+ <td>An optional property to set the "from" address of the
+email to
be sent. If not set the user account used to authenticate against the
email gateway will be sent as the "from" address.<br>
-
-
- <span style="font-style: italic;">email.from = "[EMAIL
PROTECTED]";</span></td>
-
-
+ <span style="font-style: italic;">email.from
+= "[EMAIL PROTECTED]";</span></td>
</tr>
-
-
<tr>
+ <td><span style="font-weight: bold;">void
+to(String to)</span></td>
-
- <td><span style="font-weight: bold;">void to(String to)</span></td>
-
-
- <td>This is a required property that denotes the "to" address of the
+ <td>This is a required property that denotes the "to"
+address of the
email to be sent. (Optionally an array of strings denoting the "to"
addresses can be passed as below.)<br>
-
-
- <span style="font-style: italic;">email.to = "[EMAIL
PROTECTED]";</span></td>
-
-
+ <span style="font-style: italic;">email.to
+= "[EMAIL PROTECTED]";</span></td>
</tr>
-
-
<tr>
+ <td><span style="font-weight: bold;">void
+to(Array to)</span></td>
-
- <td><span style="font-weight: bold;">void to(Array to)</span></td>
-
-
- <td>This is a required property that denotes the "to" addresses of the
email to
+ <td>This is a required property that denotes the "to"
+addresses of the email to
be sent. (Optionally a string denoting a single "to" address can
be passed as above.)<br>
-
-
- <span style="font-style: italic;"> var to = new Array();<br>
-
-
+ <span style="font-style: italic;">
+var to = new Array();<br>
to[0] = "[EMAIL PROTECTED]";<br>
-
-
to[1] = "[EMAIL PROTECTED]"; <br>
-
-
email.to = to;</span></td>
-
-
</tr>
-
-
<tr>
+ <td><span style="font-weight: bold;">void
+cc(String cc)*</span></td>
-
- <td><span style="font-weight: bold;">void cc(String cc)*</span></td>
-
-
- <td>This is an optional property that denotes the "cc" address of the
email to
-be sent. (Optionally an array of strings denoting the "cc" addresses can
+ <td>This is an optional property that denotes the "cc"
+address of the email to
+be sent. (Optionally an array of strings denoting the "cc" addresses
+can
be passed as below.)<br>
-
-
- <span style="font-style: italic;">email.cc = "[EMAIL
PROTECTED]";</span></td>
-
-
+ <span style="font-style: italic;">email.cc
+= "[EMAIL PROTECTED]";</span></td>
</tr>
-
-
<tr>
+ <td><span style="font-weight: bold;">void
+cc(Array cc)*</span></td>
-
- <td><span style="font-weight: bold;">void cc(Array cc)*</span></td>
-
-
- <td>This is an optional property that denotes the "cc" addresses of the
email to
+ <td>This is an optional property that denotes the "cc"
+addresses of the email to
be sent. (Optionally a string denoting a single "cc" address can
be passed as above.)<br>
-
-
- <span style="font-style: italic;"> var cc = new Array();<br>
-
-
+ <span style="font-style: italic;">
+var cc = new Array();<br>
cc[0] = "[EMAIL PROTECTED]";<br>
-
-
cc[1] = "[EMAIL PROTECTED]"; <br>
-
-
email.cc= cc;</span></td>
-
-
</tr>
-
-
<tr>
+ <td><span style="font-weight: bold;">void
+bcc(String bcc)*</span></td>
-
- <td><span style="font-weight: bold;">void bcc(String bcc)*</span></td>
-
-
- <td>This is an optional property that denotes the "bcc" address of the
email to
-be sent. (Optionally an array of strings denoting the "bcc" addresses can
+ <td>This is an optional property that denotes the "bcc"
+address of the email to
+be sent. (Optionally an array of strings denoting the "bcc" addresses
+can
be passed as below.)<br>
-
-
- <span style="font-style: italic;">email.bcc = "[EMAIL
PROTECTED]";</span></td>
-
-
+ <span style="font-style: italic;">email.bcc
+= "[EMAIL PROTECTED]";</span></td>
</tr>
-
-
<tr>
+ <td><span style="font-weight: bold;">void
+bcc(Array bcc)*</span></td>
-
- <td><span style="font-weight: bold;">void bcc(Array bcc)*</span></td>
-
-
- <td>This is an optional property that denotes the "bcc" addresses of the
email to
+ <td>This is an optional property that denotes the "bcc"
+addresses of the email to
be sent. (Optionally a string denoting a single "bcc" address can
be passed as above.)<br>
-
-
- <span style="font-style: italic;"> var bcc = new Array();<br>
-
-
+ <span style="font-style: italic;">
+var bcc = new Array();<br>
bcc[0] = "[EMAIL PROTECTED]";<br>
-
-
bcc[1] = "[EMAIL PROTECTED]"; <br>
-
-
email.bcc = bcc;</span></td>
-
-
</tr>
-
-
<tr>
+ <td><span style="font-weight: bold;">void
+subject(String </span><span style="font-weight:
bold;">subject</span><span style="font-weight: bold;">)</span></td>
+ <td>An optional property to set the subject of the email to
+be sent.<br>
- <td><span style="font-weight: bold;">void
subject(String </span><span style="font-weight: bold;">subject</span><span
style="font-weight: bold;">)</span></td>
-
-
-
- <td>An optional property to set the subject of the email to be sent.<br>
-
-
-
- <span style="font-style: italic;">email.subject = "WSO2 Mashup
server 1.0 Released";</span></td>
-
-
+ <span style="font-style: italic;">email.subject
+= "WSO2 Mashup server 1.0 Released";</span></td>
</tr>
-
-
<tr>
+ <td><span style="font-weight: bold;">void
+text(String text)</span><span style="font-weight: bold;"></span></td>
+ <td>An optional property to set the body text of the email
+to be sent.<br>
- <td><span style="font-weight: bold;">void text(String text)</span><span
style="font-weight: bold;"></span></td>
-
-
-
- <td>An optional property to set the body text of the email to be
sent.<br>
-
-
+ <span style="font-style: italic;">email.text
+= "WSO2 Mashup server 1.0 was Released on 28th January 2008";</span></td>
- <span style="font-style: italic;">email.text = "WSO2 Mashup
server 1.0 was Released on 28th January 2008";</span></td>
+ </tr>
+ <tr>
+ <td><span style="font-weight: bold;">void
+addAttachment([String filePath]* [FileHostObject file]*)</span></td>
- </tr>
- <tr>
- <td><span style="font-weight: bold;">void addAttachment([String
filePath]* [FileHostObject file]*)</span></td>
- <td>An optional property to add attchments to the email been sent. This
function has a variable number of arguments, each argument can
+ <td>An optional property to add attchments to the email
+been sent. This function has a variable number of arguments,
+each argument can
be a File hostObject or a string representing a file.<br>
-
+ var file = new File("temp.txt"); // A file exists
+at temp.txt<br>
+ email.addAttachement(file, "temp.txt");</td>
-var file = new File("temp.txt"); // A file exists at temp.txt<br>
-
+ </tr>
+ <tr>
+ <td><span style="font-weight: bold;">void
+send()</span></td>
-email.addAttachement(file, "temp.txt");</td>
- </tr>
- <tr>
- <td><span style="font-weight: bold;">void send()</span></td>
<td>Used to send the email.</td>
- </tr>
-
+ </tr>
-
-
-
</tbody>
</table>
-
-
<br>
-
-
-
<h3>3.0 References<br>
-
-
-
</h3>
-
-
-
<ul>
-
-
-
<li><a href="apidocs/org/wso2/mashup/hostobjects/email/Email.html">JavaDoc
for the Email host Object</a></li>
-
-
-
</ul>
-
-
-
</div>
-
-
<p>� 2007-2008 WSO2 Inc.</p>
-
-
-
</body>
</html>
_______________________________________________
Mashup-dev mailing list
[email protected]
http://www.wso2.org/cgi-bin/mailman/listinfo/mashup-dev
