Test custom email server
Check that a login to an email server works. Nothing is saved and nothing changes for your clients. Use it before POST /reseller/identity/smtp/save.
Reseller accounts only. Request access.
Email server host name.
Email server port, usually 587 for starttls or 465 for ssl.
Login name.
Login password. Leave it blank to use the saved password.
curl -X POST 'https://backend.omnidim.io/api/v1/reseller/identity/smtp/test' \ -H 'Authorization: Bearer YOUR_API_KEY' \ -H 'Content-Type: application/json' \ -d '{ "host": "smtp.acme.example", "port": 587, "username": "mailer@acme.example", "encryption": "starttls" }'
{ "success": true }
BearerAuthAuthorizationBearer <token>Bearer token authentication. Obtain your API key from the OmniDimension dashboard.
application/jsonhost*stringEmail server host name.
port*integerEmail server port, usually 587 for starttls or 465 for ssl.
username?stringLogin name.
password?stringLogin password. Leave it blank to use the saved password.
encryption?string"starttls""starttls""ssl""none"from_email?stringAddress your clients' emails are sent from.
Response body
application/jsonThe login worked.
application/jsonsuccess?booleanSave custom email server
Send your clients' emails through your own email server, so they come from your domain. The server is checked with a live login before anything is saved. If the login fails, nothing changes and the response is 400 with the reason. Save your brand first.
Disable custom email server
Stop sending your clients' emails through your own email server. Their emails go back to the default sender. The saved server and its login are kept, so you can switch it on again with POST /reseller/identity/smtp/save. Your brand is not changed.