> ## Documentation Index
> Fetch the complete documentation index at: https://docs.coldsend.pro/llms.txt
> Use this file to discover all available pages before exploring further.

# Add SMTP email account

> **Connect your own email account via SMTP/IMAP**

Add an email account using SMTP and IMAP credentials. Supports Google Workspace,
Microsoft Outlook 365, and custom email providers.

## Prerequisites

- SMTP and IMAP must be enabled on your email account
- You must use an app-specific password (not your main account password)
- Both SMTP and IMAP connection credentials must work

## Setup Instructions

### Google Workspace
- SMTP: smtp.gmail.com:587 (TLS)
- IMAP: imap.gmail.com:993 (SSL)
- Use App Password, not your main password

### Microsoft Outlook 365
- SMTP: smtp.office365.com:587 (TLS)
- IMAP: outlook.office365.com:993 (SSL)
- Use App Password from security settings

### Custom SMTP
- Use your provider's SMTP/IMAP hostnames and ports
- Port 587 with TLS or 465 with SSL for SMTP
- Port 993 with SSL for IMAP



## OpenAPI

````yaml /public_openapi.json post /api/public/v1/sender-accounts/smtp
openapi: 3.0.3
info:
  title: ColdSend Public API
  description: >-
    Programmatic access to ColdSend for managing cold email campaigns and sender
    accounts.
  version: 1.0.0
  contact:
    name: ColdSend Support
    email: support@coldsend.pro
    url: https://coldsend.pro
servers:
  - url: https://api.coldsend.pro
    description: Production
security:
  - ApiKeyAuth: []
paths:
  /api/public/v1/sender-accounts/smtp:
    post:
      tags:
        - Sender Accounts
      summary: Add SMTP email account
      description: >-
        **Connect your own email account via SMTP/IMAP**


        Add an email account using SMTP and IMAP credentials. Supports Google
        Workspace,

        Microsoft Outlook 365, and custom email providers.


        ## Prerequisites


        - SMTP and IMAP must be enabled on your email account

        - You must use an app-specific password (not your main account password)

        - Both SMTP and IMAP connection credentials must work


        ## Setup Instructions


        ### Google Workspace

        - SMTP: smtp.gmail.com:587 (TLS)

        - IMAP: imap.gmail.com:993 (SSL)

        - Use App Password, not your main password


        ### Microsoft Outlook 365

        - SMTP: smtp.office365.com:587 (TLS)

        - IMAP: outlook.office365.com:993 (SSL)

        - Use App Password from security settings


        ### Custom SMTP

        - Use your provider's SMTP/IMAP hostnames and ports

        - Port 587 with TLS or 465 with SSL for SMTP

        - Port 993 with SSL for IMAP
      operationId: create_smtp_inbox_api_public_v1_sender_accounts_smtp_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SMTPInboxCreateRequest'
        required: true
      responses:
        '201':
          description: SMTP inbox created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SMTPInboxCreateResponse'
        '400':
          description: Invalid request or connection failed
        '401':
          description: Missing or invalid API key
        '403':
          description: Insufficient permissions - requires 'sender_accounts:write' scope
        '409':
          description: Email already connected
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    SMTPInboxCreateRequest:
      properties:
        email_address:
          type: string
          maxLength: 255
          minLength: 5
          title: Email Address
          description: Full email address to connect (e.g., outreach@company.com)
        display_name:
          type: string
          maxLength: 255
          minLength: 1
          title: Display Name
          description: >-
            Display name shown in recipient's inbox (e.g., 'John Smith from
            Company')
        inbox_type:
          type: string
          title: Inbox Type
          description: 'Email provider type: GOOGLE_WORKSPACE, OUTLOOK_365, or CUSTOM_SMTP'
        daily_limit:
          type: integer
          minimum: 1
          title: Daily Limit
          description: >-
            Daily sending limit for this inbox. Recommended: 20-30 for new
            accounts, 50-80 for warming accounts.
          default: 100
        smtp_host:
          type: string
          maxLength: 255
          minLength: 1
          title: Smtp Host
          description: SMTP server hostname (e.g., smtp.gmail.com, smtp.office365.com)
        smtp_port:
          type: integer
          maximum: 65535
          minimum: 1
          title: Smtp Port
          description: SMTP server port (587 for STARTTLS, 465 for SSL)
        smtp_username:
          type: string
          maxLength: 255
          minLength: 1
          title: Smtp Username
          description: SMTP authentication username (usually your email address)
        smtp_password:
          type: string
          maxLength: 500
          minLength: 1
          title: Smtp Password
          description: SMTP password or app-specific password (encrypted at rest)
        smtp_use_tls:
          type: boolean
          title: Smtp Use Tls
          description: Enable TLS encryption for SMTP connection
          default: true
        imap_host:
          type: string
          maxLength: 255
          minLength: 1
          title: Imap Host
          description: IMAP server hostname for reply monitoring
        imap_port:
          type: integer
          maximum: 65535
          minimum: 1
          title: Imap Port
          description: IMAP server port (993 for SSL)
        imap_username:
          type: string
          maxLength: 255
          minLength: 1
          title: Imap Username
          description: IMAP authentication username (usually your email address)
        imap_password:
          type: string
          maxLength: 500
          minLength: 1
          title: Imap Password
          description: IMAP password or app-specific password (encrypted at rest)
        imap_use_ssl:
          type: boolean
          title: Imap Use Ssl
          description: Enable SSL encryption for IMAP connection
          default: true
      type: object
      required:
        - email_address
        - display_name
        - inbox_type
        - smtp_host
        - smtp_port
        - smtp_username
        - smtp_password
        - imap_host
        - imap_port
        - imap_username
        - imap_password
      title: SMTPInboxCreateRequest
      description: >-
        Request to add an SMTP inbox (BYOC: Bring Your Own Credentials).


        Connect your existing email account to ColdSend using SMTP/IMAP
        credentials.

        Supports Google Workspace, Outlook 365, and custom SMTP providers.
    SMTPInboxCreateResponse:
      properties:
        success:
          type: boolean
          title: Success
        message:
          type: string
          title: Message
        inbox_id:
          type: string
          format: uuid
          title: Inbox Id
          description: Created inbox ID
        email_address:
          type: string
          title: Email Address
          description: Email address
        display_name:
          type: string
          title: Display Name
          description: Display name
        inbox_type:
          type: string
          title: Inbox Type
          description: Inbox provider type
        daily_limit:
          type: integer
          title: Daily Limit
          description: Daily send limit
        overall_status:
          type: string
          title: Overall Status
          description: Inbox status
        created_at:
          type: string
          format: date-time
          title: Created At
          description: Creation timestamp
      type: object
      required:
        - success
        - message
        - inbox_id
        - email_address
        - display_name
        - inbox_type
        - daily_limit
        - overall_status
        - created_at
      title: SMTPInboxCreateResponse
      description: Response for SMTP inbox creation.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: API key with format cs_live_xxx

````