Git Product home page Git Product logo

api.unverified.email's Introduction

unverified.email

Build status

Unverified.email helps testing if the applications send emails correctly.

This is the code that powers the api.

When working with emails in the applications I write, I often need a way to verify that what is being sent out includes all the data that I wanted the emails to contain and that it is in the right format.

Usually I would set up mailhog or mailtrap server. I hope that this could be useful to have a service that might help others too, although I understand that it might be too simple for now. Please open an issue with suggestions you have in mind on how to improve it. I will consider carefully if to implement them though :)

Usage

  1. Issue a GET request to https://api.unverified.email/create The response will contain a mailbox that for sending emails to
  2. Issue a GET request to https://api.unverified.email/receive/<mailbox_id> to receive all the emails that have been sent to that address

Notes:

  • Warning: the service is not yet finalised. However I am very certain it can be used by developers and in your pipelines and we can iron out the small kinks together if they appear. Just open an issue please, if something needs attention.
  • You can create as many mailboxes as you want.
  • The mailboxes and your emails will be stored for 5 minutes only, after which They will be deleted. So do use the /create endpoint freely.
  • The /receive endpoint will wait for emails to be delivered for at least 15 seconds, so you should not need to hit the url repeatedly.

Developing

There is a ./do bash script in the root folder that provides shortcuts to most of the tasks. I guess the deploy command won't work for you since you don't have credentials to ssh to unverified.email servers, but everything else should work fine.

  • you will need the haskell tool stack, to build and test the project.
  • you will need hlint, and shellcheck installed to run the lint checks.

api.unverified.email's People

Contributors

kevcui avatar ptek avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.