emil-jsoup
API
Generated with
emil-jsoup/emil.jsoup

emil.jsoup

package emil.jsoup

Members list

Type members

Classlikes

case class BodyClean[F[_]](change: Document => Document)(implicit evidence$1: Applicative[F]) extends Trans[F]

Modifies/cleans html bodies.

Modifies/cleans html bodies.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait Trans[F]
class Object
trait Matchable
class Any
Show all
object BodyClean

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
BodyClean.type
object EmailWhitelist

A even more relaxed whitelist. It tries to retain all formatting information, since e-mails usually contain a lot of `style' tags, which is in contrast to websites. It throws away all non http/s protocol images/links.

A even more relaxed whitelist. It tries to retain all formatting information, since e-mails usually contain a lot of `style' tags, which is in contrast to websites. It throws away all non http/s protocol images/links.

The jsoup `Whitelist' contains more strict variants.

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
object HtmlBodyView

Creates a valid html document given a `MailBody'.

Creates a valid html document given a `MailBody'.

Often, html body parts are only html snippets, missing a valid html' declaration. If the body is text/plain, it is converted into basic html. Theemil-markdown' module should be included to supply a more sophisticated text->html conversion.

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
case class HtmlBodyViewConfig(textToHtml: String => String, modify: Document => Document, dateFormat: DateTimeFormatter, zone: ZoneId)

Settings for creating a html document from a mail body.

Settings for creating a html document from a mail body.

Value parameters

dateFormat

If a mail header is supplied, html is amended with the datetime where this formatter is used

modify:

Allows to modify the parsed html tree. By default a cleaner is used with the default EmailWhiteList

textToHtml

in case there is only a plain text body, it must be converted to html. The default is a very simple approach, it is recommended to use the emil-markdown module for a more sophisticated variant.

zone

the timezone to use when formatting the datetime

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object HtmlBodyViewConfig

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Generated with