Author: rdonkin
Date: Wed Jul 27 12:04:52 2005
New Revision: 225576
URL: http://svn.apache.org/viewcvs?rev=225576&view=rev
Log:
Added since tags to API methods.
Modified:
jakarta/commons/proper/email/trunk/src/java/org/apache/commons/mail/ByteArrayDataSource.java
jakarta/commons/proper/email/trunk/src/java/org/apache/commons/mail/DefaultAuthenticator.java
jakarta/commons/proper/email/trunk/src/java/org/apache/commons/mail/Email.java
jakarta/commons/proper/email/trunk/src/java/org/apache/commons/mail/EmailAttachment.java
jakarta/commons/proper/email/trunk/src/java/org/apache/commons/mail/EmailException.java
jakarta/commons/proper/email/trunk/src/java/org/apache/commons/mail/HtmlEmail.java
jakarta/commons/proper/email/trunk/src/java/org/apache/commons/mail/MultiPartEmail.java
jakarta/commons/proper/email/trunk/src/java/org/apache/commons/mail/SimpleEmail.java
Modified:
jakarta/commons/proper/email/trunk/src/java/org/apache/commons/mail/ByteArrayDataSource.java
URL:
http://svn.apache.org/viewcvs/jakarta/commons/proper/email/trunk/src/java/org/apache/commons/mail/ByteArrayDataSource.java?rev=225576&r1=225575&r2=225576&view=diff
==============================================================================
---
jakarta/commons/proper/email/trunk/src/java/org/apache/commons/mail/ByteArrayDataSource.java
(original)
+++
jakarta/commons/proper/email/trunk/src/java/org/apache/commons/mail/ByteArrayDataSource.java
Wed Jul 27 12:04:52 2005
@@ -56,6 +56,7 @@
* @param data A byte[].
* @param aType A String.
* @throws IOException IOException
+ * @since 1.0
*/
public ByteArrayDataSource(byte[] data, String aType) throws IOException
{
@@ -85,6 +86,7 @@
* @param aIs An InputStream.
* @param aType A String.
* @throws IOException IOException
+ * @since 1.0
*/
public ByteArrayDataSource(InputStream aIs, String aType) throws
IOException
{
@@ -97,6 +99,7 @@
* @param data A String.
* @param aType A String.
* @throws IOException IOException
+ * @since 1.0
*/
public ByteArrayDataSource(String data, String aType) throws IOException
{
@@ -186,6 +189,7 @@
* Get the content type.
*
* @return A String.
+ * @since 1.0
*/
public String getContentType()
{
@@ -197,6 +201,7 @@
*
* @return An InputStream.
* @throws IOException IOException
+ * @since 1.0
*/
public InputStream getInputStream() throws IOException
{
@@ -211,6 +216,7 @@
* Get the name.
*
* @return A String.
+ * @since 1.0
*/
public String getName()
{
@@ -221,6 +227,7 @@
* Get the OutputStream to write to
*
* @return An OutputStream
+ * @since 1.0
*/
public OutputStream getOutputStream()
{
Modified:
jakarta/commons/proper/email/trunk/src/java/org/apache/commons/mail/DefaultAuthenticator.java
URL:
http://svn.apache.org/viewcvs/jakarta/commons/proper/email/trunk/src/java/org/apache/commons/mail/DefaultAuthenticator.java?rev=225576&r1=225575&r2=225576&view=diff
==============================================================================
---
jakarta/commons/proper/email/trunk/src/java/org/apache/commons/mail/DefaultAuthenticator.java
(original)
+++
jakarta/commons/proper/email/trunk/src/java/org/apache/commons/mail/DefaultAuthenticator.java
Wed Jul 27 12:04:52 2005
@@ -36,6 +36,7 @@
*
* @param userName user name to use when authentication is requested
* @param password password to use when authentication is requested
+ * @since 1.0
*/
public DefaultAuthenticator(String userName, String password)
{
@@ -48,6 +49,7 @@
*
* @return A <code>PasswordAuthentication</code> object containing the
* login information.
+ * @since 1.0
*/
protected PasswordAuthentication getPasswordAuthentication()
{
Modified:
jakarta/commons/proper/email/trunk/src/java/org/apache/commons/mail/Email.java
URL:
http://svn.apache.org/viewcvs/jakarta/commons/proper/email/trunk/src/java/org/apache/commons/mail/Email.java?rev=225576&r1=225575&r2=225576&view=diff
==============================================================================
---
jakarta/commons/proper/email/trunk/src/java/org/apache/commons/mail/Email.java
(original)
+++
jakarta/commons/proper/email/trunk/src/java/org/apache/commons/mail/Email.java
Wed Jul 27 12:04:52 2005
@@ -197,6 +197,7 @@
* Setting to true will enable the display of debug information.
*
* @param d A boolean.
+ * @since 1.0
*/
public void setDebug(boolean d)
{
@@ -214,6 +215,7 @@
* @param password password for the SMTP server
* @see DefaultAuthenticator
* @see #setAuthenticator
+ * @since 1.0
*/
public void setAuthentication(String userName, String password)
{
@@ -230,6 +232,7 @@
*
* @param newAuthenticator the <code>Authenticator</code> object.
* @see Authenticator
+ * @since 1.0
*/
public void setAuthenticator(Authenticator newAuthenticator)
{
@@ -240,6 +243,7 @@
* Set the charset of the message.
*
* @param newCharset A String.
+ * @since 1.0
*/
public void setCharset(String newCharset)
{
@@ -250,6 +254,7 @@
* Set the emailBody to a MimeMultiPart
*
* @param aMimeMultipart aMimeMultipart
+ * @since 1.0
*/
public void setContent(MimeMultipart aMimeMultipart)
{
@@ -261,6 +266,7 @@
*
* @param aObject aObject
* @param aContentType aContentType
+ * @since 1.0
*/
public void setContent(Object aObject, String aContentType)
{
@@ -302,6 +308,7 @@
* Set the hostname of the outgoing mail server
*
* @param aHostName aHostName
+ * @since 1.0
*/
public void setHostName(String aHostName)
{
@@ -311,6 +318,7 @@
/**
* Set the port number of the outgoing mail server.
* @param aPortNumber aPortNumber
+ * @since 1.0
*/
public void setSmtpPort(int aPortNumber)
{
@@ -328,16 +336,19 @@
/**
* Supply a mail Session object to use
* @param aSession mail session to be used
+ * @since 1.0
*/
public void setMailSession(Session aSession)
{
this.session = aSession;
}
+
/**
* Initialise a mailsession object
*
* @return A Session.
* @throws EmailException thrown when host name was not set.
+ * @since 1.0
*/
protected Session getMailSession() throws EmailException
{
@@ -425,6 +436,7 @@
* @param email A String.
* @return An Email.
* @throws EmailException Indicates an invalid email address.
+ * @since 1.0
*/
public Email setFrom(String email)
throws EmailException
@@ -439,6 +451,7 @@
* @param name A String.
* @throws EmailException Indicates an invalid email address.
* @return An Email.
+ * @since 1.0
*/
public Email setFrom(String email, String name)
throws EmailException
@@ -454,6 +467,7 @@
* @param email A String.
* @throws EmailException Indicates an invalid email address.
* @return An Email.
+ * @since 1.0
*/
public Email addTo(String email)
throws EmailException
@@ -468,6 +482,7 @@
* @param name A String.
* @throws EmailException Indicates an invalid email address.
* @return An Email.
+ * @since 1.0
*/
public Email addTo(String email, String name)
throws EmailException
@@ -482,6 +497,7 @@
* @param aCollection collection of InternetAddress objects.
* @throws EmailException Indicates an invalid email address.
* @return An Email.
+ * @since 1.0
*/
public Email setTo(Collection aCollection) throws EmailException
{
@@ -500,6 +516,7 @@
* @param email A String.
* @return An Email.
* @throws EmailException Indicates an invalid email address.
+ * @since 1.0
*/
public Email addCc(String email)
throws EmailException
@@ -514,7 +531,7 @@
* @param name A String.
* @throws EmailException Indicates an invalid email address.
* @return An Email.
-
+ * @since 1.0
*/
public Email addCc(String email, String name)
throws EmailException
@@ -528,7 +545,8 @@
*
* @param aCollection collection of InternetAddress objects.
* @return An Email.
- * @throws EmailException Indicates an invalid email address.
+ * @throws EmailException Indicates an invalid email address
+ * @since 1.0.
*/
public Email setCc(Collection aCollection) throws EmailException
{
@@ -547,6 +565,7 @@
* @param email A String.
* @return An Email.
* @throws EmailException Indicates an invalid email address
+ * @since 1.0
*/
public Email addBcc(String email)
throws EmailException
@@ -561,6 +580,7 @@
* @param name A String.
* @return An Email.
* @throws EmailException Indicates an invalid email address
+ * @since 1.0
*/
public Email addBcc(String email, String name)
throws EmailException
@@ -575,6 +595,7 @@
* @param aCollection collection of InternetAddress objects
* @return An Email.
* @throws EmailException Indicates an invalid email address
+ * @since 1.0
*/
public Email setBcc(Collection aCollection) throws EmailException
{
@@ -593,6 +614,7 @@
* @param email A String.
* @return An Email.
* @throws EmailException Indicates an invalid email address
+ * @since 1.0
*/
public Email addReplyTo(String email)
throws EmailException
@@ -607,6 +629,7 @@
* @param name A String.
* @return An Email.
* @throws EmailException Indicates an invalid email address
+ * @since 1.0
*/
public Email addReplyTo(String email, String name)
throws EmailException
@@ -624,6 +647,7 @@
* Disposition-Notification-To: [EMAIL PROTECTED]
*
* @param map A Map.
+ * @since 1.0
*/
public void setHeaders(Map map)
{
@@ -653,6 +677,7 @@
*
* @param name A String with the name.
* @param value A String with the value.
+ * @since 1.0
*/
public void addHeader(String name, String value)
{
@@ -673,6 +698,7 @@
*
* @param aSubject A String.
* @return An Email.
+ * @since 1.0
*/
public Email setSubject(String aSubject)
{
@@ -688,6 +714,7 @@
*
* @param email A String.
* @return An Email.
+ * @since 1.0
*/
public Email setBounceAddress(String email)
{
@@ -703,6 +730,7 @@
* @param msg A String.
* @return An Email.
* @throws EmailException generic exception.
+ * @since 1.0
*/
public abstract Email setMsg(String msg) throws EmailException;
@@ -710,6 +738,7 @@
* Does the work of actually sending the email.
*
* @throws EmailException if there was an error.
+ * @since 1.0
*/
public void send() throws EmailException
{
@@ -824,6 +853,7 @@
* current date if not explictly set.
*
* @param date Date to use as the sent date on the email
+ * @since 1.0
*/
public void setSentDate(Date date)
{
@@ -834,6 +864,7 @@
* Gets the sent date for the email.
*
* @return date to be used as the sent date for the email
+ * @since 1.0
*/
public Date getSentDate()
{
@@ -850,6 +881,7 @@
*
* @param list A List.
* @return An InternetAddress[].
+ * @since 1.0
*/
protected InternetAddress[] toInternetAddressArray(List list)
{
@@ -867,6 +899,7 @@
* @param newPopHost The pop3 host to use.
* @param newPopUsername The pop3 username.
* @param newPopPassword The pop3 password.
+ * @since 1.0
*/
public void setPopBeforeSmtp(
boolean newPopBeforeSmtp,
Modified:
jakarta/commons/proper/email/trunk/src/java/org/apache/commons/mail/EmailAttachment.java
URL:
http://svn.apache.org/viewcvs/jakarta/commons/proper/email/trunk/src/java/org/apache/commons/mail/EmailAttachment.java?rev=225576&r1=225575&r2=225576&view=diff
==============================================================================
---
jakarta/commons/proper/email/trunk/src/java/org/apache/commons/mail/EmailAttachment.java
(original)
+++
jakarta/commons/proper/email/trunk/src/java/org/apache/commons/mail/EmailAttachment.java
Wed Jul 27 12:04:52 2005
@@ -50,6 +50,7 @@
* Get the description.
*
* @return A String.
+ * @since 1.0
*/
public String getDescription()
{
@@ -60,6 +61,7 @@
* Get the name.
*
* @return A String.
+ * @since 1.0
*/
public String getName()
{
@@ -70,6 +72,7 @@
* Get the path.
*
* @return A String.
+ * @since 1.0
*/
public String getPath()
{
@@ -80,6 +83,7 @@
* Get the URL.
*
* @return A URL.
+ * @since 1.0
*/
public URL getURL()
{
@@ -90,6 +94,7 @@
* Get the disposition.
*
* @return A String.
+ * @since 1.0
*/
public String getDisposition()
{
@@ -100,6 +105,7 @@
* Set the description.
*
* @param desc A String.
+ * @since 1.0
*/
public void setDescription(String desc)
{
@@ -110,6 +116,7 @@
* Set the name.
*
* @param aName A String.
+ * @since 1.0
*/
public void setName(String aName)
{
@@ -124,6 +131,7 @@
* Example: images/image.jpg
*
* @param aPath A String.
+ * @since 1.0
*/
public void setPath(String aPath)
{
@@ -134,6 +142,7 @@
* Set the URL.
*
* @param aUrl A URL.
+ * @since 1.0
*/
public void setURL(URL aUrl)
{
@@ -144,6 +153,7 @@
* Set the disposition.
*
* @param aDisposition A String.
+ * @since 1.0
*/
public void setDisposition(String aDisposition)
{
Modified:
jakarta/commons/proper/email/trunk/src/java/org/apache/commons/mail/EmailException.java
URL:
http://svn.apache.org/viewcvs/jakarta/commons/proper/email/trunk/src/java/org/apache/commons/mail/EmailException.java?rev=225576&r1=225575&r2=225576&view=diff
==============================================================================
---
jakarta/commons/proper/email/trunk/src/java/org/apache/commons/mail/EmailException.java
(original)
+++
jakarta/commons/proper/email/trunk/src/java/org/apache/commons/mail/EmailException.java
Wed Jul 27 12:04:52 2005
@@ -31,6 +31,7 @@
* Create a new EmailException with no message and no cause.
* Note: This constructor should only be used as a last resort. Please
* provide at least a message.
+ * @since 1.0
*/
public EmailException()
{
@@ -40,6 +41,7 @@
/**
* Create a new EmailException with a message but no other cause.
* @param msg the reason for this exception.
+ * @since 1.0
*/
public EmailException(String msg)
{
@@ -50,6 +52,7 @@
* Create a new EmailException with a message and a cause.
* @param msg the reason for this exception.
* @param cause the contributing Throwable (e.g. some other Exception)
+ * @since 1.0
*/
public EmailException(String msg, Throwable cause)
{
@@ -59,6 +62,7 @@
/**
* Create a new EmailException with a cause but no message.
* @param cause the contributing Throwable (e.g. some other Exception)
+ * @since 1.0
*/
public EmailException(Throwable cause)
{
Modified:
jakarta/commons/proper/email/trunk/src/java/org/apache/commons/mail/HtmlEmail.java
URL:
http://svn.apache.org/viewcvs/jakarta/commons/proper/email/trunk/src/java/org/apache/commons/mail/HtmlEmail.java?rev=225576&r1=225575&r2=225576&view=diff
==============================================================================
---
jakarta/commons/proper/email/trunk/src/java/org/apache/commons/mail/HtmlEmail.java
(original)
+++
jakarta/commons/proper/email/trunk/src/java/org/apache/commons/mail/HtmlEmail.java
Wed Jul 27 12:04:52 2005
@@ -80,6 +80,7 @@
* @return An HtmlEmail.
* @throws EmailException see javax.mail.internet.MimeBodyPart
* for defintions
+ * @since 1.0
*/
public HtmlEmail setTextMsg(String aText) throws EmailException
{
@@ -99,6 +100,7 @@
* @return An HtmlEmail.
* @throws EmailException see javax.mail.internet.MimeBodyPart
* for defintions
+ * @since 1.0
*/
public HtmlEmail setHtmlMsg(String aHtml) throws EmailException
{
@@ -124,6 +126,7 @@
* @return An Email.
* @throws EmailException see javax.mail.internet.MimeBodyPart
* for defintions
+ * @since 1.0
*/
public Email setMsg(String msg) throws EmailException
{
@@ -167,6 +170,7 @@
* @return A String with the Content-ID of the file.
* @throws EmailException when URL suplpied is invalid
* also see javax.mail.internet.MimeBodyPart for defintions
+ * @since 1.0
*/
public String embed(URL url, String name) throws EmailException
{
@@ -203,6 +207,7 @@
* Does the work of actually sending the email.
*
* @exception EmailException if there was an error.
+ * @since 1.0
*/
public void send() throws EmailException
{
Modified:
jakarta/commons/proper/email/trunk/src/java/org/apache/commons/mail/MultiPartEmail.java
URL:
http://svn.apache.org/viewcvs/jakarta/commons/proper/email/trunk/src/java/org/apache/commons/mail/MultiPartEmail.java?rev=225576&r1=225575&r2=225576&view=diff
==============================================================================
---
jakarta/commons/proper/email/trunk/src/java/org/apache/commons/mail/MultiPartEmail.java
(original)
+++
jakarta/commons/proper/email/trunk/src/java/org/apache/commons/mail/MultiPartEmail.java
Wed Jul 27 12:04:52 2005
@@ -68,6 +68,7 @@
* Set the MIME subtype of the email.
*
* @param aSubType MIME subtype of the email
+ * @since 1.0
*/
public void setSubType(String aSubType)
{
@@ -78,6 +79,7 @@
* Get the MIME subtype of the email.
*
* @return MIME subtype of the email
+ * @since 1.0
*/
public String getSubType()
{
@@ -92,6 +94,7 @@
* @return An Email.
* @throws EmailException see javax.mail.internet.MimeBodyPart
* for defintions
+ * @since 1.0
*/
public Email addPart(String partContent, String partContentType)
throws EmailException
@@ -116,7 +119,8 @@
* @param multipart The MimeMultipart.
* @return An Email.
* @throws EmailException see javax.mail.internet.MimeBodyPart
- * for defintions
+ * for definitions
+ * @since 1.0
*/
public Email addPart(MimeMultipart multipart) throws EmailException
{
@@ -137,6 +141,7 @@
* @param index The index to add at.
* @return The email.
* @throws EmailException An error occured while adding the part.
+ * @since 1.0
*/
public Email addPart(MimeMultipart multipart, int index) throws
EmailException
{
@@ -156,6 +161,7 @@
/**
* Initialize the multipart email.
+ * @since 1.0
*/
protected void init()
{
@@ -177,6 +183,7 @@
* @return An Email.
* @throws EmailException see javax.mail.internet.MimeBodyPart
* for defintions
+ * @since 1.0
*/
public Email setMsg(String msg) throws EmailException
{
@@ -208,6 +215,7 @@
*
* @throws EmailException see javax.mail.internet.MimeBodyPart
* for defintions
+ * @since 1.0
*/
public void send() throws EmailException
{
@@ -251,6 +259,7 @@
* @return A MultiPartEmail.
* @throws EmailException see javax.mail.internet.MimeBodyPart
* for defintions
+ * @since 1.0
*/
public MultiPartEmail attach(EmailAttachment attachment)
throws EmailException
@@ -313,6 +322,7 @@
* @return A MultiPartEmail.
* @throws EmailException see javax.mail.internet.MimeBodyPart
* for defintions
+ * @since 1.0
*/
public MultiPartEmail attach(URL url, String name, String description)
throws EmailException
@@ -330,6 +340,7 @@
* @return A MultiPartEmail.
* @throws EmailException see javax.mail.internet.MimeBodyPart
* for defintions
+ * @since 1.0
*/
public MultiPartEmail attach(
URL url,
@@ -361,6 +372,7 @@
* @return A MultiPartEmail.
* @throws EmailException see javax.mail.internet.MimeBodyPart
* for defintions
+ * @since 1.0
*/
public MultiPartEmail attach(
DataSource ds,
@@ -394,6 +406,7 @@
* @return A MultiPartEmail.
* @throws EmailException see javax.mail.internet.MimeBodyPart
* for defintions
+ * @since 1.0
*/
public MultiPartEmail attach(
DataSource ds,
@@ -430,6 +443,7 @@
*
* @return The primary body part.
* @throws MessagingException An error occured while getting the primary
body part.
+ * @since 1.0
*/
protected MimeBodyPart getPrimaryBodyPart() throws MessagingException
{
@@ -452,6 +466,7 @@
* Gets the message container.
*
* @return The message container.
+ * @since 1.0
*/
protected MimeMultipart getContainer()
{
@@ -465,6 +480,7 @@
/**
* @return boolHasAttachments
+ * @since 1.0
*/
public boolean isBoolHasAttachments()
{
@@ -473,6 +489,7 @@
/**
* @param b boolHasAttachments
+ * @since 1.0
*/
public void setBoolHasAttachments(boolean b)
{
Modified:
jakarta/commons/proper/email/trunk/src/java/org/apache/commons/mail/SimpleEmail.java
URL:
http://svn.apache.org/viewcvs/jakarta/commons/proper/email/trunk/src/java/org/apache/commons/mail/SimpleEmail.java?rev=225576&r1=225575&r2=225576&view=diff
==============================================================================
---
jakarta/commons/proper/email/trunk/src/java/org/apache/commons/mail/SimpleEmail.java
(original)
+++
jakarta/commons/proper/email/trunk/src/java/org/apache/commons/mail/SimpleEmail.java
Wed Jul 27 12:04:52 2005
@@ -39,6 +39,7 @@
* @return An Email.
* @throws EmailException see javax.mail.internet.MimeBodyPart
* for defintions
+ * @since 1.0
*/
public Email setMsg(String msg) throws EmailException
{
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
