diff options
author | 2012-03-01 19:57:59 +0100 | |
---|---|---|
committer | 2012-03-01 19:57:59 +0100 | |
commit | b891dfb211f9a58e5d834ccd148943286c45f61c (patch) | |
tree | c90ab9489c5217151c1f1c716aea8fa39b303393 /pygithub3/services/users/emails.py | |
parent | Repos.watchers service done (diff) | |
parent | Complete services.repos doc (diff) | |
download | python-github3-b891dfb211f9a58e5d834ccd148943286c45f61c.tar.xz python-github3-b891dfb211f9a58e5d834ccd148943286c45f61c.zip |
Merge branch 'docs'
Diffstat (limited to 'pygithub3/services/users/emails.py')
-rw-r--r-- | pygithub3/services/users/emails.py | 47 |
1 files changed, 47 insertions, 0 deletions
diff --git a/pygithub3/services/users/emails.py b/pygithub3/services/users/emails.py new file mode 100644 index 0000000..09f6683 --- /dev/null +++ b/pygithub3/services/users/emails.py @@ -0,0 +1,47 @@ +#!/usr/bin/env python +# -*- encoding: utf-8 -*- + +from . import Service + + +class Emails(Service): + """ Consume `Emails API <http://developer.github.com/v3/users/emails/>`_ + + .. warning:: + You must be authenticated for all requests + """ + + def list(self): + """ Get user's emails + + :returns: A :doc:`result` + """ + request = self.make_request('users.emails.list') + return self._get_result(request) + + def add(self, *emails): + """ Add emails + + :param list emails: Emails to add + + .. note:: + It rejects non-valid emails + + :: + + email_service.add('test1@xample.com', 'test2@xample.com') + """ + request = self.make_request('users.emails.add', body=emails) + return self._post(request) + + def delete(self, *emails): + """ Delete emails + + :param list emails: List of emails + + :: + + email_service.delete('test1@xample.com', 'test2@xample.com') + """ + request = self.make_request('users.emails.delete', body=emails) + self._delete(request) |