mail

Documentation

Overview

Package mail provides basic email sending capabilities

Index

• func NewMail(parameters string) (stdio.Io, error)
• type Mail
  • func (m *Mail) Close()
  • func (m *Mail) DefaultDataType(bool)
  • func (m *Mail) File() *os.File
  • func (m *Mail) ForceClose()
  • func (m *Mail) GetDataType() string
  • func (m *Mail) IsTTY() bool
  • func (m *Mail) Open()
  • func (m *Mail) Read(p []byte) (int, error)
  • func (m *Mail) ReadAll() ([]byte, error)
  • func (m *Mail) ReadArray(context.Context, func([]byte)) error
  • func (m *Mail) ReadArrayWithType(context.Context, func(interface{}, string)) error
  • func (m *Mail) ReadLine(func([]byte)) error
  • func (m *Mail) ReadMap(*config.Config, func(*stdio.Map)) error
  • func (m *Mail) SetDataType(string)
  • func (m *Mail) Stats() (bytesWritten, bytesRead uint64)
  • func (m *Mail) Write(b []byte) (i int, err error)
  • func (m *Mail) WriteArray(dataType string) (stdio.ArrayWriter, error)
  • func (m *Mail) WriteTo(w io.Writer) (int64, error)
  • func (m *Mail) Writeln(b []byte) (int, error)

Functions

func NewMail

func NewMail(parameters string) (stdio.Io, error)

NewMail creates a new stdio.Io object for sending mail

Types

type Mail

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

Mail is null interface for named pipes

func (*Mail) Close

func (m *Mail) Close()

Close email and send

func (*Mail) DefaultDataType

func (m *Mail) DefaultDataType(bool)

DefaultDataType - not required as data is emailed

func (*Mail) File

func (m *Mail) File() *os.File

func (*Mail) ForceClose

func (m *Mail) ForceClose()

ForceClose is not required on this occasion

func (*Mail) GetDataType

func (m *Mail) GetDataType() string

GetDataType returns null because you cannot read a sent email

func (*Mail) IsTTY

func (m *Mail) IsTTY() bool

IsTTY - Stdio.Io is an email not a terminal

func (*Mail) Open

func (m *Mail) Open()

Open email for sending

func (*Mail) Read

func (m *Mail) Read(p []byte) (int, error)

Read is an empty method because you cannot read a sent email

func (*Mail) ReadAll

func (m *Mail) ReadAll() ([]byte, error)

ReadAll is an empty method because you cannot read a sent email

func (*Mail) ReadArray

func (m *Mail) ReadArray(context.Context, func([]byte)) error

ReadArray is an empty method because you cannot read a sent email

func (*Mail) ReadArrayWithType

func (m *Mail) ReadArrayWithType(context.Context, func(interface{}, string)) error

ReadArrayWithType is an empty method because you cannot read a sent email

func (*Mail) ReadLine

func (m *Mail) ReadLine(func([]byte)) error

ReadLine is an empty method because you cannot read a sent email

func (*Mail) ReadMap

func (m *Mail) ReadMap(*config.Config, func(*stdio.Map)) error

ReadMap is an empty method because you cannot read a sent email

func (*Mail) SetDataType

func (m *Mail) SetDataType(string)

SetDataType - not required as data is emailed

func (*Mail) Stats

func (m *Mail) Stats() (bytesWritten, bytesRead uint64)

Stats - return data size

func (*Mail) Write

func (m *Mail) Write(b []byte) (i int, err error)

Write - caches the data before send

func (*Mail) WriteArray

func (m *Mail) WriteArray(dataType string) (stdio.ArrayWriter, error)

WriteArray - caches the data before send

func (*Mail) WriteTo

func (m *Mail) WriteTo(w io.Writer) (int64, error)

WriteTo is an empty method because you cannot read a sent email

func (*Mail) Writeln

func (m *Mail) Writeln(b []byte) (int, error)

Writeln - caches the data before send