header

Documentation

Overview

Package header has structs and functions handling with mail header and their modifications

Index

• Constants
• func Diff(orig *Header, changed *Header) (changeInsertOps []Op, addOps []Op)
• func DiffOrRecreate(recreate bool, orig *Header, changed *Header) (changeInsertOps []Op, addOps []Op)
• func Recreate(orig *Header, changed *Header) (changeInsertOps []Op, addOps []Op)
• type Field
  • func (f *Field) Deleted() bool
  • func (f *Field) Key() string
  • func (f *Field) UnfoldedValue() string
  • func (f *Field) Value() string
• type Fields
  • func (f *Fields) AddressList() ([]*mail.Address, error)
  • func (f *Fields) CanonicalKey() string
  • func (f *Fields) Del()
  • func (f *Fields) InsertAddressListAfter(key string, value []*mail.Address)
  • func (f *Fields) InsertAddressListBefore(key string, value []*mail.Address)
  • func (f *Fields) InsertAfter(key string, value string)
  • func (f *Fields) InsertBefore(key string, value string)
  • func (f *Fields) InsertTextAfter(key string, value string)
  • func (f *Fields) InsertTextBefore(key string, value string)
  • func (f *Fields) IsDeleted() bool
  • func (f *Fields) Key() string
  • func (f *Fields) Len() int
  • func (f *Fields) Next() bool
  • func (f *Fields) Raw() []byte
  • func (f *Fields) Replace(key string, value string)
  • func (f *Fields) ReplaceAddressList(key string, value []*mail.Address)
  • func (f *Fields) ReplaceText(key string, value string)
  • func (f *Fields) Set(value string)
  • func (f *Fields) SetAddressList(value []*mail.Address)
  • func (f *Fields) SetText(value string)
  • func (f *Fields) Text() (string, error)
  • func (f *Fields) UnfoldedValue() string
  • func (f *Fields) Value() string
• type Header
  • func New(raw []byte) (*Header, error)
  • func (h *Header) Add(key string, value string)
  • func (h *Header) AddRaw(key string, raw []byte)
  • func (h *Header) AddressList(key string) ([]*mail.Address, error)
  • func (h *Header) Copy() *Header
  • func (h *Header) Date() (time.Time, error)
  • func (h *Header) Fields() header.Fields
  • func (h *Header) Reader() io.Reader
  • func (h *Header) Set(key string, value string)
  • func (h *Header) SetAddressList(key string, addresses []*mail.Address)
  • func (h *Header) SetDate(value time.Time)
  • func (h *Header) SetSubject(value string)
  • func (h *Header) SetText(key string, value string)
  • func (h *Header) Subject() (string, error)
  • func (h *Header) Text(key string) (string, error)
  • func (h *Header) UnfoldedValue(key string) string
  • func (h *Header) Value(key string) string
• type Op

Constants

const (
	KindEqual = iota
	KindChange
	KindInsert
)

Functions

func Diff

func Diff(orig *Header, changed *Header) (changeInsertOps []Op, addOps []Op)

Diff finds differences between orig and changed. The differences are expressed as change and insert operations – to be mapped to milter modification actions. Deletions are changes to an empty value.

func DiffOrRecreate

func DiffOrRecreate(recreate bool, orig *Header, changed *Header) (changeInsertOps []Op, addOps []Op)

DiffOrRecreate is a convenience method that either calls Diff or Recreate

func Recreate

func Recreate(orig *Header, changed *Header) (changeInsertOps []Op, addOps []Op)

Recreate deletes all headers of orig and adds all headers of changed.

Types

type Field

type Field struct {
	Index        int
	CanonicalKey string
	Raw          []byte
}

func (*Field) Deleted

func (f *Field) Deleted() bool

func (*Field) Key

func (f *Field) Key() string

func (*Field) UnfoldedValue

func (f *Field) UnfoldedValue() string

func (*Field) Value

func (f *Field) Value() string

type Fields

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

func (*Fields) AddressList

func (f *Fields) AddressList() ([]*mail.Address, error)

func (*Fields) CanonicalKey

func (f *Fields) CanonicalKey() string

func (*Fields) Del

func (f *Fields) Del()

func (*Fields) InsertAddressListAfter

func (f *Fields) InsertAddressListAfter(key string, value []*mail.Address)

func (*Fields) InsertAddressListBefore

func (f *Fields) InsertAddressListBefore(key string, value []*mail.Address)

func (*Fields) InsertAfter

func (f *Fields) InsertAfter(key string, value string)

func (*Fields) InsertBefore

func (f *Fields) InsertBefore(key string, value string)

func (*Fields) InsertTextAfter

func (f *Fields) InsertTextAfter(key string, value string)

func (*Fields) InsertTextBefore

func (f *Fields) InsertTextBefore(key string, value string)

func (*Fields) IsDeleted

func (f *Fields) IsDeleted() bool

IsDeleted returns true when a previous header modification deleted this header. You can "undelete" the header by just calling [HeaderFields.Set] with a non-empty value.

func (*Fields) Key

func (f *Fields) Key() string

func (*Fields) Len

func (f *Fields) Len() int

Len returns the number of fields in the header. This also includes deleted headers fields. Initially no fields are deleted so Len returns the actual number of header fields.

func (*Fields) Next

func (f *Fields) Next() bool

func (*Fields) Raw

func (f *Fields) Raw() []byte

func (*Fields) Replace

func (f *Fields) Replace(key string, value string)

func (*Fields) ReplaceAddressList

func (f *Fields) ReplaceAddressList(key string, value []*mail.Address)

func (*Fields) ReplaceText

func (f *Fields) ReplaceText(key string, value string)

func (*Fields) Set

func (f *Fields) Set(value string)

func (*Fields) SetAddressList

func (f *Fields) SetAddressList(value []*mail.Address)

func (*Fields) SetText

func (f *Fields) SetText(value string)

func (*Fields) Text

func (f *Fields) Text() (string, error)

func (*Fields) UnfoldedValue

func (f *Fields) UnfoldedValue() string

func (*Fields) Value

func (f *Fields) Value() string

type Header

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

func New

func New(raw []byte) (*Header, error)

func (*Header) Add

func (h *Header) Add(key string, value string)

func (*Header) AddRaw

func (h *Header) AddRaw(key string, raw []byte)

func (*Header) AddressList

func (h *Header) AddressList(key string) ([]*mail.Address, error)

func (*Header) Copy

func (h *Header) Copy() *Header

func (*Header) Date

func (h *Header) Date() (time.Time, error)

func (*Header) Fields

func (h *Header) Fields() header.Fields

func (*Header) Reader

func (h *Header) Reader() io.Reader

func (*Header) Set

func (h *Header) Set(key string, value string)

func (*Header) SetAddressList

func (h *Header) SetAddressList(key string, addresses []*mail.Address)

func (*Header) SetDate

func (h *Header) SetDate(value time.Time)

SetDate sets the Date header to the value. The zero value of time.Time as valid. This will delete the Date header when it exists.

func (*Header) SetSubject

func (h *Header) SetSubject(value string)

func (*Header) SetText

func (h *Header) SetText(key string, value string)

func (*Header) Subject

func (h *Header) Subject() (string, error)

func (*Header) Text

func (h *Header) Text(key string) (string, error)

func (*Header) UnfoldedValue

func (h *Header) UnfoldedValue(key string) string

func (*Header) Value

func (h *Header) Value(key string) string

type Op

type Op struct {
	Kind  int
	Index int
	Name  string
	Value string
}