You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sling.apache.org by ol...@apache.org on 2021/08/12 20:58:52 UTC
[sling-org-apache-sling-commons-messaging-mail] 03/06: add javadoc
for implementation
This is an automated email from the ASF dual-hosted git repository.
olli pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/sling-org-apache-sling-commons-messaging-mail.git
commit 846c3d38c213bc9b2aadd818b18b63da1c76854d
Author: Oliver Lietz <ol...@apache.org>
AuthorDate: Thu Jul 29 14:29:05 2021 +0200
add javadoc for implementation
---
checkstyle-suppressions.xml | 1 -
pom.xml | 1 +
.../sling/commons/messaging/mail/internal/SimpleMailService.java | 5 +++++
.../sling/commons/messaging/mail/internal/SimpleMessageBuilder.java | 5 +++++
.../commons/messaging/mail/internal/SimpleMessageIdProvider.java | 5 +++++
5 files changed, 16 insertions(+), 1 deletion(-)
diff --git a/checkstyle-suppressions.xml b/checkstyle-suppressions.xml
index 76f9991..26fb38c 100644
--- a/checkstyle-suppressions.xml
+++ b/checkstyle-suppressions.xml
@@ -19,7 +19,6 @@
-->
<!DOCTYPE suppressions PUBLIC "-//Checkstyle//DTD SuppressionFilter Configuration 1.2//EN" "https://checkstyle.org/dtds/suppressions_1_2.dtd">
<suppressions>
- <suppress checks="MissingJavadocType" files=".*\/internal\/.*\.java"/>
<suppress checks="MissingJavadocMethod" files=".*\/internal\/.*\.java"/>
<suppress checks="ClassFanOutComplexity" files=".*\/SimpleMailService\.java"/>
<suppress checks="ClassFanOutComplexity" files=".*\/SimpleMessageBuilder\.java"/>
diff --git a/pom.xml b/pom.xml
index c84360c..b408660 100644
--- a/pom.xml
+++ b/pom.xml
@@ -36,6 +36,7 @@
<properties>
<sling.java.version>11</sling.java.version>
+ <javadoc.excludePackageNames/>
<org.ops4j.pax.exam.version>4.13.3</org.ops4j.pax.exam.version>
</properties>
diff --git a/src/main/java/org/apache/sling/commons/messaging/mail/internal/SimpleMailService.java b/src/main/java/org/apache/sling/commons/messaging/mail/internal/SimpleMailService.java
index c599e36..6822c6e 100644
--- a/src/main/java/org/apache/sling/commons/messaging/mail/internal/SimpleMailService.java
+++ b/src/main/java/org/apache/sling/commons/messaging/mail/internal/SimpleMailService.java
@@ -52,6 +52,11 @@ import org.osgi.service.metatype.annotations.Designate;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
+/**
+ * Service for sending MIME messages (mails) via <code>SMTPS</code> protocol.
+ *
+ * @see MimeMessage
+ */
@Component(
service = {
MessageService.class,
diff --git a/src/main/java/org/apache/sling/commons/messaging/mail/internal/SimpleMessageBuilder.java b/src/main/java/org/apache/sling/commons/messaging/mail/internal/SimpleMessageBuilder.java
index 1ce59b4..1f9a679 100644
--- a/src/main/java/org/apache/sling/commons/messaging/mail/internal/SimpleMessageBuilder.java
+++ b/src/main/java/org/apache/sling/commons/messaging/mail/internal/SimpleMessageBuilder.java
@@ -47,6 +47,11 @@ import org.apache.sling.commons.messaging.mail.MessageBuilder;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
+/**
+ * Builder for MIME messages.<br>The message builder is using the {@link Session} form {@link SimpleMailService} and the standard charset <code>UTF-8</code>.
+ *
+ * @see MimeMessage
+ */
public final class SimpleMessageBuilder implements MessageBuilder {
private static final String CONTENT_TYPE_TEXT_HTML = "text/html; charset=utf-8";
diff --git a/src/main/java/org/apache/sling/commons/messaging/mail/internal/SimpleMessageIdProvider.java b/src/main/java/org/apache/sling/commons/messaging/mail/internal/SimpleMessageIdProvider.java
index 23bb2f8..f2b5dda 100644
--- a/src/main/java/org/apache/sling/commons/messaging/mail/internal/SimpleMessageIdProvider.java
+++ b/src/main/java/org/apache/sling/commons/messaging/mail/internal/SimpleMessageIdProvider.java
@@ -35,6 +35,11 @@ import org.osgi.service.metatype.annotations.Designate;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
+/**
+ * Provider for message identifiers.<br>Creates a <code>Message-ID</code> in form of <code><UUID>.<current time in milliseconds>@<host></code> where <code>host</code> is configurable.
+ *
+ * @see MimeMessage
+ */
@Component(
property = {
Constants.SERVICE_DESCRIPTION + "=Apache Sling Commons Messaging Mail – Simple Message ID Provider",