ArgorantDocs

Test a mailbox sign-in

posthttps://app.argorant.com/api/v1/inboxes/smtp/test
POST
/api/v1/inboxes/smtp/test

The mailbox address that sends.

An email provider from the presets. Fills every empty server name, port and security setting.

Server for sending. Needed without a preset.

Port for sending. Use 587. If you send 465, Argorant tries 587 with starttls and saves 587 when it works. Needed without a preset.

Security for sending, starttls on port 587. Leave out to pick it from the port.

Sign-in name for sending. Leave out when it is the email address.

The password, or an app password when the provider asks for one. Stored encrypted, never returned.

Server for reading replies. Needed without a preset.

Port for reading replies.

Security for reading replies. Leave out to use ssl on port 993 and starttls on port 143.

Sign-in name for reading replies. Leave out to use the one for sending.

Password for reading replies. Leave out to use the one for sending.

Signs in to a mailbox from any email provider twice, once to send (SMTP) and once to read replies (IMAP), and says for each whether it works or what is wrong. Nothing is saved and no email is sent. Google and Microsoft mailboxes connect with their own sign-in instead. Up to 30 tests an hour.

CostWhat it doesKey scopes
FreeReads onlyargorant:manage_lists

Authorization

BearerAuth
AuthorizationBearer <token>

Your API key from app.argorant.com/profile, sent as Authorization: Bearer <key>. A connector sign-in token (ag_mcp_...) works the same way.

In: header

Header Parameters

Idempotency-Key?string

Any unique text up to 128 characters. A retry with the same key and the same body within 24 hours returns the first answer (with the header Idempotent-Replayed: true) instead of doing the work twice. The same key with another body answers 409 idempotency_conflict.

Lengthlength <= 128
X-Request-Id?string

Your own id for this request, 8 to 64 letters, digits, dot, dash or underscore. Returned as X-Request-Id; one is made for you when you send none.

Match^[A-Za-z0-9._-]{8,64}$

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

Shell
curl -X POST "https://app.argorant.com/api/v1/inboxes/smtp/test" \  -H "Idempotency-Key: 6f1c2e7a-run-42" \  -H "Content-Type: application/json" \  -d '{    "email": "elena@northgate-advisory.com",    "preset": "zoho",    "smtp_password": "app-password"  }'

JSON
{  "works": true,  "message": "Sign-in worked for sending and for reading replies.",  "smtp": {    "works": true,    "result": "signed_in",    "message": "Sending works."  },  "imap": {    "works": true,    "result": "signed_in",    "message": "Reading replies works."  }}