forms

package

v0.0.4 Latest Latest Go to latest Published: Jun 23, 2021 License: Apache-2.0 Imports: 15 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/ainsleyclark/verbis

Documentation ¶

Index ¶

Constants
Variables
func ToStruct(form domain.Form) interface{}
type Attachment
- func (a *Attachment) SizeMB() int
type Attachments
- func (a Attachments) ToMail() mail.Attachments
type Reader
- func NewReader(form *domain.Form, path string) *Reader
- func (r *Reader) Values() (domain.FormValues, Attachments, error)
type Sender

Constants ¶

View Source

const (
	// The total upload limit allowed to upload file
	// attachments.
	UploadLimit = 5
)

Variables ¶

View Source

var (
	// AllowedMimes represents the mime types permitted
	// to be attached to forms.
	AllowedMimes = []string{
		"text/plain",
		"image/jpeg",
		"image/png",
		"image/svg+xml",
		"application/pdf",
		"application/msword",
		"application/vnd.ms-word.document.macroenabled.12",
		"application/vnd.openxmlformats-officedocument.wordprocessingml.document",
		"application/msword",
	}
)

Functions ¶

func ToStruct ¶

func ToStruct(form domain.Form) interface{}

Struct returns the dynamic struct used for validation.

Types ¶

type Attachment ¶

type Attachment struct {
	MIMEType string
	Filename string
	MD5name  string
	Data     []byte
	Size     int64
}

Attachment defines the mail file that has been uploaded via the forms endpoint. It contains useful information for sending files over the mail driver.

func (*Attachment) SizeMB ¶

func (a *Attachment) SizeMB() int

SizeMB

Returns the attachment file size in megabytes.

type Attachments ¶

type Attachments []Attachment

Attachments defines the slice of mail attachments

func (Attachments) ToMail ¶

func (a Attachments) ToMail() mail.Attachments

type Reader ¶

type Reader struct {
	Form        *domain.Form
	Reader      dynamicstruct.Reader
	StoragePath string
}

func NewReader ¶

func NewReader(form *domain.Form, path string) *Reader

func (*Reader) Values ¶

func (r *Reader) Values() (domain.FormValues, Attachments, error)

type Sender ¶

type Sender struct {
	Attachments []Attachment
	Fields      domain.FormValues
}

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL