Skip to main content

Emails

关于电子邮件 API

通过 API 管理电子邮件地址要求您通过基本身份验证进行验证,或者使用端点的正确范围通过 OAuth 进行身份验证。

Many of the resources on this API provide a shortcut for getting information about the currently authenticated user. 如果请求 URL 不含 {username} 参数,则响应将是登录用户的响应(您必须随请求传递身份验证信息)。 在通过基本身份验证或作用域为 user 的 OAuth 进行身份验证时,将包含其他私有信息,例如用户是否启用双重身份验证。

Set primary email visibility for the authenticated user

Sets the visibility for your primary email addresses.

参数

标头
名称, 类型, 描述
acceptstring

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

正文参数
名称, 类型, 描述
visibilitystring必选

Denotes whether an email is publicly visible.

可以是以下其中之一: public, private

HTTP 响应状态代码

状态代码描述
200

OK

304

Not modified

401

Requires authentication

403

Forbidden

404

Resource not found

422

Validation failed

代码示例

patch/user/email/visibility
curl \ -X PATCH \ -H "Accept: application/vnd.github.v3+json" \ -H "Authorization: token <TOKEN>" \ https://api.github.com/user/email/visibility \ -d '{"visibility":"private"}'

Response

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

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.

参数

标头
名称, 类型, 描述
acceptstring

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

查询参数
名称, 类型, 描述
per_pageinteger

The number of results per page (max 100).

默认值: 30

pageinteger

Page number of the results to fetch.

默认值: 1

HTTP 响应状态代码

状态代码描述
200

OK

304

Not modified

401

Requires authentication

403

Forbidden

404

Resource not found

代码示例

get/user/emails
curl \ -H "Accept: application/vnd.github.v3+json" \ -H "Authorization: token <TOKEN>" \ https://api.github.com/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.

参数

标头
名称, 类型, 描述
acceptstring

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

正文参数
名称, 类型, 描述
emailsarray 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.

HTTP 响应状态代码

状态代码描述
201

Created

304

Not modified

401

Requires authentication

403

Forbidden

404

Resource not found

422

Validation failed

代码示例

post/user/emails
curl \ -X POST \ -H "Accept: application/vnd.github.v3+json" \ -H "Authorization: token <TOKEN>" \ https://api.github.com/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.

参数

标头
名称, 类型, 描述
acceptstring

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

正文参数
名称, 类型, 描述
emailsarray of strings必选

Email addresses associated with the GitHub user account.

HTTP 响应状态代码

状态代码描述
204

No Content

304

Not modified

401

Requires authentication

403

Forbidden

404

Resource not found

422

Validation failed

代码示例

delete/user/emails
curl \ -X DELETE \ -H "Accept: application/vnd.github.v3+json" \ -H "Authorization: token <TOKEN>" \ https://api.github.com/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.

参数

标头
名称, 类型, 描述
acceptstring

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

查询参数
名称, 类型, 描述
per_pageinteger

The number of results per page (max 100).

默认值: 30

pageinteger

Page number of the results to fetch.

默认值: 1

HTTP 响应状态代码

状态代码描述
200

OK

304

Not modified

401

Requires authentication

403

Forbidden

404

Resource not found

代码示例

get/user/public_emails
curl \ -H "Accept: application/vnd.github.v3+json" \ -H "Authorization: token <TOKEN>" \ https://api.github.com/user/public_emails

Response

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