antville/helma
antville/helma
1
1
Fork 0
Code Issues 5 Pull requests 7 Projects Releases 5 Activity Actions

Added setText() method and lots of JavaDoc comments.

Browse source
This commit is contained in:
hns 2003-06-25 12:14:36 +00:00
parent 7f213bf43a
commit ffc8956b8a
1 changed files with 45 additions and 28 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

73
src/helma/scripting/rhino/extensions/MailObject.java
View file

@ -65,9 +65,9 @@ public class MailObject extends ScriptableObject implements Serializable {
/** /**
* Creates a new ESMail object. * Creates a new MailObject.
* *
* @param mailx ... * @param mprops the Mail properties
*/ */
MailObject(Properties mprops) { MailObject(Properties mprops) {
this.status = OK; this.status = OK;
@ -114,7 +114,7 @@ public class MailObject extends ScriptableObject implements Serializable {
ctor.put("props", ctor, props); ctor.put("props", ctor, props);
String[] mailFuncs = { String[] mailFuncs = {
"addBCC", "addCC", "addPart", "addText", "addTo", "addBCC", "addCC", "addPart", "addText", "addTo",
"send", "setFrom", "setSubject", "setTo" "send", "setFrom", "setSubject", "setText", "setTo"
}; };
try { try {
proto.defineFunctionProperties(mailFuncs, MailObject.class, 0); proto.defineFunctionProperties(mailFuncs, MailObject.class, 0);
@ -126,11 +126,11 @@ public class MailObject extends ScriptableObject implements Serializable {
/** /**
* Set the error status of this message
* *
* * @param status the new error status
* @param status ...
*/ */
public void setStatus(int status) { protected void setStatus(int status) {
// Only register the first error that occurrs // Only register the first error that occurrs
if (this.status == 0) { if (this.status == 0) {
this.status = status; this.status = status;
@ -138,9 +138,9 @@ public class MailObject extends ScriptableObject implements Serializable {
} }
/** /**
* Returns the error status of this message.
* *
* * @return the error status of this message
* @return ...
*/ */
public int getStatus() { public int getStatus() {
return status; return status;
@ -148,7 +148,7 @@ public class MailObject extends ScriptableObject implements Serializable {
/** /**
* * Add some text to a plain text message.
*/ */
public void addText(String text) { public void addText(String text) {
if (text != null) { if (text != null) {
@ -159,10 +159,20 @@ public class MailObject extends ScriptableObject implements Serializable {
} }
} }
/** /**
* Set the text to a plain text message, clearing any previous text.
*/
public void setText(String text) {
if (text != null) {
buffer = new StringBuffer(text);
}
}
/**
* Add a MIME message part to a multipart message
* *
* * @param val The part to add
* @param val ...
* *
* @throws Exception ... * @throws Exception ...
* @throws IOException ... * @throws IOException ...
@ -203,9 +213,9 @@ public class MailObject extends ScriptableObject implements Serializable {
} }
/** /**
* Set the subject of this message
* *
* * @param val the subject line
* @param val ...
* *
* @throws Exception ... * @throws Exception ...
*/ */
@ -218,9 +228,9 @@ public class MailObject extends ScriptableObject implements Serializable {
} }
/** /**
* Set the Reply-to address for this message
* *
* * @param addstr the email address to set in the Reply-to header
* @param add ...
* *
* @throws Exception ... * @throws Exception ...
* @throws AddressException ... * @throws AddressException ...
@ -237,9 +247,10 @@ public class MailObject extends ScriptableObject implements Serializable {
} }
/** /**
* Set the From address for this message
* *
* * @param addstr the email address to set in the From header
* @param add ... * @param name the name this address belongs to
* *
* @throws Exception ... * @throws Exception ...
* @throws AddressException ... * @throws AddressException ...
@ -263,9 +274,10 @@ public class MailObject extends ScriptableObject implements Serializable {
/** /**
* Set the To address for this message
* *
* * @param addstr the email address to set in the To header
* @param add ... * @param name the name this address belongs to
* *
* @throws Exception ... * @throws Exception ...
* @throws AddressException ... * @throws AddressException ...
@ -276,9 +288,10 @@ public class MailObject extends ScriptableObject implements Serializable {
/** /**
* Add a To address for this message
* *
* * @param addstr the email address to set in the To header
* @param add ... * @param name the name this address belongs to
* *
* @throws Exception ... * @throws Exception ...
* @throws AddressException ... * @throws AddressException ...
@ -288,9 +301,10 @@ public class MailObject extends ScriptableObject implements Serializable {
} }
/** /**
* ADd a CC address for this message
* *
* * @param addstr the email address to set in the CC header
* @param add ... * @param name the name this address belongs to
* *
* @throws Exception ... * @throws Exception ...
* @throws AddressException ... * @throws AddressException ...
@ -300,9 +314,10 @@ public class MailObject extends ScriptableObject implements Serializable {
} }
/** /**
* Add a BCC address for this message
* *
* * @param addstr the email address to set in the BCC header
* @param add ... * @param name the name this address belongs to
* *
* @throws Exception ... * @throws Exception ...
* @throws AddressException ... * @throws AddressException ...
@ -312,9 +327,11 @@ public class MailObject extends ScriptableObject implements Serializable {
} }
/** /**
* Add a recipient for this message
* *
* * @param addstr the email address
* @param add ... * @param name the name this address belongs to
* @param type the type of the recipient such as To, CC, BCC
* *
* @throws Exception ... * @throws Exception ...
* @throws AddressException ... * @throws AddressException ...
@ -340,7 +357,7 @@ public class MailObject extends ScriptableObject implements Serializable {
/** /**
* * Send the message.
* *
* @throws Exception ... * @throws Exception ...
*/ */