JAMES-2132 Reference in MDN data-model class relevant portions of RFC-8098
Project: http://git-wip-us.apache.org/repos/asf/james-project/repo Commit: http://git-wip-us.apache.org/repos/asf/james-project/commit/879fe839 Tree: http://git-wip-us.apache.org/repos/asf/james-project/tree/879fe839 Diff: http://git-wip-us.apache.org/repos/asf/james-project/diff/879fe839 Branch: refs/heads/master Commit: 879fe8395e46585e7c49f8e0b013bdc3dad492f5 Parents: 6643ef2 Author: benwa <btell...@linagora.com> Authored: Mon Aug 28 21:17:03 2017 +0700 Committer: benwa <btell...@linagora.com> Committed: Fri Sep 1 08:14:47 2017 +0700 ---------------------------------------------------------------------- .../org/apache/james/mdn/action/mode/DispositionActionMode.java | 4 +++- mdn/src/main/java/org/apache/james/mdn/fields/Disposition.java | 3 +++ mdn/src/main/java/org/apache/james/mdn/fields/Error.java | 5 +++++ .../main/java/org/apache/james/mdn/fields/ExtensionField.java | 5 +++++ mdn/src/main/java/org/apache/james/mdn/fields/Field.java | 5 +++++ .../main/java/org/apache/james/mdn/fields/FinalRecipient.java | 5 +++++ .../java/org/apache/james/mdn/fields/OriginalMessageId.java | 5 +++++ .../java/org/apache/james/mdn/fields/OriginalRecipient.java | 5 +++++ .../java/org/apache/james/mdn/fields/ReportingUserAgent.java | 5 +++++ .../java/org/apache/james/mdn/modifier/DispositionModifier.java | 4 +++- .../apache/james/mdn/sending/mode/DispositionSendingMode.java | 4 +++- .../main/java/org/apache/james/mdn/type/DispositionType.java | 4 +++- 12 files changed, 50 insertions(+), 4 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/james-project/blob/879fe839/mdn/src/main/java/org/apache/james/mdn/action/mode/DispositionActionMode.java ---------------------------------------------------------------------- diff --git a/mdn/src/main/java/org/apache/james/mdn/action/mode/DispositionActionMode.java b/mdn/src/main/java/org/apache/james/mdn/action/mode/DispositionActionMode.java index 6becee0..4c41cc6 100644 --- a/mdn/src/main/java/org/apache/james/mdn/action/mode/DispositionActionMode.java +++ b/mdn/src/main/java/org/apache/james/mdn/action/mode/DispositionActionMode.java @@ -24,7 +24,9 @@ import java.util.stream.Stream; /** * Interface <code>DispositionActionMode</code> marks a type encapsulating - * disposition action mode information as defined by RFC 2298. + * disposition action mode information as defined by RFC 8098. + * + * More information https://tools.ietf.org/html/rfc8098#section-3.2.6.1 */ public enum DispositionActionMode { Manual("manual-action"), http://git-wip-us.apache.org/repos/asf/james-project/blob/879fe839/mdn/src/main/java/org/apache/james/mdn/fields/Disposition.java ---------------------------------------------------------------------- diff --git a/mdn/src/main/java/org/apache/james/mdn/fields/Disposition.java b/mdn/src/main/java/org/apache/james/mdn/fields/Disposition.java index 742893c..157b4b7 100644 --- a/mdn/src/main/java/org/apache/james/mdn/fields/Disposition.java +++ b/mdn/src/main/java/org/apache/james/mdn/fields/Disposition.java @@ -31,6 +31,9 @@ import org.apache.james.mdn.type.DispositionType; import com.google.common.base.Preconditions; import com.google.common.collect.ImmutableList; +/** + * Implements disposition as stated in https://tools.ietf.org/html/rfc8098#section-3.2.6 + */ public class Disposition implements Field { public static final String FIELD_NAME = "Disposition"; http://git-wip-us.apache.org/repos/asf/james-project/blob/879fe839/mdn/src/main/java/org/apache/james/mdn/fields/Error.java ---------------------------------------------------------------------- diff --git a/mdn/src/main/java/org/apache/james/mdn/fields/Error.java b/mdn/src/main/java/org/apache/james/mdn/fields/Error.java index 8a68299..64dface 100644 --- a/mdn/src/main/java/org/apache/james/mdn/fields/Error.java +++ b/mdn/src/main/java/org/apache/james/mdn/fields/Error.java @@ -19,6 +19,11 @@ package org.apache.james.mdn.fields; +/** + * Implements the optional MDN Error field defined in RFC-8098 + * + * https://tools.ietf.org/html/rfc8098#section-3.2.7 + */ public class Error implements Field { public static final String FIELD_NAME = "Error"; http://git-wip-us.apache.org/repos/asf/james-project/blob/879fe839/mdn/src/main/java/org/apache/james/mdn/fields/ExtensionField.java ---------------------------------------------------------------------- diff --git a/mdn/src/main/java/org/apache/james/mdn/fields/ExtensionField.java b/mdn/src/main/java/org/apache/james/mdn/fields/ExtensionField.java index 65d9e84..9b6e6bc 100644 --- a/mdn/src/main/java/org/apache/james/mdn/fields/ExtensionField.java +++ b/mdn/src/main/java/org/apache/james/mdn/fields/ExtensionField.java @@ -19,6 +19,11 @@ package org.apache.james.mdn.fields; +/** + * Implements extension fields allowed by RFC-8098 + * + * https://tools.ietf.org/html/rfc8098#section-3.3 + */ public class ExtensionField implements Field { private final String fieldName; private final String rawValue; http://git-wip-us.apache.org/repos/asf/james-project/blob/879fe839/mdn/src/main/java/org/apache/james/mdn/fields/Field.java ---------------------------------------------------------------------- diff --git a/mdn/src/main/java/org/apache/james/mdn/fields/Field.java b/mdn/src/main/java/org/apache/james/mdn/fields/Field.java index bef0139..3875cd3 100644 --- a/mdn/src/main/java/org/apache/james/mdn/fields/Field.java +++ b/mdn/src/main/java/org/apache/james/mdn/fields/Field.java @@ -19,6 +19,11 @@ package org.apache.james.mdn.fields; +/** + * Interface that defines fields as stated in RFC-8098 + * + * https://tools.ietf.org/html/rfc8098#section-3.1 + */ public interface Field { String formattedValue(); } http://git-wip-us.apache.org/repos/asf/james-project/blob/879fe839/mdn/src/main/java/org/apache/james/mdn/fields/FinalRecipient.java ---------------------------------------------------------------------- diff --git a/mdn/src/main/java/org/apache/james/mdn/fields/FinalRecipient.java b/mdn/src/main/java/org/apache/james/mdn/fields/FinalRecipient.java index d8ce484..b613747 100644 --- a/mdn/src/main/java/org/apache/james/mdn/fields/FinalRecipient.java +++ b/mdn/src/main/java/org/apache/james/mdn/fields/FinalRecipient.java @@ -23,6 +23,11 @@ import org.apache.james.mdn.Constants; import com.google.common.base.Preconditions; +/** + * Implements mandatory Final recipient field + * + * https://tools.ietf.org/html/rfc8098#section-3.2.4 + */ public class FinalRecipient implements Field { public static final String FIELD_NAME = "Final-Recipient"; http://git-wip-us.apache.org/repos/asf/james-project/blob/879fe839/mdn/src/main/java/org/apache/james/mdn/fields/OriginalMessageId.java ---------------------------------------------------------------------- diff --git a/mdn/src/main/java/org/apache/james/mdn/fields/OriginalMessageId.java b/mdn/src/main/java/org/apache/james/mdn/fields/OriginalMessageId.java index 220a905..96a1245 100644 --- a/mdn/src/main/java/org/apache/james/mdn/fields/OriginalMessageId.java +++ b/mdn/src/main/java/org/apache/james/mdn/fields/OriginalMessageId.java @@ -19,6 +19,11 @@ package org.apache.james.mdn.fields; +/** + * Optional Original-MessageâId as defined in RFC-8098 + * + * https://tools.ietf.org/html/rfc8098#section-3.2.5 + */ public class OriginalMessageId implements Field { private static final String FIELD_NAME = "Original-Message-ID"; private final String originalMessageId; http://git-wip-us.apache.org/repos/asf/james-project/blob/879fe839/mdn/src/main/java/org/apache/james/mdn/fields/OriginalRecipient.java ---------------------------------------------------------------------- diff --git a/mdn/src/main/java/org/apache/james/mdn/fields/OriginalRecipient.java b/mdn/src/main/java/org/apache/james/mdn/fields/OriginalRecipient.java index 9c53e7e..ccb69c2 100644 --- a/mdn/src/main/java/org/apache/james/mdn/fields/OriginalRecipient.java +++ b/mdn/src/main/java/org/apache/james/mdn/fields/OriginalRecipient.java @@ -23,6 +23,11 @@ import org.apache.james.mdn.Constants; import com.google.common.base.Preconditions; +/** + * Implements optional Original-Recipient field defined in: + * + * https://tools.ietf.org/html/rfc8098#section-3.2.3 + */ public class OriginalRecipient implements Field{ private static final String UNKNOWN = "unknown"; private static final String FIELD_NAME = "Original-Recipient"; http://git-wip-us.apache.org/repos/asf/james-project/blob/879fe839/mdn/src/main/java/org/apache/james/mdn/fields/ReportingUserAgent.java ---------------------------------------------------------------------- diff --git a/mdn/src/main/java/org/apache/james/mdn/fields/ReportingUserAgent.java b/mdn/src/main/java/org/apache/james/mdn/fields/ReportingUserAgent.java index 492e56d..663a27a 100644 --- a/mdn/src/main/java/org/apache/james/mdn/fields/ReportingUserAgent.java +++ b/mdn/src/main/java/org/apache/james/mdn/fields/ReportingUserAgent.java @@ -23,6 +23,11 @@ import java.util.Optional; import com.google.common.base.Preconditions; +/** + * Implements optional Reporting-UA header field + * + * https://tools.ietf.org/html/rfc8098#section-3.2.1 + */ public class ReportingUserAgent implements Field { private static final String FIELD_NAME = "Reporting-UA"; private final String userAgentName; http://git-wip-us.apache.org/repos/asf/james-project/blob/879fe839/mdn/src/main/java/org/apache/james/mdn/modifier/DispositionModifier.java ---------------------------------------------------------------------- diff --git a/mdn/src/main/java/org/apache/james/mdn/modifier/DispositionModifier.java b/mdn/src/main/java/org/apache/james/mdn/modifier/DispositionModifier.java index ac4ba63..f4a2b70 100644 --- a/mdn/src/main/java/org/apache/james/mdn/modifier/DispositionModifier.java +++ b/mdn/src/main/java/org/apache/james/mdn/modifier/DispositionModifier.java @@ -21,7 +21,9 @@ package org.apache.james.mdn.modifier; /** * Interface <code>DispositionModifier</code> marks a type encapsulating - * disposition modifier information as defined by RFC 2298. + * disposition modifier information as defined by RFC 8098. + * + * https://tools.ietf.org/html/rfc8098#section-3.2.6.3 */ public class DispositionModifier { public static DispositionModifier Error = new DispositionModifier("error"); http://git-wip-us.apache.org/repos/asf/james-project/blob/879fe839/mdn/src/main/java/org/apache/james/mdn/sending/mode/DispositionSendingMode.java ---------------------------------------------------------------------- diff --git a/mdn/src/main/java/org/apache/james/mdn/sending/mode/DispositionSendingMode.java b/mdn/src/main/java/org/apache/james/mdn/sending/mode/DispositionSendingMode.java index 99e63c1..d3c3556 100644 --- a/mdn/src/main/java/org/apache/james/mdn/sending/mode/DispositionSendingMode.java +++ b/mdn/src/main/java/org/apache/james/mdn/sending/mode/DispositionSendingMode.java @@ -24,7 +24,9 @@ import java.util.stream.Stream; /** * Interface <code>DispositionSendingMode</code> marks a type encapsulating - * disposition sending mode information as defined by RFC 2298. + * disposition sending mode information as defined by RFC 8098. + * + * More information: https://tools.ietf.org/html/rfc8098#section-3.2.6.1 */ public enum DispositionSendingMode { Manual("MDN-sent-manually"), http://git-wip-us.apache.org/repos/asf/james-project/blob/879fe839/mdn/src/main/java/org/apache/james/mdn/type/DispositionType.java ---------------------------------------------------------------------- diff --git a/mdn/src/main/java/org/apache/james/mdn/type/DispositionType.java b/mdn/src/main/java/org/apache/james/mdn/type/DispositionType.java index a70bdd1..e548e35 100644 --- a/mdn/src/main/java/org/apache/james/mdn/type/DispositionType.java +++ b/mdn/src/main/java/org/apache/james/mdn/type/DispositionType.java @@ -24,7 +24,9 @@ import java.util.stream.Stream; /** * Interface <code>DispositionType</code> marks a type encapsulating - * disposition type information as defined by RFC 2298. + * disposition type information as defined by RFC 8098. + * + * https://tools.ietf.org/html/rfc8098#section-3.2.6.2 */ public enum DispositionType { Deleted("deleted"), --------------------------------------------------------------------- To unsubscribe, e-mail: server-dev-unsubscr...@james.apache.org For additional commands, e-mail: server-dev-h...@james.apache.org