emails.md

Current user / Emails API

Back to the navigation

Wraps GitHub User Emails API.

Requires authentication.

List email addresses for a user

$emails = $client->currentUser()->emails()->all();

List public email addresses for a user

$emails = $client->currentUser()->emails()->allPublic();

Add email address(es)

$emails = $client->currentUser()->emails()->add(['email1', 'email2']);

Delete email address(es)

$client->currentUser()->emails()->remove(['email1', 'email2']);

Toggle primary email visibility

$primaryEmail = $client->currentUser()->emails()->toggleVisibility();