class Github::Client::Users::Emails

Public Instance Methods

<<(*args)
Alias for: add
add(*args) click to toggle source

Add email address(es) for the authenticated user

@param [Array] emails

You can include a single email address or an array of addresses

@example

github = Github.new oauth_token: '...'
github.users.emails.add "octocat@github.com", "support@github.com"

@api public

# File lib/github_api/client/users/emails.rb, line 34
def add(*args)
  arguments(args)
  params = arguments.params
  params['data'] = arguments.remaining unless arguments.remaining.empty?

  post_request("/user/emails", params)
end
Also aliased as: <<
all(*args)
Alias for: list
delete(*args) click to toggle source

Delete email address(es) for the authenticated user

@param [Array] emails

You can include a single email address or an array of addresses

@example

github = Github.new oauth_token: '...'
github.users.emails.delete "octocat@github.com", "support@github.com"

@api public

# File lib/github_api/client/users/emails.rb, line 53
def delete(*args)
  arguments(args)
  params = arguments.params
  params['data'] = arguments.remaining unless arguments.remaining.empty?

  delete_request("/user/emails", params)
end
list(*args) { |el| ... } click to toggle source

List email addresses for the authenticated user

@example

github = Github.new oauth_token: '...'
github.users.emails.list
github.users.emails.list { |email| ... }

@return [Hash]

@api public

# File lib/github_api/client/users/emails.rb, line 16
def list(*args)
  arguments(args)
  response = get_request("/user/emails", arguments.params)
  return response unless block_given?
  response.each { |el| yield el }
end
Also aliased as: all