mirror of
https://github.com/opencloud-eu/opencloud.git
synced 2026-02-15 08:41:16 -05:00
63a4470146
* adds pkg/jmap/jmap_integration_test.go
* uses ghcr.io/stalwartlabs/stalwart:v0.13.2-alpine
* can be disabled by setting one of the following environment
variables, in the same fashion as ca0493b28
- CI=woodpecker
- CI_SYSTEM_NAME=woodpecker
- USE_TESTCONTAINERS=false
* dependencies:
- bump github.com/go-test/deep from 1.1.0 to 1.1.1
- add github.com/cention-sany/utf7
- add github.com/dustinkirkland/golang-petname
- add github.com/emersion/go-imap/v2
- add github.com/emersion/go-message
- add github.com/emersion/go-sasl
- add github.com/go-crypt/crypt
- add github.com/go-crypt/x
- add github.com/gogs/chardet
- add github.com/inbucket/html2text
- add github.com/jhilleryerd/enmime/v2
- add github.com/ssor/bom
- add gopkg.in/loremipsum.v1
133 lines
3.1 KiB
Markdown
133 lines
3.1 KiB
Markdown
# html2text
|
|
|
|
[](https://pkg.go.dev/github.com/inbucket/html2text)
|
|
[](https://github.com/inbucket/html2text/actions/workflows/build-and-test.yml)
|
|
[](https://goreportcard.com/report/github.com/inbucket/html2text)
|
|
|
|
### Converts HTML into text of the markdown-flavored variety
|
|
|
|
This is a permanent fork of the original
|
|
[jaytaylor.com/html2text](https://github.com/jaytaylor/html2text) package.
|
|
|
|
## Introduction
|
|
|
|
Ensure your emails are readable by all!
|
|
|
|
Turns HTML into raw text, useful for sending fancy HTML emails with an equivalently nicely formatted TXT document as a fallback (e.g. for people who don't allow HTML emails or have other display issues).
|
|
|
|
html2text is a simple golang package for rendering HTML into plaintext.
|
|
|
|
There are still lots of improvements to be had, but FWIW this has worked fine for my [basic] HTML-2-text needs.
|
|
|
|
It requires go 1.x or newer ;)
|
|
|
|
## Download the package
|
|
|
|
```bash
|
|
go get github.com/inbucket/html2text
|
|
```
|
|
|
|
## Example usage
|
|
|
|
### Library
|
|
|
|
```go
|
|
package main
|
|
|
|
import (
|
|
"fmt"
|
|
|
|
"github.com/inbucket/html2text"
|
|
)
|
|
|
|
func main() {
|
|
inputHTML := `
|
|
<html>
|
|
<head>
|
|
<title>My Mega Service</title>
|
|
<link rel=\"stylesheet\" href=\"main.css\">
|
|
<style type=\"text/css\">body { color: #fff; }</style>
|
|
</head>
|
|
|
|
<body>
|
|
<div class="logo">
|
|
<a href="http://jaytaylor.com/"><img src="/logo-image.jpg" alt="Mega Service"/></a>
|
|
</div>
|
|
|
|
<h1>Welcome to your new account on my service!</h1>
|
|
|
|
<p>
|
|
Here is some more information:
|
|
|
|
<ul>
|
|
<li>Link 1: <a href="https://example.com">Example.com</a></li>
|
|
<li>Link 2: <a href="https://example2.com">Example2.com</a></li>
|
|
<li>Something else</li>
|
|
</ul>
|
|
</p>
|
|
|
|
<table>
|
|
<thead>
|
|
<tr><th>Header 1</th><th>Header 2</th></tr>
|
|
</thead>
|
|
<tfoot>
|
|
<tr><td>Footer 1</td><td>Footer 2</td></tr>
|
|
</tfoot>
|
|
<tbody>
|
|
<tr><td>Row 1 Col 1</td><td>Row 1 Col 2</td></tr>
|
|
<tr><td>Row 2 Col 1</td><td>Row 2 Col 2</td></tr>
|
|
</tbody>
|
|
</table>
|
|
</body>
|
|
</html>`
|
|
|
|
text, err := html2text.FromString(inputHTML, html2text.Options{PrettyTables: true})
|
|
if err != nil {
|
|
panic(err)
|
|
}
|
|
fmt.Println(text)
|
|
}
|
|
```
|
|
|
|
Output:
|
|
```
|
|
Mega Service ( http://jaytaylor.com/ )
|
|
|
|
******************************************
|
|
Welcome to your new account on my service!
|
|
******************************************
|
|
|
|
Here is some more information:
|
|
|
|
* Link 1: Example.com ( https://example.com )
|
|
* Link 2: Example2.com ( https://example2.com )
|
|
* Something else
|
|
|
|
+-------------+-------------+
|
|
| HEADER 1 | HEADER 2 |
|
|
+-------------+-------------+
|
|
| Row 1 Col 1 | Row 1 Col 2 |
|
|
| Row 2 Col 1 | Row 2 Col 2 |
|
|
+-------------+-------------+
|
|
| FOOTER 1 | FOOTER 2 |
|
|
+-------------+-------------+
|
|
```
|
|
|
|
### Command line
|
|
|
|
```
|
|
echo '<div>hi</div>' | html2text
|
|
```
|
|
|
|
## Unit-tests
|
|
|
|
Running the unit-tests is straightforward and standard:
|
|
|
|
```bash
|
|
go test
|
|
```
|
|
|
|
# License
|
|
|
|
Permissive MIT license.
|