✨ New factory functions with configurable regular expression for EmailAddress

[LVMVRQUXL]

📝 Description

We would like to introduce the following experimental factory functions with configurable regular expression for the EmailAddress type:

fun EmailAddress.Companion.create(
    text: String,
    configuration: EmailAddress.RegexConfiguration.() -> Unit
): EmailAddress

fun EmailAddress.Companion.createOrNull(
    text: String,
    configuration: EmailAddress.RegexConfiguration.() -> Unit
): EmailAddress?

interface EmailAddress.RegexConfiguration {
    var localPart: Regex
    var domain: Regex
}

Here's an example of calling the create(String, EmailAddress.RegexConfiguration.() -> Unit) function from Kotlin code:

val address: EmailAddress = EmailAddress.create("[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]

🔗 Dependencies

This issue is blocked by the following ones:

• ✨ New EmailAddress type #339
• ✨ EmailAddress syntax should follow RFC-5322 #394

✅ Checklist

• Add the create(String, EmailAddress.RegexConfiguration.() -> Unit) function, test its behavior with Kotlin and its compatibility with Java, update the public API binaries and update the unreleased changelog.
• Add the createOrNull(String, EmailAddress.RegexConfiguration.() -> Unit) function, test its behavior with Kotlin and its compatibility with Java, update the public API binaries and update the unreleased changelog.
• Close this issue as completed and update tracking ones if present.

[LVMVRQUXL]

The DSL for setting the domain property should always include the dot (.) between labels.

Here's an example for configuring the domain name's regular expression from Kotlin code:

EmailAddress.create("[email protected]") {
    domain {
        topLevel = Regex("[a-z]+")
        secondLevel = firstLabel
    }
}

[LVMVRQUXL]

We should take more time to design this solution according to the validation of the regular expression received from users.

[LVMVRQUXL]

Another implementation of the EmailAddress type will be available after resolving #635.