SAK-45959 EmailService @deprecated javadoc "use .." (sakaiproject#9536)

brdebr · Aug 11, 2021 · 6d4ab69 · 6d4ab69
1 parent 54e1b20
commit 6d4ab69
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 25 deletions.
diff --git a/kernel/api/src/main/java/org/sakaiproject/email/api/EmailService.java b/kernel/api/src/main/java/org/sakaiproject/email/api/EmailService.java
@@ -28,7 +28,6 @@
 import javax.mail.MessagingException;
 import javax.mail.internet.InternetAddress;
 
-import org.sakaiproject.email.api.AttachmentSizeException;
 import org.sakaiproject.email.api.EmailAddress.RecipientType;
 import org.sakaiproject.user.api.User;
 
@@ -133,7 +132,6 @@ void send(String fromStr, String toStr, String subject, String content, String h
 	/**
 	 * Sends a single message to a set of users.
 	 * 
-	 * @deprecated
 	 * @param message
 	 *            {@link EmailMessage} that contains the parameters to create a message to the
 	 *            specified recipients.
@@ -144,6 +142,7 @@ void send(String fromStr, String toStr, String subject, String content, String h
 	 * @throws NoRecipientsException
 	 * @return {@link java.util.List} of recipients that were found to be invalid per to
 	 *         {@link javax.mail.internet.InternetAddress}.
+	 * @deprecated use {@link #send(EmailMessage, true)}
 	 */
 	List<EmailAddress> send(EmailMessage message) throws AddressValidationException,
 			NoRecipientsException;

diff --git a/kernel/kernel-impl/src/main/java/org/sakaiproject/email/impl/BasicEmailService.java b/kernel/kernel-impl/src/main/java/org/sakaiproject/email/impl/BasicEmailService.java
@@ -275,9 +275,7 @@ public void destroy()
 	 * Work interface methods: org.sakai.service.email.EmailService
 	 *********************************************************************************************************************************************************************************************************************************************************/
 
-	/**
-	 * {@inheritDoc}
-	 */
+	@Override
 	public void sendMail(InternetAddress from, InternetAddress[] to, String subject, String content, InternetAddress[] headerTo,
 			InternetAddress[] replyTo, List<String> additionalHeaders)
 	{
@@ -290,9 +288,7 @@ public void sendMail(InternetAddress from, InternetAddress[] to, String subject,
 		sendMail(from, to, subject, content, recipients, replyTo, additionalHeaders, null);
 	}
 
-	/**
-	 * {@inheritDoc}
-	 */
+	@Override
 	public void sendMail(InternetAddress from, InternetAddress[] to, String subject, String content,
 			Map<RecipientType, InternetAddress[]> headerTo, InternetAddress[] replyTo,
 			List<String> additionalHeaders, List<Attachment> attachments) {
@@ -304,6 +300,7 @@ public void sendMail(InternetAddress from, InternetAddress[] to, String subject,
 		}
 	}
 
+
 	public void sendMailMessagingException(InternetAddress from, InternetAddress[] to, String subject, String content,
 			Map<RecipientType, InternetAddress[]> headerTo, InternetAddress[] replyTo,
 			List<String> additionalHeaders, List<Attachment> attachments) throws AttachmentSizeException, MessagingException {
@@ -578,9 +575,7 @@ private void checkFrom(MimeMessage msg) {
 	    }
 	}
 
-	/**
-	 * {@inheritDoc}
-	 */
+	@Override
 	public void send(String fromStr, String toStr, String subject, String content, String headerToStr, String replyToStr,
 			List<String> additionalHeaders)
 	{
@@ -636,9 +631,7 @@ public void send(String fromStr, String toStr, String subject, String content, S
 		}
 	}
 
-	/**
-	 * {@inheritDoc}
-	 */
+	@Override
 	public void sendToUsers(Collection<User> users, Collection<String> headers, String message)
 	{
 		if (headers == null)
@@ -887,12 +880,7 @@ private Properties createMailSessionProperties()
 		return props;
 	}
 
-	/**
-	 * {@inheritDoc}
-	 * 
-	 * @see org.sakaiproject.email.api.EmailService#send(EmailMessage)
-	 * For temporary backward compatibility
-	 */
+	@Override
 	public List<EmailAddress> send(EmailMessage msg) throws AddressValidationException, NoRecipientsException {
 
 		List<EmailAddress> addresses = new ArrayList<>();
@@ -903,11 +891,8 @@ public List<EmailAddress> send(EmailMessage msg) throws AddressValidationExcepti
 		}
 		return addresses;
 	}
-	/**
-	 * {@inheritDoc}
-	 * 
-	 * @see org.sakaiproject.email.api.EmailService#send(EmailMessage)
-	 */
+
+	@Override
 	public List<EmailAddress> send(EmailMessage msg, boolean messagingException) throws AddressValidationException,
 			AttachmentSizeException, NoRecipientsException, MessagingException
 	{