models

Documentation

Index

• Constants
• Variables
• func NewDTOEnvelopeField(s string) dtoEnvelopeField
• type Attachment
  • func (a Attachment) FileName() string
  • func (a Attachment) IsImage() bool
• type Auth
• type Config
• type ConfigRetentionPolicy
  • func (p ConfigRetentionPolicy) EnvelopeAgeTime() time.Time
  • func (p ConfigRetentionPolicy) MinAgeTime() time.Time
• type DTOAttachmentCreate
• type DTOAttachmentListRequest
• type DTOAttachmentListResult
• type DTOEndpointCreate
• type DTOEndpointUpdate
• type DTOEnvelopeListRequest
• type DTOEnvelopeListResult
• type DTOMessageCreate
• type DTORuleCreate
• type DTORuleUpdate
• type DTOTraceListRequest
• type DTOTraceListResult
• type DataAttachment
• type Endpoint
• type EndpointConfig
  • func (dst *EndpointConfig) Scan(src any) error
  • func (c EndpointConfig) Str(key string) string
  • func (c EndpointConfig) StrSlice(key string) []string
  • func (src EndpointConfig) Value() (driver.Value, error)
• type EndpointSchema
  • func (e EndpointSchema) Filter(kind string, config EndpointConfig) EndpointConfig
  • func (e EndpointSchema) Get(kind string) EndpointSchemaItem
• type EndpointSchemaField
• type EndpointSchemaItem
  • func (e EndpointSchemaItem) Filter(config EndpointConfig) EndpointConfig
• type Envelope
• type EventEnvelopeCreated
• type EventEnvelopeDeleted
• type EventMailmanEnqueued
• type Field
• type FieldError
  • func (e FieldError) Error() string
  • func (e FieldError) Unwrap() error
• type Message
• type MessageTo
  • func (ss MessageTo) EQ(strs ...string) bool
  • func (dst *MessageTo) Scan(src any) error
  • func (src MessageTo) Value() (driver.Value, error)
• type Rule
• type RuleEndpoints
• type Storage
• type Time
  • func NewTime(time time.Time) Time
  • func (dst *Time) Scan(src any) error
  • func (t Time) Time() time.Time
  • func (src Time) Value() (driver.Value, error)
• type Trace
• type TraceData
  • func (dst *TraceData) Scan(src any) error
  • func (src TraceData) Value() (driver.Value, error)
• type TraceDataKV
  • func (t TraceDataKV) ValueInt64() int64
• type TraceLevel
• type User

Constants

const (
	DTOEnvelopeFieldCreatedAt = "created_at"
	DTOEnvelopeFieldFrom      = "from"
	DTOEnvelopeFieldSubject   = "subject"
)

const EndpointBodyTemplate = "{{ .Message.Text }}"

const EndpointTitleTemplate = "{{ .Message.Subject }}"

Variables

var (
	ErrNotFound         = fmt.Errorf("not found")
	ErrAuthInvalid      = fmt.Errorf("auth invalid")
	ErrInternalResource = fmt.Errorf("internal resource")
)

Functions

func NewDTOEnvelopeField

func NewDTOEnvelopeField(s string) dtoEnvelopeField

Types

type Attachment

type Attachment struct {
	ID        int64 `sql:"primary_key"`
	MessageID int64
	Name      string
	Mime      string
	Extension string
}

func (Attachment) FileName

func (a Attachment) FileName() string

func (Attachment) IsImage

func (a Attachment) IsImage() bool

type Auth

type Auth struct {
	Anonymous bool
	Username  string
	Password  string
}

type Config

type Config struct {
	RetentionPolicy ConfigRetentionPolicy
	AuthSMTP        Auth
	AuthHTTP        Auth
}

type ConfigRetentionPolicy

type ConfigRetentionPolicy struct {
	MinAge         time.Duration
	EnvelopeCount  *int
	EnvelopeAge    *time.Duration
	AttachmentSize *int64
	TraceAge       *time.Duration
}

func (ConfigRetentionPolicy) EnvelopeAgeTime

func (p ConfigRetentionPolicy) EnvelopeAgeTime() time.Time

func (ConfigRetentionPolicy) MinAgeTime

func (p ConfigRetentionPolicy) MinAgeTime() time.Time

type DTOAttachmentCreate

type DTOAttachmentCreate struct {
	Name string
	Data io.Reader
}

type DTOAttachmentListRequest

type DTOAttachmentListRequest struct {
	Ascending bool
}

type DTOAttachmentListResult

type DTOAttachmentListResult struct {
	PageResult  pagination.PageResult
	Attachments []Attachment
}

type DTOEndpointCreate

type DTOEndpointCreate struct {
	Name              string
	AttachmentDisable bool
	TextDisable       bool
	TitleTemplate     string
	BodyTemplate      string
	Kind              string
	Config            map[string]string
}

type DTOEndpointUpdate

type DTOEndpointUpdate struct {
	ID                int64
	Name              *string
	AttachmentDisable *bool
	TextDisable       *bool
	TitleTemplate     *string
	BodyTemplate      *string
	Kind              *string
	Config            *map[string]string
}

type DTOEnvelopeListRequest

type DTOEnvelopeListRequest struct {
	Search        string
	SearchSubject bool
	SearchText    bool
	Ascending     bool
	Order         dtoEnvelopeField
}

