Forked from the original library (here) Updated dependencies:
- Added support to scala 2.13
- Scalatest 3.2.7
- pegdown 1.6.0
- scalaCheck 1.14.1
- added: org.scalatestplus-scalacheck
- Removed : Scala 2.11 and 2.12 ( because of libs incompatibilities )
- Removed : dependency to "SbtAutoBuildPlugin" (specific sbt template from https://dl.bintray.com/hmrc/sbt-plugin-releases)
Update: Forked a fork (here) and made the following changes
- Removed Bintray plugins
- Support for Scala 2.12 and 2.13
- Tests pass using both versions
Scala micro-library for typing, validating and obfuscating email addresses
The EmailAddress
class will only accept valid addresses:
scala> import uk.gov.hmrc.emailaddress._
import uk.gov.hmrc.emailaddress._
scala> EmailAddress("example@test.com")
res0: uk.gov.hmrc.emailaddress.EmailAddress = example@test.com
scala> EmailAddress("not_a_meaningful_address")
java.lang.IllegalArgumentException: requirement failed: 'not_a_meaningful_address' is not a valid email address
You can also use EmailAddress.isValid(...)
:
scala> EmailAddress.isValid("example@test.com")
res2: Boolean = true
scala> EmailAddress.isValid("not_a_meaningful_address")
res3: Boolean = false
You can access the mailbox and domain of a given address:
scala> EmailAddress("example@test.com").domain
res0: uk.gov.hmrc.emailaddress.EmailAddress.Domain = test.com
scala> EmailAddress("example@test.com").mailbox
res1: uk.gov.hmrc.emailaddress.EmailAddress.Mailbox = example
These compare equal as you might expect:
scala> EmailAddress("example@test.com").domain == EmailAddress("another@test.com").domain
res2: Boolean = true
scala> EmailAddress("example@test.com").domain == EmailAddress("another@test.co.uk").domain
res3: Boolean = false
Addresses are obfuscated by starring out all of their mailbox part, apart from the first and last letters:
scala> ObfuscatedEmailAddress("example@test.com")
res4: uk.gov.hmrc.emailaddress.ObfuscatedEmailAddress = e*****e@test.com
Unless there are only two letters:
scala> ObfuscatedEmailAddress("ex@test.com")
res7: uk.gov.hmrc.emailaddress.ObfuscatedEmailAddress = **@test.com```
You can also create them directly from an EmailAddress
:
scala> EmailAddress("example@test.com").obfuscated
res6: uk.gov.hmrc.emailaddress.ObfuscatedEmailAddress = e*****e@test.com
All classes toString
and implicitly convert to String
s nicely:
scala> val someString: String = EmailAddress("example@test.com")
someString: String = example@test.com
scala> val someString = EmailAddress("example@test.com").toString
someString: String = example@test.com
scala> val someString: String = ObfuscatedEmailAddress("example@test.com")
someString: String = e*****e@test.com
scala> val someString = ObfuscatedEmailAddress("example@test.com").toString
someString: String = e*****e@test.com
scala> EmailAddress("example@test.com").domain.toString
res4: String = test.com
scala> val s: String = EmailAddress("example@test.com").domain
s: String = test.com
scala> EmailAddress("example@test.com").mailbox.toString
res5: String = example
scala> val s: String = EmailAddress("example@test.com").mailbox
s: String = example
Include the following dependency in your SBT build
resolvers += s"castleone-github" at s"https://maven.pkg.github.com/CastleOne/emailaddress"
libraryDependencies += "castleone" %% "emailaddress" % "3.1.0"
This code is open source software licensed under the Apache 2.0 License.