이메일 API

현재로서는 아직 API 래퍼를 출시하지 않았지만 가까운 시일 내에 출시할 계획입니다. 이메일 보내기 api@forwardemail.net 특정 프로그래밍 언어의 API 래퍼가 릴리스될 때 알림을 받고 싶은 경우. 그 동안 애플리케이션에서 이러한 권장 HTTP 요청 라이브러리를 사용하거나 단순히 다음을 사용할 수 있습니다. 곱슬 곱슬하다 아래 예에서와 같이.

현재 HTTP 기본 URI 경로는 다음과 같습니다. https://api.forwardemail.net.

모든 엔드포인트에는 API 키 요청의 "사용자 이름" 값으로 설정 기본 인증 헤더. 걱정하지 마십시오. 이것이 무엇인지 확실하지 않은 경우 아래에 예가 제공됩니다.

오류가 발생하면 API 요청의 응답 본문에 자세한 오류 메시지가 포함됩니다.

저희 서비스는 25개 이상의 다른 언어로 번역됩니다. 모든 API 응답 메시지는 API 요청을 하는 사용자가 감지한 마지막 로케일로 번역됩니다. 사용자 정의를 전달하여 이를 재정의할 수 있습니다. Accept-Language 헤더. 이 페이지 하단의 언어 드롭다운을 사용하여 자유롭게 사용해 보십시오.

페이지 매김이 가능할 때 알림을 받으려면 이메일을 보내주십시오. api@forwardemail.net.

계정 만들기

POST /v1/account

요청 예 :

curl -X POST https://api.forwardemail.net/v1/account \
  -u API_TOKEN: \
  -d "email=user%40gmail.com"

계정 검색

GET /v1/account

요청 예 :

curl https://api.forwardemail.net/v1/account \
  -u API_TOKEN:

계정 업데이트

PUT /v1/account

요청 예 :

curl -X PUT https://api.forwardemail.net/v1/account \
  -u API_TOKEN: \
  -d "email=user%40gmail.com"

도메인에 대한 설정 지침을 따랐는지 확인하십시오. 이 지침은 다음에서 찾을 수 있습니다. 내 계정 → 도메인 → 설정 → 아웃바운드 SMTP 구성. 도메인에서 아웃바운드 SMTP를 보내려면 DKIM, 반환 경로 및 DMARC를 설정해야 합니다.

이메일 나열

이 엔드포인트는 이미 생성된 이메일을 반환하지 않습니다. message, headers, accepted, 도 rejectedErrors 속성.

해당 속성과 해당 값을 반환하려면 다음을 사용하십시오. 이메일 검색 이메일 ID가 있는 엔드포인트.

이 끝점은 최대 반환합니다. 50 결과를 한번에. 여러 페이지를 쿼리하려면 다음을 추가하세요. ?page=NUMBER 어디 NUMBER 정수입니다. ?page=1.

GET /v1/emails

요청 예 :

curl https://api.forwardemail.net/v1/emails \
  -u API_TOKEN:

이메일 작성

이메일 작성을 위한 API는 Nodemailer의 메시지 옵션 구성에서 영감을 받아 이를 활용합니다. 로 연기해주세요 Nodemailer 메시지 구성 아래의 모든 신체 매개변수에 대해.

를 제외하고 참고하세요. envelope 그리고 dkim (자동으로 설정하므로) 모든 Nodemailer 옵션을 지원합니다. 자동으로 설정 disableFileAccess 그리고 disableUrlAccess 옵션 true 보안 목적으로.

다음 중 하나의 단일 옵션을 전달해야 합니다. raw 헤더를 포함한 원시 전체 이메일 또는 아래의 개별 본문 매개변수 옵션을 전달합니다.

POST /v1/emails

요청 예 :

curl -X POST https://api.forwardemail.net/v1/emails \
  -u API_TOKEN: \
  -d "from=alias@example.com" \
  -d "to=user%40gmail.com" \
  -d "subject=test" \
  -d "text=test"

요청 예 :

curl -X POST https://api.forwardemail.net/v1/emails \
  -u API_TOKEN: \
  -d "raw=`cat file.eml`"

이메일 검색

GET /v1/emails/:id

요청 예 :

curl https://api.forwardemail.net/v1/emails/:id \
  -u API_TOKEN:

이메일 삭제

이메일 삭제는 상태를 다음으로 설정합니다. "rejected" (그리고 이후 대기열에서 처리하지 않음) 현재 상태가 다음 중 하나인 경우에만 "pending", "queued", 또는 "deferred". 이메일이 생성 및/또는 전송된 후 30일이 지나면 이메일이 자동으로 삭제될 수 있습니다. 따라서 클라이언트, 데이터베이스 또는 애플리케이션에 발신 SMTP 이메일 사본을 보관해야 합니다. 원하는 경우 데이터베이스에서 이메일 ID 값을 참조할 수 있습니다. 이 값은 둘 다에서 반환됩니다. 이메일 작성 그리고 이메일 검색 끝점.

DELETE /v1/emails/:id

요청 예 :

curl -X DELETE https://api.forwardemail.net/v1/emails/:id \
  -u API_TOKEN:

도메인 목록

GET /v1/domains

요청 예 :

curl https://api.forwardemail.net/v1/domains \
  -u API_TOKEN:

도메인 만들기

POST /v1/domains

요청 예 :

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 https://api.forwardemail.net/v1/domains/example.com \
  -u API_TOKEN:

도메인 레코드 확인

GET /v1/domains/example.com/verify-records

요청 예 :

curl https://api.forwardemail.net/v1/domains/example.com/verify-records \
  -u API_TOKEN:

도메인 업데이트

PUT /v1/domains/example.com

요청 예 :

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 https://api.forwardemail.net/v1/domains/:domain_name/invites \
  -u API_TOKEN:

도메인 초대 만들기

POST /v1/domains/example.com/invites

요청 예 :

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

요청 예 :

curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name/invites \
  -u API_TOKEN:

도메인 멤버 업데이트

PUT /v1/domains/example.com/members/:member_id

요청 예 :

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

요청 예 :

curl https://api.forwardemail.net/v1/domains/example.com/aliases \
  -u API_TOKEN:

새 도메인 별칭 만들기

POST /v1/domains/example.com/aliases

요청 예 :

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

요청 예 :

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: