wneessen/go-mail
1
1
Fork 0
mirror of https://github.com/wneessen/go-mail.git synced 2024-12-22 18:50:37 +01:00
Code Issues Projects Releases Packages Wiki Activity
📧 Easy to use, yet comprehensive library for sending mails with Go https://go-mail.dev
367 commits 2 branches 39 tags 11 MiB
Go 100%
Find a file
Winni Neessen 63d8cef8ca
Refactor DSN handling from client.go to smtp.go 
This PR refactors the the DSN (RFC 1891) SMTP client handling, that was introduced in f4cdc61dd0.

While most of the Client options stay the same, the whole workaround logic for the SMTP client has been removed and added as part of the SMTP client instead.

This was we got rid of the Client's own `mail()`, `rcpt()`, `dsnRcpt()`, `dsnMail()` methods as well as the copies of the `cmd()` and `validateLine()` methods. The Client is now using the proper `Mail()` and `Rcpt()` methods of the SMTP client instead.
2023-01-18 10:30:06 +01:00
.github Update sonarqube.yml 2022-10-18 17:36:13 +02:00
.idea #24: Add SPDX license IDs for REUSE compliance 2022-06-17 15:05:54 +02:00
.reuse #24: Add SPDX license IDs for REUSE compliance 2022-06-17 15:05:54 +02:00
assets Switch logo to CC-BY-ND-4.0 license 2022-07-11 13:23:50 +02:00
LICENSES Fix license SPDX headers for forked net/smtp code 2023-01-10 10:09:45 +01:00
smtp Refactor DSN handling from client.go to smtp.go 2023-01-18 10:30:06 +01:00
.cirrus.yml #98 Set up FreeBSD tests via CirrusCI 2023-01-12 01:22:45 +01:00
.gitignore Updated .gitignore 2022-10-18 15:39:55 +02:00
.golangci.toml Update golangci-lint config 2022-10-17 18:34:05 +02:00
auth.go Switched copyright header from me to "The go-mail Authors" 2023-01-15 16:14:19 +01:00
b64linebreaker.go Switched copyright header from me to "The go-mail Authors" 2023-01-15 16:14:19 +01:00
b64linebreaker_test.go Switched copyright header from me to "The go-mail Authors" 2023-01-15 16:14:19 +01:00
client.go Refactor DSN handling from client.go to smtp.go 2023-01-18 10:30:06 +01:00
client_119.go Refactor DSN handling from client.go to smtp.go 2023-01-18 10:30:06 +01:00
client_120.go Refactor DSN handling from client.go to smtp.go 2023-01-18 10:30:06 +01:00
client_test.go Refactor DSN handling from client.go to smtp.go 2023-01-18 10:30:06 +01:00
CODE_OF_CONDUCT.md #24: Add SPDX license IDs for REUSE compliance 2022-06-17 15:05:54 +02:00
codecov.yml Switched copyright header from me to "The go-mail Authors" 2023-01-15 16:14:19 +01:00
CONTRIBUTING.md Switched copyright header from me to "The go-mail Authors" 2023-01-15 16:14:19 +01:00
doc.go Bump version to 0.3.9 2023-01-15 16:11:15 +01:00
doc_test.go Switched copyright header from me to "The go-mail Authors" 2023-01-15 16:14:19 +01:00
encoding.go Switched copyright header from me to "The go-mail Authors" 2023-01-15 16:14:19 +01:00
encoding_test.go Switched copyright header from me to "The go-mail Authors" 2023-01-15 16:14:19 +01:00
file.go Switched copyright header from me to "The go-mail Authors" 2023-01-15 16:14:19 +01:00
file_test.go Switched copyright header from me to "The go-mail Authors" 2023-01-15 16:14:19 +01:00
go.mod Switched copyright header from me to "The go-mail Authors" 2023-01-15 16:14:19 +01:00
go.sum Forgot to update go.mod/.sum 2022-03-13 17:25:57 +01:00
header.go Switched copyright header from me to "The go-mail Authors" 2023-01-15 16:14:19 +01:00
header_test.go Switched copyright header from me to "The go-mail Authors" 2023-01-15 16:14:19 +01:00
LICENSE Switched copyright header from me to "The go-mail Authors" 2023-01-15 16:14:19 +01:00
msg.go Switched copyright header from me to "The go-mail Authors" 2023-01-15 16:14:19 +01:00
msg_nowin_test.go Switched copyright header from me to "The go-mail Authors" 2023-01-15 16:14:19 +01:00
msg_test.go Switched copyright header from me to "The go-mail Authors" 2023-01-15 16:14:19 +01:00
msg_totmpfile.go Switched copyright header from me to "The go-mail Authors" 2023-01-15 16:14:19 +01:00
msg_totmpfile_116.go Switched copyright header from me to "The go-mail Authors" 2023-01-15 16:14:19 +01:00
msgwriter.go Switched copyright header from me to "The go-mail Authors" 2023-01-15 16:14:19 +01:00
msgwriter_test.go Switched copyright header from me to "The go-mail Authors" 2023-01-15 16:14:19 +01:00
part.go Switched copyright header from me to "The go-mail Authors" 2023-01-15 16:14:19 +01:00
part_test.go Switched copyright header from me to "The go-mail Authors" 2023-01-15 16:14:19 +01:00
random.go Switched copyright header from me to "The go-mail Authors" 2023-01-15 16:14:19 +01:00
random_test.go Switched copyright header from me to "The go-mail Authors" 2023-01-15 16:14:19 +01:00
reader.go Switched copyright header from me to "The go-mail Authors" 2023-01-15 16:14:19 +01:00
reader_test.go Switched copyright header from me to "The go-mail Authors" 2023-01-15 16:14:19 +01:00
README.md Added note about forked smtp package 2023-01-15 16:12:33 +01:00
SECURITY.md Added GPG key to SECURITY.md 2023-01-15 22:40:28 +01:00
senderror.go Switched copyright header from me to "The go-mail Authors" 2023-01-15 16:14:19 +01:00
senderror_test.go Switched copyright header from me to "The go-mail Authors" 2023-01-15 16:14:19 +01:00
sonar-project.properties Switched copyright header from me to "The go-mail Authors" 2023-01-15 16:14:19 +01:00
tls.go Switched copyright header from me to "The go-mail Authors" 2023-01-15 16:14:19 +01:00
tls_test.go Switched copyright header from me to "The go-mail Authors" 2023-01-15 16:14:19 +01:00

