mailschema

README

mailschema

The Mail Action Protocol 0.3 artifacts for Go, embedded byte for byte as mailschema.org publishes them: the profile record, the JSON-LD context, and the core, type contract and implementation record schemas. The profile record binds the context and the first two schemas by SHA-256.

go get github.com/mailschema/go@v0.3.0

schema, err := mailschema.Bytes(mailschema.CoreSchema)

Bytes returns an independent copy of ProfileRecord, ContextDocument, CoreSchema, ContractSchema or ImplementationSchema. Schema validation alone does not establish a valid description; see the specification.

Source: mailschema/go. License: MIT.

Documentation

Overview

Package mailschema carries the Mail Action Protocol 0.3 artifacts byte for byte as mailschema.org publishes them: the profile record, the JSON-LD context, and the core, type contract and implementation record schemas. The profile record binds the context and the first two schemas by SHA-256.

Index

• Constants
• func Bytes(name Artifact) ([]byte, error)
• type Artifact

Constants

const Context = "https://mailschema.org/contexts/map-0.3.jsonld"

Context is the JSON-LD context every MAP 0.3 description names.

const Profile = "https://mailschema.org/profiles/map/0.3"

Profile is the MAP profile these artifacts define.

Functions

func Bytes

func Bytes(name Artifact) ([]byte, error)

Bytes returns an independent copy of a bundled artifact's exact bytes.

Types

type Artifact

type Artifact string

Artifact names a bundled file.

const (
	ProfileRecord        Artifact = "profile.json"
	ContextDocument      Artifact = "context.jsonld"
	CoreSchema           Artifact = "core.schema.json"
	ContractSchema       Artifact = "contract.schema.json"
	ImplementationSchema Artifact = "implementation.schema.json"
)