message

package
v1.8.12 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 16, 2021 License: GPL-3.0 Imports: 38 Imported by: 0

Documentation

Overview

Package message contains set of tools to convert message between Proton API and IMAP format.

Index

Constants

View Source 
const (
	AppleMailJunkFlag      = "$Junk"
	ThunderbirdJunkFlag    = "Junk"
	ThunderbirdNonJunkFlag = "NonJunk"
)

Various client specific flags.

Variables

View Source 
var (
	ErrDecryptionFailed = errors.New("message could not be decrypted")
	ErrNoSuchKeyRing    = errors.New("the keyring to decrypt this message could not be found")
)

Functions

func AttachPublicKey 

func AttachPublicKey(p *parser.Parser, key, keyName string)

func BuildEncrypted 

func BuildEncrypted(m *pmapi.Message, readers []io.Reader, kr *crypto.KeyRing) ([]byte, error)

BuildEncrypted is used for importing encrypted message.

func BuildMIMEBody 

func BuildMIMEBody(p *parser.Parser) (mimeBody string, err error)

BuildMIMEBody builds mime body from the parser returned by NewParser.

func EncryptRFC822 

func EncryptRFC822(kr *crypto.KeyRing, r io.Reader) ([]byte, error)

func GetEnvelope 

func GetEnvelope(msg *pmapi.Message, header textproto.MIMEHeader) *imap.Envelope

GetEnvelope will prepare envelope from pmapi message and cached header.

func GetFlags 

func GetFlags(m *pmapi.Message) (flags []string)

GetFlags returns imap flags from pmapi message attributes.

func HeaderLines 

func HeaderLines(header []byte) [][]byte

HeaderLines returns each line in the given header.

func Parse 

func Parse(r io.Reader) (m *pmapi.Message, mimeBody, plainBody string, attReaders []io.Reader, err error)

Parse parses RAW message.

func ParserWithParser 

func ParserWithParser(p *parser.Parser) (m *pmapi.Message, plainBody string, attReaders []io.Reader, err error)

ParserWithParser parses message from Parser without building MIME body.

func SanitizeMessageDate 

func SanitizeMessageDate(msgTime int64) time.Time

SanitizeMessageDate will return time from msgTime timestamp. If timestamp is not after epoch the RFC822 publish day will be used. No message should realistically be older than RFC822 itself.

func WriteHeader 

func WriteHeader(w io.Writer, h textproto.MIMEHeader) (err error)

Types

type BodyStructure 

type BodyStructure map[string]*SectionInfo

BodyStructure is used to parse an email into MIME sections and then generate body structure for IMAP server.

func DeserializeBodyStructure 

func DeserializeBodyStructure(raw []byte) (*BodyStructure, error)

DeserializeBodyStructure will create new structure from msgpack bytes.

func NewBodyStructure 

func NewBodyStructure(reader io.Reader) (structure *BodyStructure, err error)

func (*BodyStructure) GetMailHeader 

func (bs *BodyStructure) GetMailHeader() (header textproto.MIMEHeader, err error)

GetMailHeader returns the main header of mail.

func (*BodyStructure) GetMailHeaderBytes 

func (bs *BodyStructure) GetMailHeaderBytes(wholeMail io.ReadSeeker) (header []byte, err error)

GetMailHeaderBytes returns the bytes with main mail header. Warning: It can contain extra lines or multipart comment.

func (*BodyStructure) GetSection 

func (bs *BodyStructure) GetSection(wholeMail io.ReadSeeker, sectionPath []int) (section []byte, err error)

GetSection returns bytes of section including MIME header.

func (*BodyStructure) GetSectionContent 

func (bs *BodyStructure) GetSectionContent(wholeMail io.ReadSeeker, sectionPath []int) (section []byte, err error)

GetSectionContent returns bytes of section content (excluding MIME header).

func (*BodyStructure) GetSectionHeader 

func (bs *BodyStructure) GetSectionHeader(sectionPath []int) (header textproto.MIMEHeader, err error)

GetSectionHeader returns the mime header of specified section.

func (*BodyStructure) GetSectionHeaderBytes 

func (bs *BodyStructure) GetSectionHeaderBytes(wholeMail io.ReadSeeker, sectionPath []int) (header []byte, err error)

func (*BodyStructure) IMAPBodyStructure 

func (bs *BodyStructure) IMAPBodyStructure(currentPart []int) (imapBS *imap.BodyStructure, err error)

IMAPBodyStructure will prepare imap bodystructure recurently for given part. Use empty path to create whole email structure.

func (*BodyStructure) Parse 

func (bs *BodyStructure) Parse(r io.Reader) error

Parse will read the mail and create all body structures.

func (*BodyStructure) Serialize 

func (bs *BodyStructure) Serialize() ([]byte, error)

Serialize will write msgpack bytes.

type BuildJob 

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

func (*BuildJob) GetResult 

func (job *BuildJob) GetResult() ([]byte, error)

GetResult returns the build result or any error which occurred during building. If the result is not ready yet, it blocks.

type Builder 

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

func NewBuilder 

func NewBuilder(fetchWorkers, attachWorkers, buildWorkers int) *Builder

NewBuilder creates a new builder which manages the given number of fetch/attach/build workers.

  • fetchWorkers: the number of workers which fetch messages from API
  • attachWorkers: the number of workers which fetch attachments from API.
  • buildWorkers: the number of workers which decrypt/build RFC822 message literals.

NOTE: Each fetch worker spawns a unique set of attachment workers! There can therefore be up to fetchWorkers*attachWorkers simultaneous API connections.

The returned builder is ready to handle jobs -- see (*Builder).NewJob for more information.

Call (*Builder).Done to shut down the builder and stop all workers.

func (*Builder) Done 

func (b *Builder) Done()

Done shuts down the builder and stops all workers.

func (*Builder) NewJob 

func (b *Builder) NewJob(ctx context.Context, api Fetcher, messageID string) *BuildJob

NewJob tells the builder to begin building the message with the given ID. The result (or any error which occurred during building) can be retrieved from the returned job when available.

func (*Builder) NewJobWithOptions 

func (b *Builder) NewJobWithOptions(ctx context.Context, api Fetcher, messageID string, opts JobOptions) *BuildJob

NewJobWithOptions creates a new job with custom options. See NewJob for more information.

type Fetcher 

type Fetcher interface {
	GetMessage(context.Context, string) (*pmapi.Message, error)
	GetAttachment(context.Context, string) (io.ReadCloser, error)
	KeyRingForAddressID(string) (*crypto.KeyRing, error)
}

type JobOptions 

type JobOptions struct {
	IgnoreDecryptionErrors bool // Whether to ignore decryption errors and create a "custom message" instead.
	SanitizeDate           bool // Whether to replace all dates before 1970 with RFC822's birthdate.
	AddInternalID          bool // Whether to include MessageID as X-Pm-Internal-Id.
	AddExternalID          bool // Whether to include ExternalID as X-Pm-External-Id.
	AddMessageDate         bool // Whether to include message time as X-Pm-Date.
	AddMessageIDReference  bool // Whether to include the MessageID in References.
}

type SectionInfo 

type SectionInfo struct {
	Header                    textproto.MIMEHeader
	Start, BSize, Size, Lines int
	// contains filtered or unexported fields
}

SectionInfo is used to hold data about parts of each section.

func (*SectionInfo) Read 

func (si *SectionInfo) Read(p []byte) (n int, err error)

Read will also count the final size of section.

Source Files

View all Source files

Directories

Path Synopsis
Package mocks is a generated GoMock package.
 Package mocks is a generated GoMock package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.