README
¶
Mdsend
Project status: ALPHA DRAFT
Send markdown files as MIME-encoded electronic mail.
Installation
- Go:
go install github.com/dkotik/mdsend@latest - Macintosh:
brew tap dkotik/tap brew install mdsend
Example
---
subject: "Test Email"
to: "Test Account <test@gmail.com>"
to: "./localfile.yaml|toml|json|csv|txt"
---
# Title
Message body.
Easily hackable.
EmailSend(file.md, templating engine, provider engine)
Delivery Locking
Distributors
Planned Features
- Text-part writer should minify html! minified html will have
without quotes! (change inline detector)
- Should write a better markdown renderer that recognizes single-line youtube and image paragraphs, centers them.
- Email validation: https://github.com/reacherhq/check-if-email-exists
Tools
- https://github.com/AfterShip/email-verifier
- Use https://www.mail-tester.com/ to check the deliverability of your mail.
Documentation
¶
Index ¶
- Constants
- func MIMEBase64To(w io.Writer, r io.Reader) (err error)
- func MIMEHeaderTo(w io.Writer, header textproto.MIMEHeader) (err error)
- func PreviewMessage(m *loaders.Message)
- func RegisterCompressor(contentType string, resizer Compressor)
- func Send(message *loaders.Message, o *Options) error
- type Attachment
- type Compressor
- type MIMELineWrapper
- type Mailer
- type Message
- type Option
- type Options
Constants ¶
View Source
const Version = "dev"
Variables ¶
This section is empty.
Functions ¶
func MIMEHeaderTo ¶
func MIMEHeaderTo(w io.Writer, header textproto.MIMEHeader) (err error)
func PreviewMessage ¶
func RegisterCompressor ¶
func RegisterCompressor(contentType string, resizer Compressor)
Types ¶
type Attachment ¶
type Attachment struct {
Name string
Source string
Hash uint64 // for XXHash2
// contains filtered or unexported fields
}
func NewAttachment ¶
func NewAttachment(p string) (*Attachment, error)
type Compressor ¶
func NewImageJPEGResizer ¶
func NewImageJPEGResizer(maxWidth, maxHeight, quality uint) Compressor
type MIMELineWrapper ¶
type MIMELineWrapper struct {
// contains filtered or unexported fields
}
MIMELineWrapper writes everything to io.Writer chunked by maxMIMELineLen.
type Option ¶
func WithOptions ¶
type Options ¶
type Options struct {
URI string // Credentials for provider API backend.
Verbose bool
Dryrun bool // Run the program without delivering or locking anything down.
YesOnPrompt bool // Automatically confirm all prompts.
Logger loggers.Logger
Loader loaders.Loader
Renderer renderers.Renderer
Provider providers.Provider
Distributor distributors.Distributor
}
Options provide configuration to component execution.
Source Files
¶
Directories
Click to show internal directories.
Click to hide internal directories.