Pencil

Overview

Pencil is a simple smtp client. The main goal is to be able to send emails in the simplest way.
It is build on top of cats, cats-effect, fs2, scodec

Pencil supports:

• Text email (ascii)
• Mime email
• TLS
• Authentication

Specifications

• RFC 5321 - Simple Mail Transfer Protocol
• Multipurpose Internet Mail Extensions
  • RFC 2045 - Part one - Format of Internet message bodies
  • RFC 2046 - Part two - Media Types
  • RFC 2047 - Part three - Message Header Extensions for Non-ASCII Text
  • RFC 2049 - Part five - Confirmance criteria and examples
  • RFC 4288 - Media Type Specifications and Registration Procedures
  • RFC 1521 - MIME Part one - Mechanisms for Specifying and Describing the Format of Internet Message Bodies
  • RFC 1522 - MIME Part two - Message Header Extensions for Non-ASCII Text
  • RFC 4954 - SMTP Service Extension for Authentication

Usage

Add dependency to your build.sbt

for scala 3

libraryDependencies += "com.minosiants" %% "pencil" % "2.0.0"

for scala 2.13

libraryDependencies += "com.minosiants" %% "pencil" % "1.2.0"

Examples how to use it

Create text email

val email = Email.text(
      from"user name <[email protected]>",
      to"[email protected]",
      subject"first email",
      Body.Ascii("hello")
)

Create mime email

val email = Email.mime(
     from"[email protected]",
     to"[email protected]",
     subject"привет",
     Body.Utf8("hi there")
) + attachment"path/to/file"

Create mime email

val email = Email.mime(
     from"[email protected]",
     to"[email protected]",
     subject"привет",
     Body.Alternative(List(Body.Utf8("hi there3"), Body.Ascii("hi there2")))
)

Send email

object Main extends IOApp {

  val logger    = Slf4jLogger.getLogger[IO]
  override def run(args: List[String]): IO[ExitCode] = {
    val credentials = Credentials(
      Username("[email protected]"),
      Password("password")
    )
    val action = for {
      tls <- Network[IO].tlsContext.system
      client = Client[IO](SocketAddress(host"localhost", port"25"), Some(credentials))(tls,logger)
      response <- client.send(email)
    }yield response

    action.attempt
            .map {
              case Right(replies) =>
                println(replies)
                ExitCode.Success
              case Left(error) =>
                error match {
                  case e: Error => println(e.toString)
                  case e: Throwable => println(e.getMessage)
                }
                ExitCode.Error
            }
  }
}

Docker Mailserver

For test purposes Docker Mailserver can be used