Email Accounts

Connect Email Account (SMTP/IMAP)

POST/v1/email-accounts
POST
/v1/email-accounts

Connect Email Account (SMTP/IMAP)

Connect an email account using SMTP/IMAP credentials. Creates the account with all warmup defaults configured and ready to start warmup. The mailbox address is taken from smtp.emailAddress. Set imap.emailAddress only when the IMAP server authenticates on a login different from the mailbox address; when omitted it defaults to smtp.emailAddress.

Authorization

X-Api-Key<token>

In: header

Request Body

application/jsonRequired

fromNamestring

Display name for outgoing mail. Defaults to the mailbox address.

Example: "John Doe"

emailServiceProviderstring

Example: "other"Value in: "gmail" | "gsuite" | "other" | "yahoo" | "zoho" | "godaddy" | "yandex" | "sendgrid" | "mailgun" | "amazonses" | "azure" | "elasticemail" | "mailjet"

smtpobject

imapobject

Responses

201
201 response
{
  "emailAccountId": 123,
  "fromEmail": "user@gmail.com",
  "fromName": "John Doe",
  "type": "gmail",
  "status": "active"
}

Request

curl -X POST \
  "https://lupus-edge.trulyinbox.com/v1/email-accounts" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "fromName": "John Doe",
  "emailServiceProvider": "other",
  "smtp": {
    "emailAddress": "user@example.com",
    "host": "smtp.example.com",
    "port": 587,
    "password": "your-password",
    "encryption": true,
    "userName": "smtp-username"
  },
  "imap": {
    "emailAddress": "user@example.com",
    "host": "imap.example.com",
    "port": 993,
    "password": "your-password",
    "encryption": true
  }
}'

Response

No response body