Update an SMTP/IMAP mailbox
PATCH
Updates the credentials of an SMTP or Google IMAP mailbox, retests them and marks the mailbox as connected again. Masked passwords (********) are replaced by the stored values before the test.
Authorization
apiKey Authorization<token>
Your 48 character API key, sent as is (a Bearer prefix is tolerated). Create it at https://v3.emelia.io/settings/api.
In: header
Path Parameters
providerId*string
Email provider id.
Match
^[0-9a-fA-F]{24}$Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
SMTP and IMAP credentials of the mailbox. The credentials are tested before saving. For Google and Microsoft accounts prefer the OAuth connection in the app.
Response Body
application/json
application/json
application/json
application/json
curl -X PATCH "https://example.com/email-providers/6650f1a2b839d80011c5a0aa" \ -H "Authorization: YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "senderName": "Marie Martin", "senderEmail": "marie.martin@yourcompany.com", "senderPassword": "your-mailbox-password", "emailType": "GOOGLE", "smtp": { "login": "marie.martin@yourcompany.com", "password": "your-mailbox-password", "server": "smtp.yourcompany.com", "port": 587, "ssl": true }, "imap": { "login": "marie.martin@yourcompany.com", "password": "your-mailbox-password", "server": "imap.yourcompany.com", "port": 993, "ssl": true }, "domainName": "track.yourcompany.com" }'{ "success": true, "id": "6650f1a2b839d80011c5a0f1"}