README
¶
GoCryptoTrader package Smtp
This smtp package is part of the GoCryptoTrader codebase.
This is still in active development
You can track ideas, planned features and what's in progresss on this Trello board: https://trello.com/b/ZAhMhpOy/gocryptotrader.
Join our slack to discuss all things related to GoCryptoTrader! GoCryptoTrader Slack
SMSGlobal Communications package
What is SMTP?
- Simple Mail Transfer Protocol (SMTP) is an Internet standard for electronic mail (email) transmission
- Please visit: Wikipedia for more information
Current Features
- Sending of events to a list of recipients via email
How to enable
-
Individual package example below:
import (
"github.com/thrasher-/gocryptotrader/communications/smtpservice"
"github.com/thrasher-/gocryptotrader/config"
)
s := new(smtpservice.SMTPservice)
// Define SMTPservice configuration
commsConfig := config.CommunicationsConfig{SMTPservice: config.SMTPConfig{
Name: "SMTPservice",
Enabled: true,
Verbose: false,
Host: "host",
Port: "port",
AccountName: "name",
AccountPassword: "password",
RecipientList: "something@something.com,somethingelse@something.com"
}}
s.Setup(commsConfig)
err := s.Connect
// Handle error
Please click GoDocs chevron above to view current GoDoc information for this package
Contribution
Please feel free to submit any pull requests or suggest any desired features to be added.
When submitting a PR, please abide by our coding guidelines:
- Code must adhere to the official Go formatting guidelines (i.e. uses gofmt).
- Code must be documented adhering to the official Go commentary guidelines.
- Code must adhere to our coding style.
- Pull requests need to be based on and opened against the
masterbranch.
Donations
If this framework helped you in any way, or you would like to support the developers working on it, please donate Bitcoin to:
1F5zVDgNjorJ51oGebSvNCrSAHpwGkUdDB
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type SMTPservice ¶
type SMTPservice struct {
base.Base
Host string
Port string
AccountName string
AccountPassword string
RecipientList string
}
SMTPservice uses the net/smtp package to send emails to a recipient list
func (*SMTPservice) PushEvent ¶
func (s *SMTPservice) PushEvent(base.Event) error
PushEvent sends an event to supplied recipient list via SMTP
func (*SMTPservice) Send ¶
func (s *SMTPservice) Send(subject, alert string) error
Send sends an email template to the recipient list via your SMTP host when an internal event is triggered by GoCryptoTrader
func (*SMTPservice) Setup ¶
func (s *SMTPservice) Setup(cfg *config.CommunicationsConfig)
Setup takes in a SMTP configuration and sets SMTP server details and recipient list
Source Files