이메일 API

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

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

모든 엔드포인트에는 API 키 요청의 "사용자 이름" 값으로 설정 기본 인증 헤더(예외 포함) 별칭 연락처, 별칭 달력, 그리고 별칭 사서함 를 사용하는 생성된 별칭 사용자 이름 및 비밀번호)..

걱정하지 마세요. 이것이 무엇인지 확실하지 않다면 아래에 예를 들어 설명하겠습니다.

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

[!TIP] 5xx 상태 코드를 받으면(발생해서는 안 되는 일이지만) 다음 주소로 문의해 주세요. api@forwardemail.net 문제를 즉시 해결할 수 있도록 도와드리겠습니다.

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

[!NOTE] 2024년 11월 1일부터 API 엔드포인트는 도메인 목록 그리고 도메인 별칭 나열 기본값으로 설정됩니다 1000 페이지당 최대 결과. 이 동작에 일찍 참여하려면 다음을 통과할 수 있습니다. ?paginate=true 엔드포인트 쿼리에 대한 URL에 추가 쿼리문자열 매개변수로 사용합니다.

페이지 매김은 결과를 나열하는 모든 API 엔드포인트에서 지원됩니다.

쿼리 문자열 속성을 제공하기만 하면 됩니다. page (그리고 선택적으로 limit).

부동산 page 숫자보다 크거나 같아야 합니다. 1. 당신이 제공하는 경우 limit (숫자도 있음) 그러면 최소값은 다음과 같습니다. 10 그리고 최대값은 50 (다른 언급이 없는 한).

더 많은 결과가 있는지 확인하기 위해 다음과 같은 HTTP 응답 헤더를 제공합니다(프로그래밍 방식으로 페이지를 나누기 위해 구문 분석 가능):

요청 예 :

curl https://api.forwardemail.net/v1/domains/example.com/aliases?page=2&pagination=true \
  -u API_TOKEN:

로그 검색

당사의 API를 통해 프로그래밍 방식으로 귀하의 계정에 대한 로그를 다운로드할 수 있습니다. 이 엔드포인트에 요청을 제출하면 계정에 대한 모든 로그가 처리되어 첨부 파일(지압(Gzip) 압축 CSV 스프레드시트 파일)이 완료되면

이를 통해 백그라운드 작업을 생성할 수 있습니다. 크론 작업 또는 우리를 사용하여 Node.js 작업 예약 소프트웨어 Bree 원할 때마다 로그를 받을 수 있습니다. 이 끝점은 다음으로 제한됩니다. 10 일일 요청.

첨부 파일은 소문자 형태입니다. email-deliverability-logs-YYYY-MM-DD-h-mm-A-z.csv.gz 이메일 자체에는 검색된 로그에 대한 간략한 요약이 포함되어 있습니다. 다음에서 언제든지 로그를 다운로드할 수도 있습니다. 내 계정 → 로그

GET /v1/logs/download

요청 예 :

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

Cron 작업 예시(매일 자정):

0 0 * * * /usr/bin/curl https://api.forwardemail.net/v1/logs/download -u API_TOKEN: &>/dev/null

다음과 같은 서비스를 사용할 수 있습니다. Crontab.guru cron 작업 표현식 구문을 검증합니다.

예시 Cron 작업(매일 자정) 그리고 전날의 로그와 함께):

MacOS의 경우:

0 0 * * * /usr/bin/curl https://api.forwardemail.net/v1/logs/download?q=`date -v-1d -u "+%-m/%-d/%y"` -u API_TOKEN: &>/dev/null

Linux 및 Ubuntu의 경우:

0 0 * * * /usr/bin/curl https://api.forwardemail.net/v1/logs/download?q=`date --date "-1 days" -u "+%-m/%-d/%y"` -u API_TOKEN: &>/dev/null

계정 만들기

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"

[!NOTE] 다른 API 엔드포인트와 달리 이것들은 다음을 요구합니다. 입증 "사용자 이름"은 별칭 사용자 이름과 동일하고 "비밀번호"는 기본 인증 헤더로 생성된 별칭 비밀번호와 동일합니다.

