- 검색 페이지
- 목차
이메일 API
라이브러리
현재로서는 아직 API 래퍼를 출시하지 않았지만 가까운 시일 내에 출시할 계획입니다. 이메일 보내기 api@forwardemail.net 특정 프로그래밍 언어의 API 래퍼가 릴리스될 때 알림을 받고 싶은 경우. 그 동안 애플리케이션에서 이러한 권장 HTTP 요청 라이브러리를 사용하거나 단순히 다음을 사용할 수 있습니다. 곱슬 곱슬하다 아래 예에서와 같이.
언어 | 도서관 |
---|---|
루비 | 패러데이 |
파이썬 | 요청 |
자바 | 알았어Http |
PHP | 목구멍 |
자바 스크립트 | 슈퍼 에이전트 (우리는 관리자입니다) |
노드.js | 슈퍼 에이전트 (우리는 관리자입니다) |
가다 | 순 / http |
.NET | 레스트샤프 |
기본 URI
현재 HTTP 기본 URI 경로는 다음과 같습니다. https://api.forwardemail.net
.
입증
오류
오류가 발생하면 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 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"
이메일
도메인에 대한 설정 지침을 따랐는지 확인하십시오. 이 지침은 다음에서 찾을 수 있습니다. 내 계정 → 도메인 → 설정 → 아웃바운드 SMTP 구성. 도메인에서 아웃바운드 SMTP를 보내려면 DKIM, 반환 경로 및 DMARC를 설정해야 합니다.
이메일 나열
이 엔드포인트는 이미 생성된 이메일을 반환하지 않습니다. message
, headers
, accepted
, 도 rejectedErrors
속성.
해당 속성과 해당 값을 반환하려면 다음을 사용하십시오. 이메일 검색 이메일 ID가 있는 엔드포인트.
이 끝점은 최대 반환합니다. 50
결과를 한번에. 여러 페이지를 쿼리하려면 다음을 추가하세요. ?page=NUMBER
어디 NUMBER
정수입니다. ?page=1
.
GET /v1/emails
쿼리 문자열 파라미터 | 필수 | 유형 | 기술 |
---|---|---|---|
q | 아니 | 문자열 (RegExp 지원) | 메타데이터로 이메일 검색 |
domain | 아니 | 문자열 (RegExp 지원) | 도메인 이름으로 이메일 검색 |
page | 아니 | 숫자 | 결과를 반환할 페이지(기본값은 1 ) |
`한계 | 아니 | 숫자 | 반환할 페이지당 결과 수(기본값은 50 – 최대값은 50 그리고 최소값은 10 ) |
요청 예 :
curl https://api.forwardemail.net/v1/emails \
-u API_TOKEN:
이메일 작성
이메일 작성을 위한 API는 Nodemailer의 메시지 옵션 구성에서 영감을 받아 이를 활용합니다. 로 연기해주세요 Nodemailer 메시지 구성 아래의 모든 신체 매개변수에 대해.
를 제외하고 참고하세요. envelope
그리고 dkim
(자동으로 설정하므로) 모든 Nodemailer 옵션을 지원합니다. 자동으로 설정 disableFileAccess
그리고 disableUrlAccess
옵션 true
보안 목적으로.
다음 중 하나의 단일 옵션을 전달해야 합니다. raw
헤더를 포함한 원시 전체 이메일 또는 아래의 개별 본문 매개변수 옵션을 전달합니다.
POST /v1/emails
바디 파라미터 | 필수 | 유형 | 기술 |
---|---|---|---|
from | 아니 | 문자열 (이메일) | 보낸 사람의 이메일 주소(도메인의 별칭으로 존재해야 함). |
to | 아니 | 문자열 또는 배열 | 쉼표로 구분된 목록 또는 "To" 헤더의 수신자 배열입니다. |
cc | 아니 | 문자열 또는 배열 | 쉼표로 구분된 목록 또는 "Cc" 헤더에 대한 수신자 배열입니다. |
bcc | 아니 | 문자열 또는 배열 | 쉼표로 구분된 목록 또는 "Bcc" 헤더에 대한 수신자 배열입니다. |
subject | 아니 | 끈 | 이메일의 제목입니다. |
text | 아니 | 문자열 또는 버퍼 | 메시지의 일반 텍스트 버전입니다. |
html | 아니 | 문자열 또는 버퍼 | 메시지의 HTML 버전입니다. |
attachments | 아니 | 정렬 | 부착 개체의 배열(참조 Nodemailer의 공통 필드). |
sender | 아니 | 끈 | "Sender" 헤더의 이메일 주소(참조 Nodemailer의 고급 필드). |
replyTo | 아니 | 끈 | "Reply-To" 헤더의 이메일 주소입니다. |
inReplyTo | 아니 | 끈 | 메시지가 회신되는 Message-ID입니다. |
references | 아니 | 문자열 또는 배열 | 공백으로 구분된 목록 또는 Message-ID의 배열입니다. |
attachDataUrls | 아니 | 부울 | 만약에 true 그런 다음 변환 data: 포함된 첨부 파일에 대한 메시지의 HTML 콘텐츠에 있는 이미지. |
watchHtml | 아니 | 끈 | 메시지의 Apple Watch 특정 HTML 버전(Nodemailer 문서에 따르면, 최신 시계는 이것을 설정할 필요가 없습니다). |
amp | 아니 | 끈 | 메시지의 AMP4EMAIL 특정 HTML 버전(참조 Nodemailer의 예). |
icalEvent | 아니 | 물체 | 대체 메시지 내용으로 사용할 iCalendar 이벤트(참조: Nodemailer의 캘린더 이벤트). |
alternatives | 아니 | 정렬 | 대체 메시지 내용의 배열(참조 Nodemailer의 대체 콘텐츠). |
encoding | 아니 | 끈 | 텍스트 및 HTML 문자열에 대한 인코딩(기본값은 "utf-8" , 그러나 지원 "hex" 그리고 "base64" 인코딩 값도 포함). |
raw | 아니 | 문자열 또는 버퍼 | 사용할 사용자 지정 생성 RFC822 형식 메시지(Nodemailer에서 생성한 메시지 대신 – 참조) Nodemailer의 커스텀 소스). |
textEncoding | 아니 | 끈 | 텍스트 값에 강제로 사용되는 인코딩(또는 "quoted-printable" 또는 "base64" ). 기본값은 감지된 가장 가까운 값입니다(ASCII 사용의 경우). "quoted-printable" ). |
priority | 아니 | 끈 | 이메일의 우선순위 수준(다음 중 하나일 수 있음) "high" , "normal" (기본값) 또는 "low" ). 값은 "normal" 우선 순위 헤더를 설정하지 않습니다(기본 동작임). 값이 "high" 또는 "low" 설정되면 X-Priority , X-MSMail-Priority , 그리고 Importance 헤더 그에 따라 설정됩니다. |
headers | 아니 | 개체 또는 배열 | 설정할 추가 헤더 필드의 객체 또는 배열(참조 Nodemailer의 커스텀 헤더). |
messageId | 아니 | 끈 | "Message-ID" 헤더에 대한 선택적 Message-ID 값(설정되지 않은 경우 기본값이 자동으로 생성됨 – 값은 RFC2822 사양 준수). |
date | 아니 | 문자열 또는 날짜 | 구문 분석 후 날짜 헤더가 누락된 경우 사용되는 선택적 날짜 값입니다. 그렇지 않으면 설정되지 않은 경우 현재 UTC 문자열이 사용됩니다. 날짜 헤더는 현재 시간보다 30일 이전일 수 없습니다. |
list | 아니 | 물체 | 선택적 객체 List-* 헤더(참조 Nodemailer의 목록 헤더). |
요청 예 :
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:
도메인
/v1/domains/:domain_name
그들의 경로는 도메인의 ID와 상호 교환 가능하기 때문에 :domain_id
. 이는 다음 중 하나를 통해 도메인을 참조할 수 있음을 의미합니다. name
또는 id
값.
도메인 목록
GET /v1/domains
쿼리 문자열 파라미터 | 필수 | 유형 | 기술 |
---|---|---|---|
q | 아니 | 문자열 (RegExp 지원) | 이름으로 도메인 검색 |
name | 아니 | 문자열 (RegExp 지원) | 이름으로 도메인 검색 |
요청 예 :
curl 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 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
바디 파라미터 | 필수 | 유형 | 기술 |
---|---|---|---|
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 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
쿼리 문자열 파라미터 | 필수 | 유형 | 기술 |
---|---|---|---|
q | 아니 | 문자열 (RegExp 지원) | 이름, 레이블 또는 수신자로 도메인에서 별칭 검색 |
name | 아니 | 문자열 (RegExp 지원) | 이름으로 도메인의 별칭 검색 |
recipient | 아니 | 문자열 (RegExp 지원) | 수신자별로 도메인의 별칭 검색 |
요청 예 :
curl https://api.forwardemail.net/v1/domains/example.com/aliases \
-u API_TOKEN:
새 도메인 별칭 만들기
POST /v1/domains/example.com/aliases
바디 파라미터 | 필수 | 유형 | 기술 |
---|---|---|---|
name | 아니 | 끈 | 별칭 이름(제공되지 않거나 비어 있으면 임의의 별칭이 생성됨) |
recipients | 아니 | 문자열 또는 배열 | 수신자 목록(줄 바꿈/공백/쉼표로 구분되어야 함) 유효한 이메일 주소, 정규화된 도메인 이름("FQDN"), IP 주소 및/또는 웹후크 URL의 문자열 또는 배열 – 제공되지 않거나 비어 있는 경우 배열, 그러면 API 요청을 하는 사용자의 이메일이 수신자로 설정됨) |
description | 아니 | 끈 | 별명 설명 |
labels | 아니 | 문자열 또는 배열 | 레이블 목록 (줄 바꿈 / 공백 / 쉼표로 구분 된 문자열 또는 배열이어야 함) |
has_recipient_verification | 아니 | 부울 | 수신자가 이메일이 통과하도록 이메일 확인 링크를 클릭하도록 설정할지 여부(요청 본문에 명시적으로 설정되지 않은 경우 기본값은 도메인 설정) |
is_enabled | 아니 | 부울 | 이 별칭을 활성화할지 비활성화할지 여부(비활성화하면 이메일이 아무데도 라우팅되지 않고 성공적인 상태 코드를 반환함). 기본값은 true , 그러나 값이 전달되면 다음을 사용하여 부울로 변환됩니다. 부울) |
요청 예 :
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: