Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / gmail_v1.users.settings.delegates.html
blob: 91e31cd45af07c9c7e5069803292ad23df60f022 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="gmail_v1.html">Gmail API</a> . <a href="gmail_v1.users.html">users</a> . <a href="gmail_v1.users.settings.html">settings</a> . <a href="gmail_v1.users.settings.delegates.html">delegates</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]78 <code><a href="#create">create(userId, body=None, x__xgafv=None)</a></code></p>
79<p class="firstline">Adds a delegate with its verification status set directly to</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]80<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]81 <code><a href="#delete">delete(userId, delegateEmail, x__xgafv=None)</a></code></p>
82<p class="firstline">Removes the specified delegate (which can be of any verification status),</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]83<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]84 <code><a href="#get">get(userId, delegateEmail, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]85<p class="firstline">Gets the specified delegate.</p>
86<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]87 <code><a href="#list">list(userId, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]88<p class="firstline">Lists the delegates for the specified account.</p>
89<h3>Method Details</h3>
90<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]91 <code class="details" id="create">create(userId, body=None, x__xgafv=None)</code>
92 <pre>Adds a delegate with its verification status set directly to
93&lt;code&gt;accepted&lt;/code&gt;, without sending any verification email. The
94delegate user must be a member of the same G Suite organization as the
95delegator user.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]96
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]97Gmail imposes limitations on the number of delegates and delegators each
98user in a G Suite organization can have. These limits depend on your
99organization, but in general each user can have up to 25 delegates and
100up to 10 delegators.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]101
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]102Note that a delegate user must be referred to by their primary email
103address, and not an email alias.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]104
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]105Also note that when a new delegate is created, there may be up to a one
106minute delay before the new delegate is available for use.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]107
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]108This method is only available to service account clients that have been
109delegated domain-wide authority.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]110
111Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]112 userId: string, User's email address. The special value "me"
113can be used to indicate the authenticated user. (required)
114 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]115 The object takes the form of:
116
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]117{ # Settings for a delegate. Delegates can read, send, and delete messages, as
118 # well as view and add contacts, for the delegator's account. See
119 # &lt;a href="https://support.google.com/mail/answer/138350"&gt;"Set up
120 # mail delegation"&lt;/a&gt; for more information about delegates.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]121 "delegateEmail": "A String", # The email address of the delegate.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]122 "verificationStatus": "A String", # Indicates whether this address has been verified and can act as a delegate
123 # for the account. Read-only.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]124 }
125
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]126 x__xgafv: string, V1 error format.
127 Allowed values
128 1 - v1 error format
129 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]130
131Returns:
132 An object of the form:
133
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]134 { # Settings for a delegate. Delegates can read, send, and delete messages, as
135 # well as view and add contacts, for the delegator's account. See
136 # &lt;a href="https://support.google.com/mail/answer/138350"&gt;"Set up
137 # mail delegation"&lt;/a&gt; for more information about delegates.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]138 "delegateEmail": "A String", # The email address of the delegate.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]139 "verificationStatus": "A String", # Indicates whether this address has been verified and can act as a delegate
140 # for the account. Read-only.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]141 }</pre>
142</div>
143
144<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]145 <code class="details" id="delete">delete(userId, delegateEmail, x__xgafv=None)</code>
146 <pre>Removes the specified delegate (which can be of any verification status),
147and revokes any verification that may have been required for using it.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]148
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]149Note that a delegate user must be referred to by their primary email
150address, and not an email alias.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]151
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]152This method is only available to service account clients that have been
153delegated domain-wide authority.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]154
155Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]156 userId: string, User's email address. The special value "me"
157can be used to indicate the authenticated user. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]158 delegateEmail: string, The email address of the user to be removed as a delegate. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]159 x__xgafv: string, V1 error format.
160 Allowed values
161 1 - v1 error format
162 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]163</pre>
164</div>
165
166<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]167 <code class="details" id="get">get(userId, delegateEmail, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]168 <pre>Gets the specified delegate.
169
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]170Note that a delegate user must be referred to by their primary email
171address, and not an email alias.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]172
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]173This method is only available to service account clients that have been
174delegated domain-wide authority.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]175
176Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]177 userId: string, User's email address. The special value "me"
178can be used to indicate the authenticated user. (required)
179 delegateEmail: string, The email address of the user whose delegate relationship is to be
180retrieved. (required)
181 x__xgafv: string, V1 error format.
182 Allowed values
183 1 - v1 error format
184 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]185
186Returns:
187 An object of the form:
188
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]189 { # Settings for a delegate. Delegates can read, send, and delete messages, as
190 # well as view and add contacts, for the delegator's account. See
191 # &lt;a href="https://support.google.com/mail/answer/138350"&gt;"Set up
192 # mail delegation"&lt;/a&gt; for more information about delegates.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]193 "delegateEmail": "A String", # The email address of the delegate.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]194 "verificationStatus": "A String", # Indicates whether this address has been verified and can act as a delegate
195 # for the account. Read-only.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]196 }</pre>
197</div>
198
199<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]200 <code class="details" id="list">list(userId, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]201 <pre>Lists the delegates for the specified account.
202
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]203This method is only available to service account clients that have been
204delegated domain-wide authority.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]205
206Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]207 userId: string, User's email address. The special value "me"
208can be used to indicate the authenticated user. (required)
209 x__xgafv: string, V1 error format.
210 Allowed values
211 1 - v1 error format
212 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]213
214Returns:
215 An object of the form:
216
217 { # Response for the ListDelegates method.
218 "delegates": [ # List of the user's delegates (with any verification status).
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]219 { # Settings for a delegate. Delegates can read, send, and delete messages, as
220 # well as view and add contacts, for the delegator's account. See
221 # &lt;a href="https://support.google.com/mail/answer/138350"&gt;"Set up
222 # mail delegation"&lt;/a&gt; for more information about delegates.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]223 "delegateEmail": "A String", # The email address of the delegate.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]224 "verificationStatus": "A String", # Indicates whether this address has been verified and can act as a delegate
225 # for the account. Read-only.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]226 },
227 ],
228 }</pre>
229</div>
230
231</body></html>