#7 added docblock

Author: frederic.leist

mail.go

@@ -44,6 +44,9 @@ type mailer struct {
 	config   *smtpConfig
 }
 
+// New returns a new Mailer instance
+//
+// Returns an error, if opts could not be validated
 func New(opts MailerOpts) (*mailer, error) {
 	if err := validateMailerOpts(opts); err != nil {
 		return nil, err
@@ -65,6 +68,11 @@ func New(opts MailerOpts) (*mailer, error) {
 	return m, nil
 }
 
+// validateMailerOpts returns an error if
+//
+//   - [MailerOpts.User] is empty
+//   - [MailerOpts.Password] is empty
+//   - [MailerOpts.Host] is empty
 func validateMailerOpts(opts MailerOpts) error {
 	if opts.User == "" {
 		return fmt.Errorf("MailerOpts.User is empty")
@@ -78,24 +86,29 @@ func validateMailerOpts(opts MailerOpts) error {
 	return nil
 }
 
+// Send sends the message with [net/smtp.SendMail]
 func (m *mailer) Send() error {
 	return smtp.SendMail(m.config.addr, m.config.auth, m.config.user, m.message.To(), m.writeMessage())
 }
 
+// SetMessage sets the message
 func (m *mailer) SetMessage(msg Message) *mailer {
 	m.message = msg
 	return m
 }
 
+// SetBoundary sets the boundary string
 func (m *mailer) SetBoundary(boundary string) *mailer {
 	m.boundary = boundary
 	return m
 }
 
+// Boundary returns the boundary string
 func (m *mailer) Boundary() string {
 	return m.boundary
 }
 
+// Config returns the SMTP Config
 func (m *mailer) Config() *smtpConfig {
 	return m.config
 }
@@ -123,6 +136,7 @@ func (m *mailer) chunkString(s string) string {
 	return strings.Join(chunks, "\n")
 }
 
+// writeMessage writes the message
 func (m *mailer) writeMessage() []byte {
 	msg := m.message
 	buf := bytes.NewBuffer(nil)

message.go

@@ -37,45 +37,59 @@ type message struct {
 	attachments map[string][]byte
 }
 
+// SetFrom sets the sender email.
 func (m *message) SetFrom(from string) {
 	m.from = from
 }
+
+// From returns the sender email.
 func (m *message) From() string {
 	return m.from
 }
 
+// SetTo sets the receiver addresses.
 func (m *message) SetTo(to ...string) {
 	m.to = to
 }
 
+// To returns receivers.
 func (m *message) To() []string {
 	return m.to
 }
 
+// SetCC sets the CC recipients.
 func (m *message) SetCC(cc ...string) {
 	m.cc = cc
 }
 
+// CC returns the CC recipients.
 func (m *message) CC() []string {
 	return m.cc
 }
 
+// SetBCC sets the BCC recipients.
 func (m *message) SetBCC(bcc ...string) {
 	m.bcc = bcc
 }
 
+// BCC returns the BCC recipients.
 func (m *message) BCC() []string {
 	return m.bcc
 }
 
+// SetSubject sets the subject.
 func (m *message) SetSubject(subject string) {
 	m.subject = subject
 }
 
+// Subject returns the Subject.
 func (m *message) Subject() string {
 	return m.subject
 }
 
+// Attach attaches files
+//
+// Returns an error if one of files could not be read.
 func (m *message) Attach(files ...string) error {
 	for _, file := range files {
 		b, err := os.ReadFile(file)
@@ -89,36 +103,46 @@ func (m *message) Attach(files ...string) error {
 	return nil
 }
 
+// Attachments returns the attachments.
 func (m *message) Attachments() map[string][]byte {
 	return m.attachments
 }
 
+// Body returns the body.
 func (m *message) Body() string {
 	return m.body
 }
 
+// SetNormalPriority sets the email priority to 'normal'.
 func (m *message) SetNormalPriority() {
 	m.priority = "normal"
 }
 
+// SetUrgentPriority sets the email priority to 'urgent'.
 func (m *message) SetUrgentPriority() {
 	m.priority = "urgent"
 }
 
+// SetNonUrgentPriority sets the email priority to 'non-urgent'.
 func (m *message) SetNonUrgentPriority() {
 	m.priority = "non-urgent"
 }
 
+// Priority returns the priority.
 func (m *message) Priority() string {
 	return m.priority
 }
 
+// FromString creates a new message with content from given string.
 func FromString(str string) *message {
 	m := new()
 	m.body = str
 	return m
 }
 
+// FromTemplateString creates a new message with content from parsed template string.
+//
+// Returns an error if the template string could not be parsed.
 func FromTemplateString(data any, tpl string) (*message, error) {
 	buff := bytes.Buffer{}
 	template, _ := template.New("tinymail").Parse(tpl)
@@ -131,6 +155,9 @@ func FromTemplateString(data any, tpl string) (*message, error) {
 	return m, nil
 }
 
+// FromTemplateFile creates a new message with content from parsed template file.
+//
+// Returns an error if the template file could not be parsed.
 func FromTemplateFile(data any, filenames ...string) (*message, error) {
 	buff := bytes.Buffer{}
 	template, _ := template.ParseFiles(filenames...)
@@ -143,6 +170,7 @@ func FromTemplateFile(data any, filenames ...string) (*message, error) {
 	return m, nil
 }
 
+// new creates a new empty message.
 func new() *message {
 	return &message{
 		from:        "",