README.md

go-mail - Easy to use, yet comprehensive library for sending mails with Go

GoDoc codecov Go Report Card Mentioned in Awesome Go #go-mail on Discord REUSE status buy ma a coffee

go-mail logo

The main idea of this library was to provide a simple interface to sending mails for my JS-Mailer project. It quickly evolved into a full-fledged mail library.

go-mail follows idiomatic Go style and best practice. It's only dependency is the Go Standard Library. It combines a lot of functionality from the standard library to give easy and convenient access to mail and SMTP related tasks.

Parts of this library (especially some parts of msgwriter.go) have been forked/ported from the go-mail/mail respectively go-gomail/gomail which both seems to not be maintained anymore.

The smtp package of go-mail is forked from the original Go stdlib's net/smtp and then extended by the go-mail team.

Features

Some of the features of this library:

  • Only Standard Library dependant
  • Modern, idiomatic Go
  • Sane and secure defaults
  • Explicit SSL/TLS support
  • Implicit StartTLS support with different policies
  • Makes use of contexts for a better control flow and timeout/cancelation handling
  • SMTP Auth support (LOGIN, PLAIN, CRAM-MD)
  • RFC5322 compliant mail address validation
  • Support for common mail header field generation (Message-ID, Date, Bulk-Precedence, Priority, etc.)
  • Reusing the same SMTP connection to send multiple mails
  • Support for attachments and inline embeds (from file system, io.Reader or embed.FS)
  • Support for different encodings
  • Middleware support for 3rd-party libraries to alter mail messages
  • Support sending mails via a local sendmail command
  • Support for requestng MDNs (RFC 8098) and DSNs (RFC 1891)
  • DKIM signature support via go-mail-middlware
  • Message object satisfies io.WriteTo and io.Reader interfaces
  • Support for Go's html/template and text/template (as message body, alternative part or attachment/emebed)
  • Output to file support which allows storing mail messages as e. g. .eml files to disk to open them in a MUA
  • Debug logging of SMTP traffic
  • Custom error types for delivery errors

go-mail works like a programatic email client and provides lots of methods and functionalities you would consider standard in a MUA.

Documentation

We aim for good GoDoc documenation in our library which gives you a full API reference. We also provide a more in-depth documentation website at go-mail.dev

Support

We have a support and general discussion channel on the Gophers Discord server. Find us at: #go-mail

Middleware

The goal of go-mail is to keep it free from 3rd party dependencies and only focus on things a mail library should fulfill. Yet, since version v0.2.8 we've added support for middleware on the Msg object, allowing 3rd parties to alter a given mail message to their needs without relying on go-mail to support their specific need.

To get our users started with message middleware, we've created a collection of useful middlewares. It can be found in a seperate repository: go-mail-middlware.

Examples

We provide example code in both our GoDocs as well as on our official Website (see Documentation). For a quick start into go-mail check out our Getting started guide.

Authors/Contributors

go-mail was initially authored and developed by Winni Neessen.

Big thanks to the following people, for contributing to the go-mail project (either in form of code or by reviewing code, writing documenation or helping to translate the website):