Author: keith
Date: Mon Jan 21 03:30:07 2008
New Revision: 12620
Log:
Minor change
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 Mon Jan 21 03:30:07 2008
@@ -2,63 +2,88 @@
<html>
<head>
+
+
<meta http-equiv="content-type" content="">
- <title>Email Host Object</title>
+
- <link href="styles.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 object allows users to send out email from there
+
+<p>The Email host object allows users to send out email from there
mashups. It helps you notify users of certain events and acts
as a brigde 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. The one to
use depends on your configuration and your need. </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 usefull if you want to use a default
@@ -66,175 +91,282 @@
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: Changed to the
server.xml requires a server restart.</p>
+
</li>
+
<li>
+
<p>The second constructor unlike the first requires the user
to provide the configuration details each time he creates a new email
object. The plus point is that no server configuration is
needed and you can use diffent accounts when ever you need. The
configuration details should be given as follws,<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 uses the above
constrctor, the details given by the user when creating the email
object gets 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",
"25", "[EMAIL PROTECTED]", "password"); // host, port, 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
be sent. If not set the user account used to auhenticate against the
email gateway will be sent as the from address.<br>
+
<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>This is a required property that denote 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>
+
</tr>
+
<tr>
+
<td><span style="font-weight: bold;">void to(Array to)</span></td>
+
<td>This is a required property that denote the to address of the email
to
be sent. (Optionally a string denoting the to address can
be passed as above.)<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>This is an optional property that denote 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>
+
</tr>
+
<tr>
+
<td><span style="font-weight: bold;">void cc(Array cc)*</span></td>
+
<td>This is an optional property that denote the cc address of
the email to
be sent. (Optionally a string denoting the cc address can
be passed as above.)<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>This is an optional property that denote 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>
+
</tr>
+
<tr>
+
<td><span style="font-weight: bold;">void bcc(Array bcc)*</span></td>
+
<td>This is an optional property that denote the bcc address
of the email to
be sent. (Optionally a string denoting the bcc address can
be passed as above.)<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>
+
<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>
+
<span style="font-style: italic;">email.text = "WSO2 Mashup
server 1.0 was Released on 28th January 2008";</span></td>
+
</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>� WSO2 Inc.</p>
+
</body>
</html>
_______________________________________________
Mashup-dev mailing list
[email protected]
http://www.wso2.org/cgi-bin/mailman/listinfo/mashup-dev