[!경고] 이 엔드포인트 섹션은 진행 중이며 (희망적으로) 2024년에 출시될 예정입니다. 그동안 웹사이트 탐색의 "앱" 드롭다운에서 IMAP 클라이언트를 사용하세요.

연락처 목록

GET /v1/contacts

출시 예정

연락처 만들기

POST /v1/contacts

출시 예정

연락처 검색

GET /v1/contacts/:id

출시 예정

연락처 업데이트

PUT /v1/contacts/:id

출시 예정

연락처 삭제

DELETE /v1/contacts/:id

출시 예정

[!NOTE] 다른 API 엔드포인트와 달리 이것들은 다음을 요구합니다. 입증 "사용자 이름"은 별칭 사용자 이름과 동일하고 "비밀번호"는 기본 인증 헤더로 생성된 별칭 비밀번호와 동일합니다.

[!경고] 이 엔드포인트 섹션은 진행 중이며 (희망적으로) 2024년에 출시될 예정입니다. 그동안 웹사이트 탐색의 "앱" 드롭다운에서 IMAP 클라이언트를 사용하세요.

달력 목록

GET /v1/calendars

출시 예정

캘린더 만들기

POST /v1/calendars

출시 예정

달력 검색

GET /v1/calendars/:id

출시 예정

캘린더 업데이트

PUT /v1/calendars/:id

출시 예정

캘린더 삭제

DELETE /v1/calendars/:id

출시 예정

[!NOTE] 다른 API 엔드포인트와 달리 이것들은 다음을 요구합니다. 입증 "사용자 이름"은 별칭 사용자 이름과 동일하고 "비밀번호"는 기본 인증 헤더로 생성된 별칭 비밀번호와 동일합니다.

[!경고] 이 엔드포인트 섹션은 진행 중이며 (희망적으로) 2024년에 출시될 예정입니다. 그동안 웹사이트 탐색의 "앱" 드롭다운에서 IMAP 클라이언트를 사용하세요.

귀하의 도메인에 대한 설정 지침을 꼭 따르세요.

이러한 지침은 FAQ 섹션에서 찾을 수 있습니다. IMAP를 사용하여 이메일을 수신하는 것을 지원하시나요?.

메시지 목록 및 검색

GET /v1/messages

출시 예정

메시지 작성

[!NOTE] 이것은 NOT 이메일을 보내세요. 메시지를 사서함 폴더에 추가하는 것만 가능합니다(예: IMAP와 유사합니다. APPEND 명령). 이메일을 보내려면 다음을 참조하세요. 아웃바운드 SMTP 이메일 생성 아래. 아웃바운드 SMTP 이메일을 만든 후, 이 엔드포인트를 사용하여 별칭의 사서함에 복사본을 추가하여 저장할 수 있습니다.

POST /v1/messages

출시 예정

메시지 검색

GET /v1/messages/:id

출시 예정

메시지 업데이트

PUT /v1/messages/:id

출시 예정

메시지 삭제

DELETE /v1/messages:id

출시 예정

[!TIP] 폴더 경로가 있는 폴더 엔드포인트 /v1/folders/:path 그들의 엔드포인트는 폴더의 ID와 호환 가능합니다. :id. 즉, 폴더를 다음 중 하나로 참조할 수 있습니다. path 또는 id 값.

[!경고] 이 엔드포인트 섹션은 진행 중이며 (희망적으로) 2024년에 출시될 예정입니다. 그동안 웹사이트 탐색의 "앱" 드롭다운에서 IMAP 클라이언트를 사용하세요.

폴더 목록

GET /v1/folders

출시 예정

폴더 생성

POST /v1/folders

출시 예정

폴더 검색

GET /v1/folders/:id

출시 예정

폴더 업데이트

PUT /v1/folders/:id

출시 예정

폴더 삭제

DELETE /v1/folders/:id

출시 예정

폴더 복사

POST /v1/folders/:id/copy

출시 예정

귀하의 도메인에 대한 설정 지침을 꼭 따르세요.

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

아웃바운드 SMTP 이메일 제한 받기

이는 다음을 포함하는 JSON 객체를 반환하는 간단한 엔드포인트입니다. count 그리고 limit 계정당 일일 SMTP 아웃바운드 메시지 수입니다.

GET /v1/emails/limit

요청 예 :

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

아웃바운드 SMTP 이메일 나열

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

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

GET /v1/emails

요청 예 :

curl https://api.forwardemail.net/v1/emails?limit=1 \
  -u API_TOKEN:

아웃바운드 SMTP 이메일 생성

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

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

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

이 API 엔드포인트는 헤더(예: 제목줄)에서 이모지가 발견되면 자동으로 이를 인코딩합니다. Subject: 🤓 Hello 로 변환됩니다 Subject: =?UTF-8?Q?=F0=9F=A4=93?= Hello 자동으로). 우리의 목표는 개발자에게 매우 친화적이고 더미 테스트가 가능한 이메일 API를 만드는 것이었습니다.

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`"

아웃바운드 SMTP 이메일 검색

GET /v1/emails/:id

요청 예 :

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

아웃바운드 SMTP 이메일 삭제

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

DELETE /v1/emails/:id

요청 예 :

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

[!TIP] 도메인 이름을 가진 도메인 엔드포인트 /v1/domains/:domain_name 그들의 엔드포인트는 도메인 ID와 상호 교환 가능합니다. :domain_id. 이는 다음 중 하나를 통해 도메인을 참조할 수 있음을 의미합니다. name 또는 id 값.

도메인 목록

[!NOTE] 2024년 11월 1일부터 API 엔드포인트는 도메인 목록 그리고 도메인 별칭 나열 기본값으로 설정됩니다 1000 페이지당 최대 결과. 이 동작에 일찍 참여하려면 다음을 통과할 수 있습니다. ?paginate=true 엔드포인트 쿼리의 URL에 대한 추가 쿼리 문자열 매개변수로. 참조 쪽수 매기기 더 많은 통찰력을 위해.

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:

도메인 SMTP 레코드 확인

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

요청 예 :

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

도메인 전체의 포괄적인 비밀번호 나열

GET /v1/domains/example.com/catch-all-passwords

요청 예 :

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

도메인 전체에 적용되는 포괄적인 비밀번호 생성

POST /v1/domains/example.com/catch-all-passwords

요청 예 :

curl BASE_URL/v1/domains/example.com/catch-all-passwords \
  -u API_TOKEN:

도메인 전체의 포괄적인 비밀번호 제거

DELETE /v1/domains/example.com/catch-all-passwords/:token_id

요청 예 :

curl -X DELETE https://api.forwardemail.net/v1/domains/:domain_name/catch-all-passwords/:token_id \
  -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:

별칭 비밀번호 생성

지침을 이메일로 보내지 않으면 성공적인 요청의 JSON 응답 본문에 사용자 이름과 비밀번호가 다음 형식으로 포함됩니다. { username: 'alias@yourdomain.com', password: 'some-generated-password' }.

POST /v1/domains/example.com/aliases/:alias_id/generate-password

요청 예 :

curl -X POST https://api.forwardemail.net/v1/domains/example.com/aliases/:alias_id/generate-password \
  -u API_TOKEN:

도메인 별칭 나열

[!NOTE] 2024년 11월 1일부터 API 엔드포인트는 도메인 목록 그리고 도메인 별칭 나열 기본값으로 설정됩니다 1000 페이지당 최대 결과. 이 동작에 일찍 참여하려면 다음을 통과할 수 있습니다. ?paginate=true 엔드포인트 쿼리의 URL에 대한 추가 쿼리 문자열 매개변수로. 참조 쪽수 매기기 더 많은 통찰력을 위해.

GET /v1/domains/example.com/aliases

요청 예 :

curl https://api.forwardemail.net/v1/domains/example.com/aliases?pagination=true \
  -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:

무료 플랜에서도 기록을 무료로 암호화할 수 있습니다. 개인정보 보호는 하나의 기능이 되어서는 안 되며, 제품의 모든 측면에 본질적으로 내장되어야 합니다. 많은 요청에 따라 개인 정보 보호 가이드 토론 그리고 계속 우리 GitHub 문제 우리는 이것을 추가했습니다.

TXT 레코드 암호화

POST /v1/encrypt

요청 예 :

curl -X POST https://api.forwardemail.net/v1/encrypt \
  -d "input=user@gmail.com"