도메인, 별칭 등에 프로그래밍 방식으로 액세스 할 수있는 API를 만들었습니다.
API 설명서
이메일 전달 API
목차
라이브러리
현재로서는 아직 API 래퍼를 출시하지 않았지만 가까운 시일 내에 출시할 계획입니다. 이메일 보내기 api@forwardemail.net 특정 프로그래밍 언어의 API 래퍼가 릴리스될 때 알림을 받고 싶은 경우. 그 동안 애플리케이션에서 이러한 권장 HTTP 요청 라이브러리를 사용하거나 단순히 다음을 사용할 수 있습니다. 곱슬 곱슬하다 아래 예에서와 같이.
| 언어 | 도서관 |
|---|---|
| 루비 | 패러데이 |
| 파이썬 | 요청 |
| 자바 | OkHttp |
| PHP | 목구멍 |
| 자바 스크립트 | 슈퍼 에이전트 |
| 노드.js | 슈퍼 에이전트 |
| 가다 | 순 / http |
| .NET | 레스트샤프 |
기본 URI
현재 HTTP 기본 URI 경로는 다음과 같습니다. https://api.forwardemail.net. 레거시 HTTP 기본 URI 경로 https://forwardemail.net:4000 2021년 1월 1일부로 더 이상 사용되지 않습니다.
입증
모든 엔드포인트에는 API 키 요청의 "사용자 이름" 값으로 설정 기본 인증 헤더. 걱정하지 마십시오. 이것이 무엇인지 확실하지 않은 경우 아래에 예가 제공됩니다.
오류
오류가 발생하면 API 요청의 응답 본문에 자세한 오류 메시지가 포함됩니다.
| 암호 | 이름 |
|---|---|
| 200 | OK |
| 400 | 나쁜 요청 |
| 401 | 무단 |
| 403 | 금지 |
| 404 | 찾을 수 없음 |
| 429 | 너무 많은 요청 |
| 500 | 인터넷 서버 오류 |
| 501 | 구현되지 않음 |
| 502 | 나쁜 게이트웨이 |
| 503 | 사용할 수없는 서비스 |
| 504 | 게이트웨이 시간 초과 |
현지화
저희 서비스는 25개 이상의 다른 언어로 번역됩니다. 모든 API 응답 메시지는 API 요청을 하는 사용자가 감지한 마지막 로케일로 번역됩니다. 사용자 정의를 전달하여 이를 재정의할 수 있습니다. Accept-Language 헤더. 이 페이지 하단의 언어 드롭다운을 사용하여 자유롭게 사용해 보십시오.
쪽수 매기기
페이지 매김이 가능할 때 알림을 받으려면 이메일을 보내주십시오. api@forwardemail.net.
계정
계정 만들기
POST /v1/account
| 바디 파라미터 | 필수 | 유형 | 기술 |
|---|---|---|---|
email | 예 | 문자열 (이메일) | 이메일 주소 |
password | 예 | 끈 | 암호 |
요청 예 :
curl -X POST https://api.forwardemail.net/v1/account \
-u API_TOKEN: \
-d "email=user%40gmail.com"
계정 검색
GET /v1/account
요청 예 :
curl -X GET https://api.forwardemail.net/v1/account \
-u API_TOKEN:
계정 업데이트
PUT /v1/account
| 바디 파라미터 | 필수 | 유형 | 기술 |
|---|---|---|---|
email | 아니 | 문자열 (이메일) | 이메일 주소 |
given_name | 아니 | 끈 | 이름 |
family_name | 아니 | 끈 | 성 |
avatar_url | 아니 | 문자열 (URL) | 아바타 이미지에 연결 |
요청 예 :
curl -X PUT https://api.forwardemail.net/v1/account \
-u API_TOKEN: \
-d "email=user%40gmail.com"
도메인
/v1/domains/:domain_name 그들의 경로는 도메인의 ID와 상호 교환 가능하기 때문에 :domain_id. 이는 다음 중 하나를 통해 도메인을 참조할 수 있음을 의미합니다. name 또는 id 값.
도메인 목록
GET /v1/domains
| 쿼리 문자열 파라미터 | 필수 | 유형 | 기술 |
|---|---|---|---|
name | 아니 | 문자열 (RegExp 지원) | 이름으로 도메인 검색 |
alias | 아니 | 문자열 (RegExp 지원) | 별칭 이름으로 도메인 검색 |
recipient | 아니 | 문자열 (RegExp 지원) | 수신자별로 도메인 검색 |
요청 예 :
curl -X GET https://api.forwardemail.net/v1/domains \
-u API_TOKEN:
도메인 만들기
POST /v1/domains
| 바디 파라미터 | 필수 | 유형 | 기술 |
|---|---|---|---|
domain | 예 | 문자열 (FQDN 또는 IP) | 정규화 된 도메인 이름 ( "FQDN") 또는 IP 주소 |
plan | 아니 | 문자열 (열거 가능) | 계획 유형(반드시 "free", "enhanced_protection", 또는 "team", 기본값 "free" 또는 사용자의 현재 유료 요금제가 있는 경우) |
catchall | 아니 | 문자열 (구분 된 이메일 주소) 또는 부울 | 기본 포괄 별칭을 만들고 기본값은 true (만약에 true API 사용자의 이메일 주소를 수신자로 사용합니다. false catch-all이 생성되지 않습니다). 문자열이 전달되면 수신자로 사용할 이메일 주소의 구분된 목록입니다(줄 바꿈, 공백 및/또는 쉼표로 구분). |
has_adult_content_protection | 아니 | 부울 | 이 도메인에서 스팸 스캐너 성인 콘텐츠 보호를 활성화할지 여부 |
has_phishing_protection | 아니 | 부울 | 이 도메인에서 스팸 스캐너 피싱 방지를 활성화할지 여부 |
has_executable_protection | 아니 | 부울 | 이 도메인에서 스팸 스캐너 실행 보호를 활성화할지 여부 |
has_virus_protection | 아니 | 부울 | 이 도메인에서 스팸 스캐너 바이러스 보호를 활성화할지 여부 |
has_recipient_verification | 아니 | 부울 | 별칭 수신자가 이메일이 통과하도록 이메일 확인 링크를 클릭하도록 요구할지 여부에 대한 글로벌 도메인 기본값 |
요청 예 :
curl -X POST https://api.forwardemail.net/v1/domains \
-u API_TOKEN: \
-d domain=example.com \
-d plan=free
도메인 검색
GET /v1/domains/example.com
요청 예 :
curl -X GET https://api.forwardemail.net/v1/domains/example.com \
-u API_TOKEN:
도메인 레코드 확인
GET /v1/domains/example.com/verify-records
요청 예 :
curl -X GET https://api.forwardemail.net/v1/domains/example.com/verify-records \
-u API_TOKEN:
도메인 업데이트
PUT /v1/domains/example.com
| 바디 파라미터 | 필수 | 유형 | 기술 |
|---|---|---|---|
smtp_port | 아니 | 문자열 또는 숫자 | SMTP 전달을 위해 구성할 사용자 지정 포트(기본값은 "25") |
has_adult_content_protection | 아니 | 부울 | 이 도메인에서 스팸 스캐너 성인 콘텐츠 보호를 활성화할지 여부 |
has_phishing_protection | 아니 | 부울 | 이 도메인에서 스팸 스캐너 피싱 방지를 활성화할지 여부 |
has_executable_protection | 아니 | 부울 | 이 도메인에서 스팸 스캐너 실행 보호를 활성화할지 여부 |
has_virus_protection | 아니 | 부울 | 이 도메인에서 스팸 스캐너 바이러스 보호를 활성화할지 여부 |
has_recipient_verification | 아니 | 부울 | 별칭 수신자가 이메일이 통과하도록 이메일 확인 링크를 클릭하도록 요구할지 여부에 대한 글로벌 도메인 기본값 |
요청 예 :
curl -X PUT https://api.forwardemail.net/v1/domains/example.com \
-u API_TOKEN:
도메인 삭제
DELETE /v1/domains/:domain_name
요청 예 :
curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name \
-u API_TOKEN:
초대
도메인 초대 수락
GET /v1/domains/:domain_name/invites
요청 예 :
curl -X GET https://api.forwardemail.net/v1/domains/:domain_name/invites \
-u API_TOKEN:
도메인 초대 만들기
POST /v1/domains/example.com/invites
| 바디 파라미터 | 필수 | 유형 | 기술 |
|---|---|---|---|
email | 예 | 문자열 (이메일) | 도메인 회원 목록에 초대 할 이메일 주소 |
group | 예 | 문자열 (열거 가능) | 사용자를 도메인 구성원에 추가할 그룹(다음 중 하나일 수 있음) "admin" 또는 "user") |
요청 예 :
curl -X POST https://api.forwardemail.net/v1/domains/example.com/invites \
-u API_TOKEN: \
-d "email=user%40gmail.com" \
-d group=admin
도메인 초대 제거
DELETE /v1/domains/:domain_name/invites
| 바디 파라미터 | 필수 | 유형 | 기술 |
|---|---|---|---|
email | 예 | 문자열 (이메일) | 도메인 회원 목록에서 제거 할 이메일 주소 |
요청 예 :
curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name/invites \
-u API_TOKEN:
회원
도메인 멤버 업데이트
PUT /v1/domains/example.com/members/:member_id
| 바디 파라미터 | 필수 | 유형 | 기술 |
|---|---|---|---|
group | 예 | 문자열 (열거 가능) | 사용자를 도메인 구성원으로 업데이트할 그룹(다음 중 하나일 수 있음) "admin" 또는 "user") |
요청 예 :
curl -X PUT https://api.forwardemail.net/v1/domains/example.com/members/:member_id \
-u API_TOKEN:
도메인 회원 제거
DELETE /v1/domains/:domain_name/members/:member_id
요청 예 :
curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name/members/:member_id \
-u API_TOKEN:
별명
도메인 별칭 나열
GET /v1/domains/example.com/aliases
| 쿼리 문자열 파라미터 | 필수 | 유형 | 기술 |
|---|---|---|---|
name | 아니 | 문자열 (RegExp 지원) | 이름으로 도메인의 별칭 검색 |
recipient | 아니 | 문자열 (RegExp 지원) | 수신자별로 도메인의 별칭 검색 |
요청 예 :
curl -X GET https://api.forwardemail.net/v1/domains/example.com/aliases \
-u API_TOKEN:
새 도메인 별칭 만들기
POST /v1/domains/example.com/aliases
| 바디 파라미터 | 필수 | 유형 | 기술 |
|---|---|---|---|
name | 예 | 끈 | 별명 |
recipients | 예 | 문자열 또는 배열 | 수신자 목록 (줄 바꿈 / 공백 / 쉼표로 구분 된 문자열 또는 유효한 전자 메일 주소, 정규화 된 도메인 이름 ( "FQDN"), IP 주소 및 / 또는 웹 후크 URL 배열) |
description | 아니 | 끈 | 별명 설명 |
labels | 아니 | 문자열 또는 배열 | 레이블 목록 (줄 바꿈 / 공백 / 쉼표로 구분 된 문자열 또는 배열이어야 함) |
has_recipient_verification | 아니 | 부울 | 수신자가 이메일이 통과하도록 이메일 확인 링크를 클릭하도록 설정할지 여부(요청 본문에 명시적으로 설정되지 않은 경우 기본값은 도메인 설정) |
is_enabled | 아니 | 부울 | 이 별칭을 사용하지 않도록 설정할지 여부 (사용하지 않으면 전자 메일은 라우팅되지 않지만 상태 코드는 성공적으로 반환 됨) |
요청 예 :
curl -X POST https://api.forwardemail.net/v1/domains/example.com/aliases \
-u API_TOKEN:
도메인 별칭 검색
다음 중 하나를 사용하여 도메인 별칭을 검색할 수 있습니다. id 또는 그것의 name 값.
GET /v1/domains/:domain_name/aliases/:alias_id
요청 예 :
curl https://api.forwardemail.net/v1/domains/:domain_name/aliases/:alias_id \
-u API_TOKEN:
GET /v1/domains/:domain_name/aliases/:alias_name
요청 예 :
curl https://api.forwardemail.net/v1/domains/:domain_name/aliases/:alias_name \
-u API_TOKEN:
도메인 별칭 업데이트
PUT /v1/domains/example.com/aliases/:alias_id
| 바디 파라미터 | 필수 | 유형 | 기술 |
|---|---|---|---|
name | 아니 | 끈 | 별명 |
recipients | 예 | 문자열 또는 배열 | 수신자 목록 (줄 바꿈 / 공백 / 쉼표로 구분 된 문자열 또는 유효한 전자 메일 주소, 정규화 된 도메인 이름 ( "FQDN"), IP 주소 및 / 또는 웹 후크 URL 배열) |
description | 아니 | 끈 | 별명 설명 |
labels | 아니 | 문자열 또는 배열 | 레이블 목록 (줄 바꿈 / 공백 / 쉼표로 구분 된 문자열 또는 배열이어야 함) |
has_recipient_verification | 아니 | 부울 | 수신자가 이메일이 통과하도록 이메일 확인 링크를 클릭하도록 설정할지 여부(요청 본문에 명시적으로 설정되지 않은 경우 기본값은 도메인 설정) |
is_enabled | 아니 | 부울 | 이 별칭을 사용하지 않도록 설정할지 여부 (사용하지 않으면 전자 메일은 라우팅되지 않지만 상태 코드는 성공적으로 반환 됨) |
요청 예 :
curl -X PUT https://api.forwardemail.net/v1/domains/example.com/aliases/:alias_id \
-u API_TOKEN:
도메인 별칭 삭제
DELETE /v1/domains/:domain_name/aliases/:alias_id
요청 예 :
curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name/aliases/:alias_id \
-u API_TOKEN: