Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add input.debug = true for debugging purposes #1349

Open
3 tasks
amaury1093 opened this issue Oct 11, 2023 · 0 comments
Open
3 tasks

Add input.debug = true for debugging purposes #1349

amaury1093 opened this issue Oct 11, 2023 · 0 comments

Comments

@amaury1093
Copy link
Member

amaury1093 commented Oct 11, 2023

Feature Request

Add an optional debug field in the request, which, if true, will output debug info in the output.

Problem

A lot of people wonder why an email verification fails. Add debugging info via the API will save debugging time.

Solution

{
   "to_email": "[email protected]",
+  "debug": true
}

Which, if set, will also add a new debug field in the response, which gives additional info about how Reacher performed the verification. Things like:

  • how much time the whole verification took?
  • how many SMTP connections did it make? 1, or 2 (to avoid greylisting), or 0 (using API or headless browser)
  • the full SMTP handshake logs

Example:

{
 "is_reachable": "unknown",
  // -- snip --
 "debug": {
   "time_elapsed": 10539, // in ms
   "smtp": {
     "method": "smtp", // or "api" or "headless"
     // fields below will depend on "method" above
     "smtp_connections": 2,
     "logs": [
       ">> STARTTLS<CRLF>",
       "<< 220 TLS go ahead<CRLF>"
       // -- snip --
     ]
   }
}

Notes

For new contributors: This is a good issue to get to know the codebase. It's also possible to do this feature piecewise: a first good step might be to simply add the time_elapsed field

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant