Mailboxes

Test a mailbox sign-in

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
post/api/v1/inboxes/smtp/test

Request

  • Base URL: https://app.argorant.com
  • URL: https://app.argorant.com/api/v1/inboxes/smtp/test
  • Auth: HTTP bearer

Headers

Idempotency-Keystring

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.

X-Request-Idstring

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.

Request body

emailstring email required

The mailbox address that sends.

preset'zoho' | 'zoho_eu' | 'zoho_personal' | 'fastmail' | 'godaddy' | 'titan' | 'hostinger' | 'ionos' | 'ionos_de' | 'ionos_uk' | 'namecheap' | 'yahoo' | 'icloud' | 'outlook' | 'other'

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

smtp_hoststring

Server for sending. Needed without a preset.

smtp_portinteger

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

smtp_secure'ssl' | 'starttls' | 'none'

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

smtp_usernamestring

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

smtp_passwordstring password required

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

imap_hoststring

Server for reading replies. Needed without a preset.

imap_portinteger

Port for reading replies.

imap_secure'ssl' | 'starttls' | 'none'

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

imap_usernamestring

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

imap_passwordstring password

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

Example request

{
  "email": "elena@northgate-advisory.com",
  "preset": "zoho",
  "smtp_host": "smtppro.zoho.com",
  "smtp_port": 587,
  "imap_host": "imappro.zoho.com"
}

Response

Works or Does not work or Works on 587

worksboolean

true when both sending and reading replies work.

messagestring

A one-sentence summary.

Changes

No recorded changes to this operation across all 1 revision of this API.