type DTOEnvelopeListResult

type DTOEnvelopeListResult struct {
	PageResult pagination.PageResult
	Envelopes  []Envelope
}

type DTOMessageCreate

type DTOMessageCreate struct {
	Date    time.Time
	Subject string
	From    string
	To      []string
	Text    string
	HTML    string
}

type DTORuleCreate

type DTORuleCreate struct {
	Name       string
	Expression string
	Endpoints  []int64
}

type DTORuleUpdate

type DTORuleUpdate struct {
	ID         int64
	Name       *string
	Expression *string
	Enable     *bool
	Endpoints  *[]int64
}

type DTOTraceListRequest

type DTOTraceListRequest struct {
	Ascending bool
}

type DTOTraceListResult

type DTOTraceListResult struct {
	PageResult pagination.PageResult
	Traces     [][]Trace
}

type DataAttachment

type DataAttachment struct {
	io.Reader
	Attachment Attachment
}

type Endpoint

type Endpoint struct {
	ID                int64 `sql:"primary_key"`
	Internal          bool
	InternalID        sql.NullString
	Name              string
	AttachmentDisable bool
	TextDisable       bool
	TitleTemplate     string
	BodyTemplate      string
	Kind              string
	Config            EndpointConfig
}

type EndpointConfig

type EndpointConfig map[string]string

func (*EndpointConfig) Scan

func (dst *EndpointConfig) Scan(src any) error

func (EndpointConfig) Str

func (c EndpointConfig) Str(key string) string

func (EndpointConfig) StrSlice

func (c EndpointConfig) StrSlice(key string) []string

func (EndpointConfig) Value

func (src EndpointConfig) Value() (driver.Value, error)

type EndpointSchema

type EndpointSchema []EndpointSchemaItem

func (EndpointSchema) Filter

func (e EndpointSchema) Filter(kind string, config EndpointConfig) EndpointConfig

func (EndpointSchema) Get

func (e EndpointSchema) Get(kind string) EndpointSchemaItem

type EndpointSchemaField

type EndpointSchemaField struct {
	Name        string
	Description string
	Example     string
	Key         string
	Multiline   bool
	Optional    bool
}

type EndpointSchemaItem

type EndpointSchemaItem struct {
	Name   string
	Kind   string
	Fields []EndpointSchemaField
}

func (EndpointSchemaItem) Filter

func (e EndpointSchemaItem) Filter(config EndpointConfig) EndpointConfig

type Envelope

type Envelope struct {
	Message     Message
	Attachments []Attachment
}

type EventEnvelopeCreated

type EventEnvelopeCreated struct {
	ID int64
}

type EventEnvelopeDeleted

type EventEnvelopeDeleted struct {
}

type EventMailmanEnqueued

type EventMailmanEnqueued struct {
}

type Field

type Field string

const (
	FieldName          Field = "name"
	FieldExpression    Field = "expression"
	FieldTitleTemplate Field = "title template"
	FieldBodyTemplate  Field = "body template"
	FieldKind          Field = "kind"
	FieldConfig        Field = "config"
)

type FieldError

type FieldError struct {
	Field Field
	Err   error
}

func (FieldError) Error

func (e FieldError) Error() string

func (FieldError) Unwrap

func (e FieldError) Unwrap() error

type Message

type Message struct {
	ID        int64 `sql:"primary_key"`
	CreatedAt Time
	Date      Time
	Subject   string
	From      string
	To        MessageTo
	Text      string
	HTML      string
}

type MessageTo

type MessageTo []string

func (MessageTo) EQ

func (ss MessageTo) EQ(strs ...string) bool

func (*MessageTo) Scan

func (dst *MessageTo) Scan(src any) error

func (MessageTo) Value

func (src MessageTo) Value() (driver.Value, error)

type Rule

type Rule struct {
	ID         int64 `sql:"primary_key"`
	Internal   bool
	InternalID sql.NullString
	Name       string
	Expression string
	Enable     bool
}

type RuleEndpoints

type RuleEndpoints struct {
	Rule      Rule
	Endpoints []Endpoint
}

type Storage

type Storage struct {
	EnvelopeCount   int
	AttachmentCount int
	AttachmentSize  int64
	DatabaseSize    int64
}

type Time

type Time time.Time

func NewTime

func NewTime(time time.Time) Time

func (*Time) Scan

func (dst *Time) Scan(src any) error

func (Time) Time

func (t Time) Time() time.Time

func (Time) Value

func (src Time) Value() (driver.Value, error)

type Trace

type Trace struct {
	ID        int64 `sql:"primary_key"`
	Seq       int
	RequestID string
	Source    string
	Action    string
	Level     TraceLevel
	Data      TraceData
	CreatedAt Time
}

type TraceData

type TraceData []TraceDataKV

func (*TraceData) Scan

func (dst *TraceData) Scan(src any) error

func (TraceData) Value

func (src TraceData) Value() (driver.Value, error)

type TraceDataKV

type TraceDataKV struct {
	Key   string
	Value string
}

func (TraceDataKV) ValueInt64

func (t TraceDataKV) ValueInt64() int64

type TraceLevel

type TraceLevel string

type User

type User struct {
	ID       int64 `sql:"primary_key"`
	Username string
}