REST API 문서

GET/api/email/{domain}/{user}/

페이지가 매겨진 사용자 이메일 목록을 가져옵니다. 목록 응답에는 메타데이터만 포함됩니다(아니요 body / html_body).

매개변수	위치	설명
domain	길	이메일 도메인(예: example.com
user	길	사용자 이름(예: testuser
page	쿼리, 선택 사항	페이지 번호(기본값 1)
limit	쿼리, 선택 사항	페이지당 항목 수(기본값 20, 최대 100)

curl -X GET "https://BASE_URL/api/email/example.com/testuser/?page=1&limit=20"

{
  "emails": [
    {
      "id": 123,
      "subject": "Welcome",
      "sender": "[email protected]",
      "date": "2026-09-30T10:30:00.000Z",
      "has_attachments": false,
      "size": 1234
    }
  ],
  "total": 5,
  "page": 1,
  "limit": 20,
  "has_more": false
}

GET/api/email/{domain}/{user}/{email_id}

이메일의 전체 세부정보를 확인하세요.

curl -X GET "https://BASE_URL/api/email/example.com/testuser/123"

DELETE/api/email/{domain}/{user}/{email_id}

특정 이메일을 삭제합니다.

curl -X DELETE "https://BASE_URL/api/email/example.com/testuser/123"

{ "status": "deleted" }

POST/api/add-domain/{domain}

새 도메인을 추가하거나 기존 도메인의 온라인 상태를 업데이트하세요. 도메인에는 허용될 시스템의 호스트 이름을 가리키는 MX 레코드가 있어야 합니다(상태 added, is_online: true).

curl -X POST "https://BASE_URL/api/add-domain/newdomain.com"

// 성공적으로 추가되었습니다
{ "status": "added", "domain": "newdomain.com", "is_online": true }

// 기존 도메인: 상태 업데이트
{ "status": "updated", "domain": "newdomain.com", "is_online": false }

GET/api/all-domains/ & /api/random-domains/

모든 온라인 도메인(비공개, 토큰 필요):

curl -X GET "https://BASE_URL/api/all-domains/" \
  -H "X-Domain-Token: YOUR_TOKEN"

무작위 온라인 도메인(공개):

curl -X GET "https://BASE_URL/api/random-domains/?limit=10"

{ "domains": ["domain1.com", "domain2.com"], "total": 2 }

GET/api/check-mx/{domain}

도메인에 시스템을 가리키는 유효한 MX 레코드가 있는지 확인하세요.

curl -X GET "https://BASE_URL/api/check-mx/example.com"

{ "result": "online" }   // 또는 "offline"

오류 처리

암호	의미
200	성공
400	잘못된 요청(예: 잘못된 도메인/이메일)
401	프라이빗 엔드포인트에 대한 누락되거나 잘못된 토큰
404	이메일을 찾을 수 없습니다
429	비율 제한을 초과했습니다.

{ "detail": "Domain not found" }

중요 사항

• 이메일 주소는 다음 형식을 사용해야 합니다. [email protected]
• 유효한 MX 레코드가 있는 도메인만 '온라인' 상태입니다.
• 이메일과 비활성 도메인은 다음 이후에 자동으로 삭제됩니다. 3일
• 서비스만 수신 이메일 - 전송 및 SMTP 릴레이는 지원되지 않습니다.
• API는 IP당 속도 제한을 적용합니다.
• 라이브 서비스의 경우 3일 보존 기간이 적용됩니다. 백업은 복사본을 더 오래 보관할 수 있습니다. 그 당시에는 모든 복사본의 영구 삭제가 보장되지 않습니다.
• 사용자 정의 도메인 받은 편지함은 공개 상태로 유지되며 타사 서비스에 의해 차단될 수 있습니다. 수락 및 배송이 보장되지 않습니다.