Skip to content

Commit 8fe5f03

Browse files
garydgregorygarydgregory
committed
Javadoc
1 parent 6077b2c commit 8fe5f03

3 files changed

Lines changed: 46 additions & 46 deletions

File tree

‎src/main/java/org/apache/commons/mail/ByteArrayDataSource.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535
* </p>
3636
*
3737
* @since 1.0
38-
* @deprecated since 1.4, use {@link javax.mail.util.ByteArrayDataSource} or {@link javax.mail.util.SharedByteArrayInputStream}.
38+
* @deprecated Since 1.4, use {@link javax.mail.util.ByteArrayDataSource} or {@link javax.mail.util.SharedByteArrayInputStream}.
3939
*/
4040
@Deprecated
4141
public class ByteArrayDataSource implements DataSource {

‎src/main/java/org/apache/commons/mail/Email.java‎

Lines changed: 35 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -57,119 +57,119 @@ public abstract class Email {
5757

5858
private static final InternetAddress[] EMPTY_INTERNET_ADDRESS_ARRAY = {};
5959

60-
/** @deprecated since 1.3, use {@link EmailConstants#SENDER_EMAIL} instead */
60+
/** @deprecated Since 1.3, use {@link EmailConstants#SENDER_EMAIL} instead */
6161
@Deprecated
6262
public static final String SENDER_EMAIL = EmailConstants.SENDER_EMAIL;
6363

64-
/** @deprecated since 1.3, use {@link EmailConstants#SENDER_NAME} instead */
64+
/** @deprecated Since 1.3, use {@link EmailConstants#SENDER_NAME} instead */
6565
@Deprecated
6666
public static final String SENDER_NAME = EmailConstants.SENDER_NAME;
6767

68-
/** @deprecated since 1.3, use {@link EmailConstants#RECEIVER_EMAIL} instead */
68+
/** @deprecated Since 1.3, use {@link EmailConstants#RECEIVER_EMAIL} instead */
6969
@Deprecated
7070
public static final String RECEIVER_EMAIL = EmailConstants.RECEIVER_EMAIL;
7171

72-
/** @deprecated since 1.3, use {@link EmailConstants#RECEIVER_NAME} instead */
72+
/** @deprecated Since 1.3, use {@link EmailConstants#RECEIVER_NAME} instead */
7373
@Deprecated
7474
public static final String RECEIVER_NAME = EmailConstants.RECEIVER_NAME;
7575

76-
/** @deprecated since 1.3, use {@link EmailConstants#EMAIL_SUBJECT} instead */
76+
/** @deprecated Since 1.3, use {@link EmailConstants#EMAIL_SUBJECT} instead */
7777
@Deprecated
7878
public static final String EMAIL_SUBJECT = EmailConstants.EMAIL_SUBJECT;
7979

80-
/** @deprecated since 1.3, use {@link EmailConstants#EMAIL_BODY} instead */
80+
/** @deprecated Since 1.3, use {@link EmailConstants#EMAIL_BODY} instead */
8181
@Deprecated
8282
public static final String EMAIL_BODY = EmailConstants.EMAIL_BODY;
8383

84-
/** @deprecated since 1.3, use {@link EmailConstants#CONTENT_TYPE} instead */
84+
/** @deprecated Since 1.3, use {@link EmailConstants#CONTENT_TYPE} instead */
8585
@Deprecated
8686
public static final String CONTENT_TYPE = EmailConstants.CONTENT_TYPE;
8787

88-
/** @deprecated since 1.3, use {@link EmailConstants#ATTACHMENTS} instead */
88+
/** @deprecated Since 1.3, use {@link EmailConstants#ATTACHMENTS} instead */
8989
@Deprecated
9090
public static final String ATTACHMENTS = EmailConstants.ATTACHMENTS;
9191

92-
/** @deprecated since 1.3, use {@link EmailConstants#FILE_SERVER} instead */
92+
/** @deprecated Since 1.3, use {@link EmailConstants#FILE_SERVER} instead */
9393
@Deprecated
9494
public static final String FILE_SERVER = EmailConstants.FILE_SERVER;
9595

96-
/** @deprecated since 1.3, use {@link EmailConstants#KOI8_R} instead */
96+
/** @deprecated Since 1.3, use {@link EmailConstants#KOI8_R} instead */
9797
@Deprecated
9898
public static final String KOI8_R = EmailConstants.KOI8_R;
9999

100-
/** @deprecated since 1.3, use {@link EmailConstants#ISO_8859_1} instead */
100+
/** @deprecated Since 1.3, use {@link EmailConstants#ISO_8859_1} instead */
101101
@Deprecated
102102
public static final String ISO_8859_1 = EmailConstants.ISO_8859_1;
103103

104-
/** @deprecated since 1.3, use {@link EmailConstants#US_ASCII} instead */
104+
/** @deprecated Since 1.3, use {@link EmailConstants#US_ASCII} instead */
105105
@Deprecated
106106
public static final String US_ASCII = EmailConstants.US_ASCII;
107107

108-
/** @deprecated since 1.3, use {@link EmailConstants#MAIL_DEBUG} instead */
108+
/** @deprecated Since 1.3, use {@link EmailConstants#MAIL_DEBUG} instead */
109109
@Deprecated
110110
public static final String MAIL_DEBUG = EmailConstants.MAIL_DEBUG;
111111

112-
/** @deprecated since 1.3, use {@link EmailConstants#MAIL_HOST} instead */
112+
/** @deprecated Since 1.3, use {@link EmailConstants#MAIL_HOST} instead */
113113
@Deprecated
114114
public static final String MAIL_HOST = EmailConstants.MAIL_HOST;
115115

116-
/** @deprecated since 1.3, use {@link EmailConstants#MAIL_PORT} instead */
116+
/** @deprecated Since 1.3, use {@link EmailConstants#MAIL_PORT} instead */
117117
@Deprecated
118118
public static final String MAIL_PORT = EmailConstants.MAIL_PORT;
119119

120-
/** @deprecated since 1.3, use {@link EmailConstants#MAIL_SMTP_FROM} instead */
120+
/** @deprecated Since 1.3, use {@link EmailConstants#MAIL_SMTP_FROM} instead */
121121
@Deprecated
122122
public static final String MAIL_SMTP_FROM = EmailConstants.MAIL_SMTP_FROM;
123123

124-
/** @deprecated since 1.3, use {@link EmailConstants#MAIL_SMTP_AUTH} instead */
124+
/** @deprecated Since 1.3, use {@link EmailConstants#MAIL_SMTP_AUTH} instead */
125125
@Deprecated
126126
public static final String MAIL_SMTP_AUTH = EmailConstants.MAIL_SMTP_AUTH;
127127

128-
/** @deprecated since 1.3, use {@link EmailConstants#MAIL_SMTP_USER} instead */
128+
/** @deprecated Since 1.3, use {@link EmailConstants#MAIL_SMTP_USER} instead */
129129
@Deprecated
130130
public static final String MAIL_SMTP_USER = EmailConstants.MAIL_SMTP_USER;
131131

132-
/** @deprecated since 1.3, use {@link EmailConstants#MAIL_SMTP_PASSWORD} instead */
132+
/** @deprecated Since 1.3, use {@link EmailConstants#MAIL_SMTP_PASSWORD} instead */
133133
@Deprecated
134134
public static final String MAIL_SMTP_PASSWORD = EmailConstants.MAIL_SMTP_PASSWORD;
135135

136-
/** @deprecated since 1.3, use {@link EmailConstants#MAIL_TRANSPORT_PROTOCOL} instead */
136+
/** @deprecated Since 1.3, use {@link EmailConstants#MAIL_TRANSPORT_PROTOCOL} instead */
137137
@Deprecated
138138
public static final String MAIL_TRANSPORT_PROTOCOL = EmailConstants.MAIL_TRANSPORT_PROTOCOL;
139139

140-
/** @deprecated since 1.3, use {@link EmailConstants#SMTP} instead */
140+
/** @deprecated Since 1.3, use {@link EmailConstants#SMTP} instead */
141141
@Deprecated
142142
public static final String SMTP = EmailConstants.SMTP;
143143

144-
/** @deprecated since 1.3, use {@link EmailConstants#TEXT_HTML} instead */
144+
/** @deprecated Since 1.3, use {@link EmailConstants#TEXT_HTML} instead */
145145
@Deprecated
146146
public static final String TEXT_HTML = EmailConstants.TEXT_HTML;
147147

148-
/** @deprecated since 1.3, use {@link EmailConstants#TEXT_PLAIN} instead */
148+
/** @deprecated Since 1.3, use {@link EmailConstants#TEXT_PLAIN} instead */
149149
@Deprecated
150150
public static final String TEXT_PLAIN = EmailConstants.TEXT_PLAIN;
151151

152-
/** @deprecated since 1.3, use {@link EmailConstants#MAIL_TRANSPORT_TLS} instead */
152+
/** @deprecated Since 1.3, use {@link EmailConstants#MAIL_TRANSPORT_TLS} instead */
153153
@Deprecated
154154
public static final String MAIL_TRANSPORT_TLS = EmailConstants.MAIL_TRANSPORT_TLS;
155155

156-
/** @deprecated since 1.3, use {@link EmailConstants#MAIL_SMTP_SOCKET_FACTORY_FALLBACK} instead */
156+
/** @deprecated Since 1.3, use {@link EmailConstants#MAIL_SMTP_SOCKET_FACTORY_FALLBACK} instead */
157157
@Deprecated
158158
public static final String MAIL_SMTP_SOCKET_FACTORY_FALLBACK = EmailConstants.MAIL_SMTP_SOCKET_FACTORY_FALLBACK;
159159

160-
/** @deprecated since 1.3, use {@link EmailConstants#MAIL_SMTP_SOCKET_FACTORY_CLASS} instead */
160+
/** @deprecated Since 1.3, use {@link EmailConstants#MAIL_SMTP_SOCKET_FACTORY_CLASS} instead */
161161
@Deprecated
162162
public static final String MAIL_SMTP_SOCKET_FACTORY_CLASS = EmailConstants.MAIL_SMTP_SOCKET_FACTORY_CLASS;
163163

164-
/** @deprecated since 1.3, use {@link EmailConstants#MAIL_SMTP_SOCKET_FACTORY_PORT} instead */
164+
/** @deprecated Since 1.3, use {@link EmailConstants#MAIL_SMTP_SOCKET_FACTORY_PORT} instead */
165165
@Deprecated
166166
public static final String MAIL_SMTP_SOCKET_FACTORY_PORT = EmailConstants.MAIL_SMTP_SOCKET_FACTORY_PORT;
167167

168-
/** @deprecated since 1.3, use {@link EmailConstants#MAIL_SMTP_CONNECTIONTIMEOUT} instead */
168+
/** @deprecated Since 1.3, use {@link EmailConstants#MAIL_SMTP_CONNECTIONTIMEOUT} instead */
169169
@Deprecated
170170
public static final String MAIL_SMTP_CONNECTIONTIMEOUT = EmailConstants.MAIL_SMTP_CONNECTIONTIMEOUT;
171171

172-
/** @deprecated since 1.3, use {@link EmailConstants#MAIL_SMTP_TIMEOUT} instead */
172+
/** @deprecated Since 1.3, use {@link EmailConstants#MAIL_SMTP_TIMEOUT} instead */
173173
@Deprecated
174174
public static final String MAIL_SMTP_TIMEOUT = EmailConstants.MAIL_SMTP_TIMEOUT;
175175

@@ -370,15 +370,15 @@ public Email() {
370370
/**
371371
* Does server require TLS encryption for authentication?
372372
*
373-
* @deprecated since 1.3, use setStartTLSEnabled() instead
373+
* @deprecated Since 1.3, use setStartTLSEnabled() instead
374374
*/
375375
@Deprecated
376376
protected boolean tls;
377377

378378
/**
379379
* Does the current transport use SSL/TLS encryption upon connection?
380380
*
381-
* @deprecated since 1.3, use setSSLOnConnect() instead
381+
* @deprecated Since 1.3, use setSSLOnConnect() instead
382382
*/
383383
@Deprecated
384384
protected boolean ssl;
@@ -1211,7 +1211,7 @@ public boolean isSendPartial() {
12111211
* Tests whether SSL/TLS encryption for the transport is currently enabled (SMTPS/POPS). See EMAIL-105 for reason of deprecation.
12121212
*
12131213
* @return true if SSL enabled for the transport.
1214-
* @deprecated since 1.3, use {@link #isSSLOnConnect()} instead.
1214+
* @deprecated Since 1.3, use {@link #isSSLOnConnect()} instead.
12151215
*/
12161216
@Deprecated
12171217
public boolean isSSL() {
@@ -1261,7 +1261,7 @@ public boolean isStartTLSRequired() {
12611261
/**
12621262
* Tests whether the client is configured to try to enable STARTTLS. See EMAIL-105 for reason of deprecation.
12631263
*
1264-
* @deprecated since 1.3, use {@link #isStartTLSEnabled()} instead.
1264+
* @deprecated Since 1.3, use {@link #isStartTLSEnabled()} instead.
12651265
* @return true if using STARTTLS for authentication, false otherwise.
12661266
* @since 1.1
12671267
*/
@@ -1803,7 +1803,7 @@ public void setSocketTimeout(final int socketTimeout) {
18031803
* Sets whether SSL/TLS encryption should be enabled for the SMTP transport upon connection (SMTPS/POPS). See EMAIL-105 for reason of deprecation.
18041804
*
18051805
* @param ssl whether to enable the SSL transport
1806-
* @deprecated since 1.3, use {@link #setSSLOnConnect(boolean)} instead.
1806+
* @deprecated Since 1.3, use {@link #setSSLOnConnect(boolean)} instead.
18071807
*/
18081808
@Deprecated
18091809
public void setSSL(final boolean ssl) {
@@ -1904,7 +1904,7 @@ public Email setSubject(final String aSubject) {
19041904
*
19051905
* @param withTLS true if STARTTLS requested, false otherwise
19061906
* @since 1.1
1907-
* @deprecated since 1.3, use {@link #setStartTLSEnabled(boolean)} instead.
1907+
* @deprecated Since 1.3, use {@link #setStartTLSEnabled(boolean)} instead.
19081908
*/
19091909
@Deprecated
19101910
public void setTLS(final boolean withTLS) {

‎src/main/java/org/apache/commons/mail/EmailConstants.java‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -29,39 +29,39 @@
2929
*/
3030
public final class EmailConstants {
3131

32-
/** @deprecated since 1.3, not in use since 1.0 */
32+
/** @deprecated Since 1.3, not in use since 1.0 */
3333
@Deprecated
3434
public static final String SENDER_EMAIL = "sender.email";
3535

36-
/** @deprecated since 1.3, not in use since 1.0 */
36+
/** @deprecated Since 1.3, not in use since 1.0 */
3737
@Deprecated
3838
public static final String SENDER_NAME = "sender.name";
3939

40-
/** @deprecated since 1.3, not in use since 1.0 */
40+
/** @deprecated Since 1.3, not in use since 1.0 */
4141
@Deprecated
4242
public static final String RECEIVER_EMAIL = "receiver.email";
4343

44-
/** @deprecated since 1.3, not in use since 1.0 */
44+
/** @deprecated Since 1.3, not in use since 1.0 */
4545
@Deprecated
4646
public static final String RECEIVER_NAME = "receiver.name";
4747

48-
/** @deprecated since 1.3, not in use since 1.0 */
48+
/** @deprecated Since 1.3, not in use since 1.0 */
4949
@Deprecated
5050
public static final String EMAIL_SUBJECT = "email.subject";
5151

52-
/** @deprecated since 1.3, not in use since 1.0 */
52+
/** @deprecated Since 1.3, not in use since 1.0 */
5353
@Deprecated
5454
public static final String EMAIL_BODY = "email.body";
5555

56-
/** @deprecated since 1.3, not in use since 1.0 */
56+
/** @deprecated Since 1.3, not in use since 1.0 */
5757
@Deprecated
5858
public static final String CONTENT_TYPE = "content.type";
5959

60-
/** @deprecated since 1.3, not in use since 1.0 */
60+
/** @deprecated Since 1.3, not in use since 1.0 */
6161
@Deprecated
6262
public static final String ATTACHMENTS = "attachments";
6363

64-
/** @deprecated since 1.3, not in use since 1.0 */
64+
/** @deprecated Since 1.3, not in use since 1.0 */
6565
@Deprecated
6666
public static final String FILE_SERVER = "file.server";
6767

@@ -119,7 +119,7 @@ public final class EmailConstants {
119119
// since 1.1
120120
/////////////////////////////////////////////////////////////////////////
121121

122-
/** @deprecated since 1.3 */
122+
/** @deprecated Since 1.3 */
123123
@Deprecated
124124
public static final String MAIL_TRANSPORT_TLS = "mail.smtp.starttls.enable";
125125

0 commit comments

Comments
 (0)
⚡