aboutsummaryrefslogtreecommitdiffstats
path: root/pygithub3/services/users/emails.py
blob: 09f6683fd3e28e1d53c695bad6aec9b1d42092cc (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
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)