emil

package emil

Type members

Classlikes

trait Access[F[_], C]
final case
class Attachment[F[_]](filename: Option[String], mimeType: MimeType, content: Stream[F, Byte], length: F[Long])
Companion
object
object Attachment
Companion
class
final case
class Attachments[F[_]](all: Vector[Attachment[F]])
Companion
object
Companion
class
sealed

Content part of the mail body.

Content part of the mail body.

The mail body may be alternative content of text/plain, text/html or both. A body content may be specified by a String or a byte-array + charset. For encoding body contents from a string, the UTF-8 encoding is used.

The byte-array variant is then needed, if a mail is decoded from a mime-representation. A content part may use different character encodings and a html part may specify this encoding in its content, too. Thus it sometimes is necessary to get to the same bytes as in the original mail.

Companion
object
Companion
class
case
object BuildInfo

This object was generated by sbt-buildinfo.

This object was generated by sbt-buildinfo.

This trait is meant to be implemented by a concrete connection implementation.

This trait is meant to be implemented by a concrete connection implementation.

User code can define type bounds on their mail operations in order to access the MailConfig currently in use.

case
class DeleteResult(count: Int)
trait Emil[F[_]]
Companion
object
object Emil
Companion
class
sealed
trait Flag
Companion
object
object Flag
Companion
class
final case
class Header(name: String, value: NonEmptyList[String])
Companion
object
object Header
Companion
class
final case
class Headers(all: List[Header])
Companion
object
object Headers
Companion
class
final case
class Mail[F[_]](header: MailHeader, additionalHeaders: Headers, body: MailBody[F], attachments: Attachments[F])
Companion
object
object Mail
Companion
class
final case
Companion
object
Companion
class
sealed
trait MailBody[F[_]]
Companion
object
object MailBody
Companion
class
final case
class MailConfig(url: String, user: String, password: String, sslType: SSLType, enableXOAuth2: Boolean, disableCertificateCheck: Boolean, timeout: Duration)
Companion
object
object MailConfig
Companion
class
final case
class MailFolder(id: String, path: NonEmptyList[String])

Structure representing one mailbox (= folder).

Structure representing one mailbox (= folder).

Value Params
id

Absolute path of the MailFolder

path

Path segments of the MailFolder, the last segment resembles the folder's name

Companion
object
object MailFolder
Companion
class
final case
class MailHeader(id: String, messageId: Option[String], folder: Option[MailFolder], recipients: Recipients, sender: Option[MailAddress], from: Option[MailAddress], replyTo: Option[MailAddress], originationDate: Option[Instant], subject: String, received: List[Received], flags: Set[Flag])
Companion
object
object MailHeader
Companion
class
final case
class MimeType(primary: String, sub: String, params: Map[String, String])
Companion
object
object MimeType
Companion
class
trait Ops
final case
class Received(data: Vector[(String, String)], date: Instant)

Received header as described in RCF2822.

Received header as described in RCF2822.

https://tools.ietf.org/html/rfc2822

Companion
object
object Received
Companion
class
final case
class Recipients(to: List[MailAddress], cc: List[MailAddress], bcc: List[MailAddress])
Companion
object
object Recipients
Companion
class
sealed
trait SSLType
Companion
object
object SSLType
Companion
class
sealed
Companion
object
Companion
class
final case
class SearchResult[A](mails: Vector[A], count: Int)
Companion
object
trait Send[F[_], C]

Inherited classlikes

object MailOp
Inherited from
Ops

Inherited types

type MailOp[F[_], C, A] = Kleisli[F, C, A]
Inherited from
Ops