Skip to content

This Project helps user to benchmark speed of sending mail. 📧

Notifications You must be signed in to change notification settings

pepipost/Email-scale-tester

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 

Repository files navigation

Pepipost as Email-scale-tester 🏋

Introduction

Being Developer our first priority of starting implemention of any product is POC(proof of concept). Great POC requires great benchmark but benchmarking with different tools sometime becomes messy. We are trying to make an utility which can be used flexibly either by UI or command line.

This Project will help users to benchmark email sending speed no matter whether it is local smtp or third party api. Since this has to be made generic everyone can use this without any efforts.

What should be my contribution ?

  • contribution will be building Scale-tester mentioned with requirement below using any coding language.

    • Smtp scale tester (reference)

    • Api scale tester (reference)

    • you can build a UI with backend.

      OR

    • you can build a command line interface.

How can i start my contribution ?

  • You can just have read through this great article which will help you in contribution to this project, followed by our CONTRIBUTING.md

  • Sign-up to pepipost for apikey which will be required for your Utilities in order to make scale-tester for pepipost-API, activate your account and send your first test mail using our sandbox domain.

  • Pepipost APIs from our developers documentation (in order to test pepipost API Scale-test)

Reference / utilities

  • Smtp Scale tester
pepi-smtp-scaler -h 'smtp.myhost.com' -P 587/25 -t 'anything@sink.pepipost.com' -tmails 10000 -n 5 

options are
-h        host of smtpmail
-P        Port no you want to connect
-t        to emailid for load testing (it varies from client to client)
-tmails   total no of mails you need to test 
-n        no of parallel node you want to trigger

Output 
connection time :: 0.100ms          time taken for connection
sending speed   :: 100 mails/sec    time taken in seconds/mintues for sending email
network speed   :: 10 mbps          network speed while testing
  • APIs Scale tester
pepi-api-scaler -h 'https://api.sommething.com/sendemail/' -f 'something@mydomain.com' -t 'anything@sink.pepipost.com' -tmails 100000 -n 10

 options are
-h        host of smtpmail
-P        Port no you want to connect
-t        to emailid for load testing (it varies from client to client)
-tmails   total no of mails you need to test 
-n        no of parallel node you want to trigger

Output 
connection time :: 0.100ms          time taken for connection
sending speed   :: 100 mails/sec    time taken in seconds/mintues for sending email
network speed   :: 10 mbps          network speed while testing

Note :: addition of parameters in input and output is mandatory. Reference can be taken from apache ab

Tips :: use SDK for pepi-api-scaler 😀

What are requirements to get my pull request(PRs) accepted ?

  • Brief introduction of your challenge and making.
  • Prerequisites.
  • Installation Guide.
  • Example
  • Usage cases for each functionality.
  • Blog representing you hard work.

You can publish your challenge by creating a pull request here in this reposistory.

cheers 🍺

All the Best 👍

Happy Coding...! 🎉

About

This Project helps user to benchmark speed of sending mail. 📧

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published