Create Mail Config

POST

http://localhost:18321/v1/mail/create

Proxy the remote open-api mail/create endpoint. Use JSON strings for complex structured fields. In manual + imap/smtp scenarios, password, imap, and smtp are required.

Request

Body Params multipart/form-dataRequired

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'http://localhost:18321/v1/mail/create' \
--form 'token="{{token}}"' \
--form 'nickname="Demo mail"' \
--form 'raw_mail="de***@example.com"' \
--form 'provider_id="cuiqiu"' \
--form 'password="******"' \
--form 'auth_type="manual"' \
--form 'receive_protocol_type="imap"' \
--form 'send_protocol_type="smtp"' \
--form 'backend_type="imap_smtp"' \
--form 'smtp="{\"auth_type\":\"password\",\"host\":\"smtp.example.com\",\"mail\":\"de***@example.com\",\"password\":\"******\",\"port\":465,\"ssl_type\":\"ssl\"}"' \
--form 'imap="{\"auth_type\":\"password\",\"host\":\"imap.example.com\",\"mail\":\"de***@example.com\",\"password\":\"******\",\"port\":993,\"ssl_type\":\"ssl\"}"' \
--form 'pop="{}"' \
--form 'oauth_conf="{\"access_token\":\"******\",\"refresh_token\":\"******\"}"' \
--form 'remark="Created via API example"' \
--form 'proxy_id=""' \
--form 'backend_conf="{\"mode\":\"imap_smtp\",\"receive_protocol_type\":\"imap\",\"send_protocol_type\":\"smtp\"}"' \
--form 'capabilities_json="{}"' \
--form 'provider_meta="{}"' \
--form 'avatar="https://example.com/avatar/demo.png"'

Responses

🟢200

application/json

Success

Body

Example

{
    "code": 200,
    "msg": "ok",
    "data": {
        "mail_id": "mail_demo_new_001",
        "mail": "de***@example.com",
        "user_id": "user_demo_001",
        "group_id": "",
        "proxy_id": "",
        "provider_id": "cuiqiu",
        "auth_type": "manual",
        "remark": "Created via API example",
        "status": 1,
        "created_at": 1775785594,
        "updated_at": 0,
        "mail_profile": {
            "mail_id": "mail_demo_new_001",
            "raw_mail": "de***@example.com",
            "nickname": "",
            "avatar": "",
            "password": "",
            "created_at": 1775785594,
            "updated_at": 0
        }
    }
}

Modified at 2026-04-10 06:29:30

Sync Mail Config To Local

Update Mail Config