notify

Documentation

Index

• Constants
• func GetTgBot(ctx context.Context, option TgBotOption) *tgbotapi.BotAPI
• func SendMessageDiscord(ctx context.Context, discordClient DiscordClient, message string) error
• func SendMessageSMTP(ctx context.Context, sender *Sender, message string)
• func SendMessageTG(ctx context.Context, bot *tgbotapi.BotAPI, id int64, message string) error
• func SendMessageWebHook(ctx context.Context, webhookClient WebHookClient, message string) error
• type Author
• type DiscordClient
  • func NewDiscordClient(options DiscordClientOptions) (DiscordClient, error)
• type DiscordClientOptions
• type Embed
• type HttpRequestDoer
• type Notifier
• type PayloadWebHook
  • func (p *PayloadWebHook) ToReader() *strings.Reader
• type PayloadWebHookDiscord
  • func (p *PayloadWebHookDiscord) ToReader() *strings.Reader
• type Sender
  • func NewSender(Username, Password string) Sender
  • func (sender Sender) SendMail(ctx context.Context, Dest []string, Subject, bodyMessage string)
  • func (sender Sender) WriteEmail(dest []string, contentType, subject, bodyMessage string) string
  • func (sender *Sender) WriteHTMLEmail(dest []string, subject, bodyMessage string) string
  • func (sender *Sender) WritePlainEmail(dest []string, subject, bodyMessage string) string
• type TgBotOption
• type WebHookClient
  • func NewWebHookClient(options WebHookClientOptions) (WebHookClient, error)
• type WebHookClientOptions

Constants

const (
	TELEGRAM = "telegram"
	DISCORD  = "discord"
	WEBHOOK  = "webhook"
	SMTP     = "smtp"
)

const (
	/**
		Gmail SMTP Server
	**/
	SMTPServer = "smtp.gmail.com"
)

Functions

func GetTgBot

func GetTgBot(ctx context.Context, option TgBotOption) *tgbotapi.BotAPI

GetTgBot get an instance of tgBot

func SendMessageDiscord

func SendMessageDiscord(ctx context.Context, discordClient DiscordClient, message string) error

SendMessageDiscord send msg to discord

func SendMessageSMTP

func SendMessageSMTP(ctx context.Context, sender *Sender, message string)

SendMessageSMTP send msg to SMTP

func SendMessageTG

func SendMessageTG(ctx context.Context, bot *tgbotapi.BotAPI, id int64, message string) error

SendMessageTG send msg to telegram

func SendMessageWebHook

func SendMessageWebHook(ctx context.Context, webhookClient WebHookClient, message string) error

SendMessageWebHook send msg to webhook

Types

type Author

type Author struct {
	Name    string `json:"name,omitempty"`
	URL     string `json:"url,omitempty"`
	IconURL string `json:"icon_url,omitempty"`
}

Author ...

type DiscordClient

type DiscordClient interface {
	// PostMessage ...
	PostMessage(ctx context.Context, message string) error
}

func NewDiscordClient

func NewDiscordClient(options DiscordClientOptions) (DiscordClient, error)

NewDiscordClient create an instance of discord client

type DiscordClientOptions

type DiscordClientOptions struct {

	// ServerHook url to use
	ServerHook string

	HttpClient *http.Client
}

DiscordClientOptions ...

type Embed

type Embed struct {
	Author      Author `json:"author,omitempty"`
	Title       string `json:"title,omitempty"`
	URL         string `json:"url,omitempty"`
	Description string `json:"description,omitempty"`
	Color       int64  `json:"color,omitempty"`
}

Embed object that define the structure of our msg

type HttpRequestDoer

type HttpRequestDoer interface {
	Do(req *http.Request) (*http.Response, error)
}

type Notifier

type Notifier interface {
	SendNotification(ctx context.Context, data interface{}) error
}

Notifier ...

type PayloadWebHook

type PayloadWebHook struct {
	Username string `json:"username,omitempty"`
	Content  string `json:"content,omitempty"`
	Message  string `json:"message,omitempty"`
}

func (*PayloadWebHook) ToReader

func (p *PayloadWebHook) ToReader() *strings.Reader

type PayloadWebHookDiscord

type PayloadWebHookDiscord struct {
	Username  string  `json:"username,omitempty"`
	AvatarURL string  `json:"avatar_url,omitempty"`
	Content   string  `json:"content,omitempty"`
	Embeds    []Embed `json:"embeds,omitempty"`
}

PayloadWebHookDiscord general payload to make request to discord Hook

func (*PayloadWebHookDiscord) ToReader

func (p *PayloadWebHookDiscord) ToReader() *strings.Reader

type Sender

type Sender struct {
	// User ...
	User string
	// Password
	Password string
}

Sender object it`s used to send SMTP request

func NewSender

func NewSender(Username, Password string) Sender

NewSender constructor

func (Sender) SendMail

func (sender Sender) SendMail(ctx context.Context, Dest []string, Subject, bodyMessage string)

SendMail send mail to an array of dst

func (Sender) WriteEmail

func (sender Sender) WriteEmail(dest []string, contentType, subject, bodyMessage string) string

WriteEmail an email

func (*Sender) WriteHTMLEmail

func (sender *Sender) WriteHTMLEmail(dest []string, subject, bodyMessage string) string

WriteHTMLEmail ...

func (*Sender) WritePlainEmail

func (sender *Sender) WritePlainEmail(dest []string, subject, bodyMessage string) string

WritePlainEmail ...

type TgBotOption

type TgBotOption struct {
	Debug bool
	Token string
}

TgBotOption object options for telegram service

type WebHookClient

type WebHookClient interface {
	// PostMessage ...
	PostMessage(ctx context.Context, message string) error
}

func NewWebHookClient

func NewWebHookClient(options WebHookClientOptions) (WebHookClient, error)

type WebHookClientOptions

type WebHookClientOptions struct {

	// ServerHook url to use
	ServerHook string

	HttpClient *http.Client
}