PlatformDocs
MCP server

add_email_account

Connect an existing mailbox to a website for sending outreach, using its SMTP (sending) and IMAP (reading replies) settings.

View as Markdown

Connect mailbox · Changes data

Connect an existing mailbox to a website for sending outreach, using its SMTP (sending) and IMAP (reading replies) settings. Use purchase_outreach_domains instead to buy new domains with ready-made mailboxes. websiteId comes from list_websites. Each new mailbox uses one of the account's mailbox slots (error "You can't create more email accounts" when none are left); connecting an address the website already has updates that mailbox instead. The credentials are not tested by this call. A new mailbox starts at 2 campaign emails a day and ramps to 20 a day over 4 weeks; warmup stays off until you call toggle_warmup. Returns the saved mailbox (its _id is the emailAccountId) without its passwords.

ConnectionAccount URL, team member URL or OAuth

Parameters

ParameterTypeRequiredAcceptsDescription
websiteIdstringYesanyWebsite id (24 hex characters) from list_websites.
emailstringYesanyThe mailbox's from-address, e.g. jane@acme.example.
fullNamestringYesanySender name shown on outgoing mail, e.g. Jane Doe. The first word becomes the first name, the rest the last name.
smtpEmailstringYesanySMTP login username, usually the same as email.
smtpHoststringYesanySMTP server host name, e.g. smtp.example.com.
smtpPortnumberYesanySMTP port, e.g. 465 (TLS) or 587.
smtpTLSbooleanNoanyUse TLS for SMTP. Default true.
imapEmailstringYesanyIMAP login username, usually the same as email.
imapHoststringYesanyIMAP server host name, e.g. imap.example.com.
imapPortnumberYesanyIMAP port, usually 993.
imapTLSbooleanNoanyUse TLS for IMAP. Default true.

Tool definition

What your assistant receives from tools/list:

{
  "name": "add_email_account",
  "title": "Connect mailbox",
  "annotations": {
    "title": "Connect mailbox",
    "readOnlyHint": false,
    "destructiveHint": false,
    "idempotentHint": true,
    "openWorldHint": false
  },
  "inputSchema": {
    "type": "object",
    "properties": {
      "websiteId": {
        "type": "string",
        "description": "Website id (24 hex characters) from list_websites."
      },
      "email": {
        "type": "string",
        "description": "The mailbox's from-address, e.g. jane@acme.example."
      },
      "fullName": {
        "type": "string",
        "description": "Sender name shown on outgoing mail, e.g. Jane Doe. The first word becomes the first name, the rest the last name."
      },
      "smtpEmail": {
        "type": "string",
        "description": "SMTP login username, usually the same as email."
      },
      "smtpHost": {
        "type": "string",
        "description": "SMTP server host name, e.g. smtp.example.com."
      },
      "smtpPort": {
        "type": "number",
        "description": "SMTP port, e.g. 465 (TLS) or 587."
      },
      "smtpTLS": {
        "type": "boolean",
        "description": "Use TLS for SMTP. Default true."
      },
      "imapEmail": {
        "type": "string",
        "description": "IMAP login username, usually the same as email."
      },
      "imapHost": {
        "type": "string",
        "description": "IMAP server host name, e.g. imap.example.com."
      },
      "imapPort": {
        "type": "number",
        "description": "IMAP port, usually 993."
      },
      "imapTLS": {
        "type": "boolean",
        "description": "Use TLS for IMAP. Default true."
      }
    },
    "required": [
      "websiteId",
      "email",
      "fullName",
      "smtpHost",
      "smtpPort",
      "smtpEmail",
      "smtpPassword",
      "imapHost",
      "imapPort",
      "imapEmail",
      "imapPassword"
    ]
  }
}

On this page