Skip to content

Latest commit

 

History

History
84 lines (59 loc) · 4.51 KB

README.md

File metadata and controls

84 lines (59 loc) · 4.51 KB

Truemail lightweight rack based web API docker image

Docker Cloud Build Status GitHub release (latest by date) Docker Image Size Docker Pulls GitHub Gitter Contributor Covenant

Truemail rack docker image 🐳 - lightweight rack based web API dockerized image of Truemail server. Verify email via Regex, DNS, SMTP and even more. Be sure that email address valid and exists.

Actual and maintainable documentation 📚 for developers is living here.

Table of Contents

Intro

From Ruby gem to microservice, or where did it all begins? Slides here.

Usage

List of available Truemail server options, represented as environment variables. Example of usage with docker-compose (Truemail rack image hosted on dockerhub):

# docker-compose.yml

version: "3.7"

services:
  truemail:
    image: truemail/truemail-rack:v0.10.0 # for latest version you can use just truemail/truemail-rack:latest
    ports:
      - 9292:9292
    environment:
      VERIFIER_EMAIL: your_email@example.com
      ACCESS_TOKENS: your_token
    tty: true

Truemail family

All Truemail solutions: https://truemail-rb.org

Name Type Description
truemail ruby gem Configurable framework agnostic plain Ruby email validator, main core
truemail-go go package Configurable Golang email validator, main core
truemail server ruby app Lightweight rack based web API wrapper for Truemail
truemail-ruby-client ruby gem Truemail web API client library for Ruby
truemail-crystal-client crystal shard Truemail web API client library for Crystal
truemail-java-client java lib Truemail web API client library for Java
truemail-rspec ruby gem Truemail configuration and validator RSpec helpers

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/truemail-rb/truemail-rack-docker-image. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct. Please check the open tickets. Be sure to follow Contributor Code of Conduct below and our Contributing Guidelines.

License

The image is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Truemail project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.

Credits

Versioning

truemail-rack-docker-image uses Semantic Versioning 2.0.0