Author: keith Date: Mon Jan 21 03:13:08 2008 New Revision: 12613 Log:
Updating email host object docs 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:13:08 2008 @@ -50,10 +50,11 @@ </div> -<h3>2.0 Scraper Object</h3> - +<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. They are as follows,</p> +use depends on your configuration and your need. </p> <ol> @@ -140,6 +141,85 @@ </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> _______________________________________________ Mashup-dev mailing list [email protected] http://www.wso2.org/cgi-bin/mailman/listinfo/mashup-dev
