postfixpipe

Documentation

Overview

Package postfixpipe provides helpers for writing programs for Postfix dot-forwards and aliases.

Index

• func Exit(es ExitStatus)
• type ExitStatus
• type Message
  • func Get() *Message
  • func (pm *Message) Args() []string
  • func (pm *Message) Intro() (string, locale.Error)
  • func (pm *Message) Reader() (io.Reader, locale.Error)
• type Sysexit

Functions

func Exit

func Exit(es ExitStatus)

Exit and return a status to Postfix.

Types

type ExitStatus

type ExitStatus interface {
	// contains filtered or unexported methods
}

ExitStatus is an exit status that a program can pass to Postfix. May be a simple Sysexit code or (TODO) an RFC 3463 Enhanced Status Code.

type Message

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

A Message is a context for a Postfix-pipe helper process; it is what Postix passes us.

func Get

func Get() *Message

Get instantiates a new Postfix-pipe context for this process.

func (*Message) Args

func (pm *Message) Args() []string

Args returns the command line arguments passed in by Postfix.

func (*Message) Intro

func (pm *Message) Intro() (string, locale.Error)

Intro returns the envelope line insertet by Postfix before the RFC 822-style message.

func (*Message) Reader

func (pm *Message) Reader() (io.Reader, locale.Error)

Reader returns an io.Reader for the RFC 822-style message.

type Sysexit

type Sysexit uint8

Sysexit is a simple numeric POSIX exit code.