Skip to content

Commit

Permalink
Merge branch 'release/0.3.0'
Browse files Browse the repository at this point in the history
  • Loading branch information
jhillyerd committed Nov 1, 2018
2 parents 85654db + f66f852 commit d07d9bb
Show file tree
Hide file tree
Showing 28 changed files with 906 additions and 315 deletions.
6 changes: 2 additions & 4 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,7 @@ before_script:
- go get golang.org/x/lint/golint

after_success:
- if [[ "$TRAVIS_GO_VERSION" == 1.9.* ]]; then $HOME/gopath/bin/goveralls -service=travis-ci; fi
- if [[ "$TRAVIS_GO_VERSION" == 1.11.* ]]; then $HOME/gopath/bin/goveralls -service=travis-ci; fi

go:
- 1.9.x
- "1.10"
- 1.11.x
- "1.11.x"
25 changes: 25 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,30 @@ Change Log
All notable changes to this project will be documented in this file.
This project adheres to [Semantic Versioning](http://semver.org/).

## [0.3.0] - 2018-11-01

### Added
- CLI utils now output inlines and other parts in addition to attachments.
- Clone() method to Envelope and Part (thanks to nerdlich.)
- GetHeaderKeys() method to Envelope (thanks to allenluce.)
- GetHeaderValues() plus a suite of setters for Envelope (thanks to nerdlich.)

### Changed
- Use value instead of pointer receivers and return types on MailBuilder
methods. Cleaner API, but may break some users.
- `enmime.Error` now conforms to the Go error interface, its `String()` method
is now deprecated.
- `NewPart()` constructor no longer takes a parent parameter.
- Part.Errors now holds pointers, matching Envelope.Errors.

### Fixed
- Content is now populated for binary-only mails root part (thank to ostcar.)

### Removed
- Part no longer implements `io.Reader`, content is stored as a byte slice in
`Part.Content` instead.


## [0.2.1] - 2018-10-20

### Added
Expand Down Expand Up @@ -31,6 +55,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).
- Initial implementation of MIME encoding, using `enmime.MailBuilder`

[Unreleased]: https://github.com/jhillyerd/enmime/compare/master...develop
[0.3.0]: https://github.com/jhillyerd/enmime/compare/v0.2.1...v0.3.0
[0.2.1]: https://github.com/jhillyerd/enmime/compare/v0.2.0...v0.2.1
[0.2.0]: https://github.com/jhillyerd/enmime/compare/v0.1.0...v0.2.0

Expand Down
25 changes: 12 additions & 13 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,26 +1,22 @@
PKG := enmime
SHELL := /bin/sh

SRC := $(shell find . -type f -name '*.go' -not -path "./vendor/*")
PKGS := $$(go list ./... | grep -v /vendor/)
PKGS := $(shell go list ./... | grep -v /vendor/)

.PHONY: all build clean fmt install lint simplify test
.PHONY: all build clean fmt lint reflex simplify test

all: test lint install
all: clean test lint build

clean:
go clean
go clean $(PKGS)

deps:
go get -t ./...
go get ./...

build: clean deps
build:
go build

install: build
go install

test: clean deps
test:
go test -race ./...

fmt:
Expand All @@ -31,5 +27,8 @@ simplify:

lint:
@test -z "$(shell gofmt -l . | tee /dev/stderr)" || echo "[WARN] Fix formatting issues with 'make fmt'"
@golint -set_exit_status $${PKGS}
@go vet $${PKGS}
@golint -set_exit_status $(PKGS)
@go vet $(PKGS)

reflex:
reflex -r '\.go$$' -- sh -c 'echo; date; echo; go test ./... && echo ALL PASS'
17 changes: 7 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
enmime
================================================================================

# enmime
[![GoDoc](https://godoc.org/github.com/jhillyerd/enmime?status.png)][GoDoc]
[![Build Status](https://travis-ci.org/jhillyerd/enmime.png?branch=master)][Build Status]
[![Go Report Card](https://goreportcard.com/badge/github.com/jhillyerd/enmime)][Go Report Card]
Expand All @@ -13,18 +11,17 @@ parsing MIME encoded emails. It is being developed in tandem with the
enmime includes a fluent interface builder for generating MIME encoded messages,
see the wiki for example [Builder Usage].

API documentation can be found here:
API documentation and examples can be found here:
http://godoc.org/github.com/jhillyerd/enmime

A brief guide to migrating from the old go.enmime API is available here:
https://github.com/jhillyerd/enmime/wiki/Enmime-Migration-Guide

## API Changes

## API Change Warning
Part readers: `Part.Read()` and `Part.Utf8Reader` have been removed. Please use
`Part.Content` instead.

Part readers: `Part.Read()` and `Part.Utf8Reader` are now deprecated. Please
use `Part.Content` instead. The deprecated readers will be removed in April
2018.
A brief guide to migrating from the old 2016 go.enmime API is available here:
https://github.com/jhillyerd/enmime/wiki/Enmime-Migration-Guide


## Development Status
Expand Down
Loading

0 comments on commit d07d9bb

Please sign in to comment.