Roadmap of the type EmailAddress

[LVMVRQUXL]

Here's a curated list of tasks, associated with their first releasable version, for introducing the type EmailAddress, suggested by @MichaelStH in #55.

Planned

• Version 4.4.0: ✨ New EmailAddress type #339
• Version 4.4.1: Making declarations of EmailAddress available on Java #356
• Version 4.5.0: Stabilizing the type EmailAddress

Unplanned

• New EmailAddress.length property #357
• Making the property EmailAddress.length available on Java (releasable in version 5.0.0 after making StrictlyPositiveInt available on Java).
• Stabilizing the property EmailAddress.length.
• New EmailAddress.domain property #358.
• Making the property EmailAddress.domain available on Java.
• Stabilizing the property EmailAddress.domain.
• New EmailAddress.toNotBlankString() function #359.
• Making the function EmailAddress.toNotBlankString() available on Java (releasable in version 5.0.0 after making NotBlankString available on Java).
• Stabilizing the function EmailAddress.toNotBlankString().

[LVMVRQUXL]

The minimum viable API of EmailAddress will be introduced by the issue #339.
Also, the issue #356 will make this API available for Java users.

[LVMVRQUXL]

Local-part property

It could be interesting to introduce a property localPart: EmailAddress.LocalPart to the type EmailAddress for returning the local part of this email address.

Here's an example of calling this property from Kotlin code:

val address: EmailAddress = requireNotNull(EmailAddress from "[email protected]")
println(address.localPart) // contact

[LVMVRQUXL]

Factory function with customizable regular expression

Originally commented here: #339 (comment).

For creating an EmailAddress, it could be interesting to provide a from overload function accepting a regular expression configurable by the caller.

Here's an example of calling the overload from Kotlin code:

val address: EmailAddress? = EmailAddress.createOrNull("[email protected]") {
    localPart = Regex("[a-z]+") // the local part now only accepts 1 or more lowercase letters
    domain = Regex("[a-z]+\.[a-z]+") // the domain now only accepts lowercase letters
    // The regular expression used for validating the text input now looks like this: ^[a-z]+@[a-z]+\.[a-z]+$
}
println(address) // [email protected]

[LVMVRQUXL]

Issues attached to #339 should be considered as the EmailAddress type's roadmap.