JGithubPackageUsersEmails

class JGithubPackageUsersEmails extends JGithubPackage

GitHub API References class for the Joomla Platform.

Management of email addresses via the API requires that you are authenticated through basic auth or OAuth with the user scope.

Methods

__construct( Registry $options = null, JGithubHttp $client = null)

Constructor.

from JGithubObject
JGithubPackage
__get( string $name)

Magic method to lazily create API objects

from JGithubPackage
object
getList()

List email addresses for a user.

object
add( string|array $email)

Add email address(es).

object
delete( string|array $email)

Delete email address(es).

Details

__construct( Registry $options = null, JGithubHttp $client = null)

Constructor.

Parameters

Registry $options GitHub options object.
JGithubHttp $client The HTTP client object.

JGithubPackage __get( string $name)

Magic method to lazily create API objects

Parameters

string $name Name of property to retrieve

Return Value

JGithubPackage GitHub API package object.

Exceptions

RuntimeException

object getList()

List email addresses for a user.

Future response: In the final version of the API, this method will return an array of hashes with extended information for each email address indicating if the address has been verified and if it’s the user’s primary email address for GitHub.

Until API v3 is finalized, use the application/vnd.github.v3 media type to get this response format.

Return Value

object

object add( string|array $email)

Add email address(es).

Parameters

string|array $email The email address(es).

Return Value

object

object delete( string|array $email)

Delete email address(es).

Parameters

string|array $email The email address(es).

Return Value

object