email

package module
v0.0.0-...-061ab21 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 4, 2022 License: BSD-3-Clause Imports: 5 Imported by: 0

README

email

Emailing with optional limiter. It will send no more then limiterMax emails during limiterPeriod.

Install

go get github.com/kaibox-git/email

Usage

import (
    "github.com/kaibox-git/email"
    "github.com/kaibox-git/email/smtpclient"
)

...

host := `localhost:25`
connTimeout := time.Second // for local smtp server
/*
Only 20 emails per 30 minutes. The rest is ignored.
This is useful for notification of errors, but has a limitation if emailing is too often.
In this case send info to log file.
*/
emailNumber := 20 
period := 30 * time.Minute
emailSender, err := smtpclient.New(host, connTimeout, emailNumber, period)
if err != nil {
    println(err.Error())
    os.Exit(1)
}

// plain text with limiter
emailSender.Send(&email.Data{
    From: mail.Address{
        Name: `Robot`,
        Address: `robot@domain.com`,
    },
    To: []mail.Address{
            {
                Name: `Test address`,
                Address: `test@domain.com`,
            },
        },
    Subject: `test subject`,
    Body:    `test message`,
    WithLimiter: true,
})

// html body for 2 addresses with no limiter
body := `<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>Emailing HTML format</title>
</head>
<body>
    <h1>Test HTML format</h1>
    <p>This is a test body.</p>
</body>
</html>`

emailSender.Send(&email.Data{
    From: mail.Address{
        Name: `Robot`,
        Address: `robot@domain.com`,
    },
    To: []mail.Address{
            {
                Name: `Test address`,
                Address: `test@domain.com`,
            },
            {
                Name: `Test address 2`,
                Address: `test2@domain.com`,
            },
        },
    Subject: `test subject`,
    Body:    body,
    WithLimiter: false,
})

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func IsValid

func IsValid(email []string) string

to validate emails from config file

Types

type Data

type Data struct {
	From        mail.Address
	To          []mail.Address
	Subject     string
	Body        string
	WithLimiter bool
}

func (*Data) Validate

func (e *Data) Validate() error

type EmailProvider

type EmailProvider interface {
	Send(data *Data) error
}

type Limiter

type Limiter struct {
	// contains filtered or unexported fields
}

func NewLimiter

func NewLimiter(max int, dif time.Duration) *Limiter

func (*Limiter) Add

func (l *Limiter) Add()

func (*Limiter) Check

func (l *Limiter) Check()

func (*Limiter) IsOn

func (l *Limiter) IsOn() bool

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL