Skip to main content
설명서에 자주 업데이트를 게시하며 이 페이지의 번역이 계속 진행 중일 수 있습니다. 최신 정보는 영어 설명서를 참조하세요.

전자 메일

REST API를 사용하여 인증된 사용자의 이메일 주소를 관리합니다.

전자 메일 관리 정보

요청 URL에 매개 변수가 {username} 포함되어 있지 않으면 로그인한 사용자에 대한 응답이 됩니다.{ % ifversion fpt or ghes or ghec %} 사용자가 2단계 인증을 사용할 수 있는지 여부와 같은 추가 개인 정보는 기본 인증 또는 OAuth user 를 통해 인증될 때 범위에 포함됩니다.{ % endif %}

List email addresses for the authenticated user

Lists all of your email addresses, and specifies which one is visible to the public. This endpoint is accessible with the user:email scope.

"List email addresses for the authenticated user"에 대한 매개 변수

헤더
Name, 형식, 설명
accept string

Setting to application/vnd.github+json is recommended.

쿼리 매개 변수
Name, 형식, 설명
per_page integer

The number of results per page (max 100).

기본값: 30

page integer

Page number of the results to fetch.

기본값: 1

"List email addresses for the authenticated user"에 대한 HTTP 응답 상태 코드

상태 코드Description
200

OK

304

Not modified

401

Requires authentication

403

Forbidden

404

Resource not found

"List email addresses for the authenticated user"에 대한 코드 샘플

get/user/emails
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ http(s)://HOSTNAME/api/v3/user/emails

Response

Status: 200
[ { "email": "octocat@github.com", "verified": true, "primary": true, "visibility": "public" } ]

Add an email address for the authenticated user

This endpoint is accessible with the user scope.

"Add an email address for the authenticated user"에 대한 매개 변수

헤더
Name, 형식, 설명
accept string

Setting to application/vnd.github+json is recommended.

본문 매개 변수
Name, 형식, 설명
emails array of strings 필수

Adds one or more email addresses to your GitHub account. Must contain at least one email address. Note: Alternatively, you can pass a single email address or an array of emails addresses directly, but we recommend that you pass an object using the emails key.

"Add an email address for the authenticated user"에 대한 HTTP 응답 상태 코드

상태 코드Description
201

Created

304

Not modified

401

Requires authentication

403

Forbidden

404

Resource not found

422

Validation failed, or the endpoint has been spammed.

"Add an email address for the authenticated user"에 대한 코드 샘플

post/user/emails
curl -L \ -X POST \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ http(s)://HOSTNAME/api/v3/user/emails \ -d '{"emails":["octocat@github.com","mona@github.com","octocat@octocat.org"]}'

Response

Status: 201
[ { "email": "octocat@octocat.org", "primary": false, "verified": false, "visibility": "public" }, { "email": "octocat@github.com", "primary": false, "verified": false, "visibility": null }, { "email": "mona@github.com", "primary": false, "verified": false, "visibility": null } ]

Delete an email address for the authenticated user

This endpoint is accessible with the user scope.

"Delete an email address for the authenticated user"에 대한 매개 변수

헤더
Name, 형식, 설명
accept string

Setting to application/vnd.github+json is recommended.

본문 매개 변수
Name, 형식, 설명
emails array of strings 필수

Email addresses associated with the GitHub user account.

"Delete an email address for the authenticated user"에 대한 HTTP 응답 상태 코드

상태 코드Description
204

No Content

304

Not modified

401

Requires authentication

403

Forbidden

404

Resource not found

422

Validation failed, or the endpoint has been spammed.

"Delete an email address for the authenticated user"에 대한 코드 샘플

delete/user/emails
curl -L \ -X DELETE \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ http(s)://HOSTNAME/api/v3/user/emails \ -d '{"emails":["octocat@github.com","mona@github.com"]}'

Response

Status: 204

List public email addresses for the authenticated user

Lists your publicly visible email address, which you can set with the Set primary email visibility for the authenticated user endpoint. This endpoint is accessible with the user:email scope.

"List public email addresses for the authenticated user"에 대한 매개 변수

헤더
Name, 형식, 설명
accept string

Setting to application/vnd.github+json is recommended.

쿼리 매개 변수
Name, 형식, 설명
per_page integer

The number of results per page (max 100).

기본값: 30

page integer

Page number of the results to fetch.

기본값: 1

"List public email addresses for the authenticated user"에 대한 HTTP 응답 상태 코드

상태 코드Description
200

OK

304

Not modified

401

Requires authentication

403

Forbidden

404

Resource not found

"List public email addresses for the authenticated user"에 대한 코드 샘플

get/user/public_emails
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ http(s)://HOSTNAME/api/v3/user/public_emails

Response

Status: 200
[ { "email": "octocat@github.com", "verified": true, "primary": true, "visibility": "public" } ]