Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / b6971b0405ba59d905b84fa5fc8e27e12d29b70c / . / docs / dyn / gmail_v1.users.settings.delegates.html
blob: 00d316ea873f402d2796af127eced73575045d50 [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">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]78 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]81 <code><a href="#create">create(userId, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]82<p class="firstline">Adds a delegate with its verification status set directly to `accepted`, without sending any verification email. The delegate user must be a member of the same G Suite organization as the delegator user. Gmail imposes limitations on the number of delegates and delegators each user in a G Suite organization can have. These limits depend on your organization, but in general each user can have up to 25 delegates and up to 10 delegators. Note that a delegate user must be referred to by their primary email address, and not an email alias. Also note that when a new delegate is created, there may be up to a one minute delay before the new delegate is available for use. This method is only available to service account clients that have been delegated domain-wide authority.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]83<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]84 <code><a href="#delete">delete(userId, delegateEmail, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]85<p class="firstline">Removes the specified delegate (which can be of any verification status), and revokes any verification that may have been required for using it. Note that a delegate user must be referred to by their primary email address, and not an email alias. This method is only available to service account clients that have been delegated domain-wide authority.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]86<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]87 <code><a href="#get">get(userId, delegateEmail, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]88<p class="firstline">Gets the specified delegate. Note that a delegate user must be referred to by their primary email address, and not an email alias. This method is only available to service account clients that have been delegated domain-wide authority.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]89<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]90 <code><a href="#list">list(userId, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]91<p class="firstline">Lists the delegates for the specified account. This method is only available to service account clients that have been delegated domain-wide authority.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]92<h3>Method Details</h3>
93<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]94 <code class="details" id="close">close()</code>
95 <pre>Close httplib2 connections.</pre>
96</div>
97
98<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]99 <code class="details" id="create">create(userId, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]100 <pre>Adds a delegate with its verification status set directly to `accepted`, without sending any verification email. The delegate user must be a member of the same G Suite organization as the delegator user. Gmail imposes limitations on the number of delegates and delegators each user in a G Suite organization can have. These limits depend on your organization, but in general each user can have up to 25 delegates and up to 10 delegators. Note that a delegate user must be referred to by their primary email address, and not an email alias. Also note that when a new delegate is created, there may be up to a one minute delay before the new delegate is available for use. This method is only available to service account clients that have been delegated domain-wide authority.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]101
102Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]103 userId: string, User&#x27;s email address. The special value &quot;me&quot; can be used to indicate the authenticated user. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]104 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]105 The object takes the form of:
106
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]107{ # Settings for a delegate. Delegates can read, send, and delete messages, as well as view and add contacts, for the delegator&#x27;s account. See &quot;Set up mail delegation&quot; for more information about delegates.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]108 &quot;delegateEmail&quot;: &quot;A String&quot;, # The email address of the delegate.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]109 &quot;verificationStatus&quot;: &quot;A String&quot;, # Indicates whether this address has been verified and can act as a delegate for the account. Read-only.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]110}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]111
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]112 x__xgafv: string, V1 error format.
113 Allowed values
114 1 - v1 error format
115 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]116
117Returns:
118 An object of the form:
119
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]120 { # Settings for a delegate. Delegates can read, send, and delete messages, as well as view and add contacts, for the delegator&#x27;s account. See &quot;Set up mail delegation&quot; for more information about delegates.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]121 &quot;delegateEmail&quot;: &quot;A String&quot;, # The email address of the delegate.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]122 &quot;verificationStatus&quot;: &quot;A String&quot;, # Indicates whether this address has been verified and can act as a delegate for the account. Read-only.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]123 }</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]124</div>
125
126<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]127 <code class="details" id="delete">delete(userId, delegateEmail, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]128 <pre>Removes the specified delegate (which can be of any verification status), and revokes any verification that may have been required for using it. Note that a delegate user must be referred to by their primary email address, and not an email alias. This method is only available to service account clients that have been delegated domain-wide authority.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]129
130Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]131 userId: string, User&#x27;s email address. The special value &quot;me&quot; can be used to indicate the authenticated user. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]132 delegateEmail: string, The email address of the user to be removed as a delegate. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]133 x__xgafv: string, V1 error format.
134 Allowed values
135 1 - v1 error format
136 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]137</pre>
138</div>
139
140<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]141 <code class="details" id="get">get(userId, delegateEmail, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]142 <pre>Gets the specified delegate. Note that a delegate user must be referred to by their primary email address, and not an email alias. This method is only available to service account clients that have been delegated domain-wide authority.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]143
144Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]145 userId: string, User&#x27;s email address. The special value &quot;me&quot; can be used to indicate the authenticated user. (required)
146 delegateEmail: string, The email address of the user whose delegate relationship is to be retrieved. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]147 x__xgafv: string, V1 error format.
148 Allowed values
149 1 - v1 error format
150 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]151
152Returns:
153 An object of the form:
154
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]155 { # Settings for a delegate. Delegates can read, send, and delete messages, as well as view and add contacts, for the delegator&#x27;s account. See &quot;Set up mail delegation&quot; for more information about delegates.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]156 &quot;delegateEmail&quot;: &quot;A String&quot;, # The email address of the delegate.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]157 &quot;verificationStatus&quot;: &quot;A String&quot;, # Indicates whether this address has been verified and can act as a delegate for the account. Read-only.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]158 }</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]159</div>
160
161<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]162 <code class="details" id="list">list(userId, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]163 <pre>Lists the delegates for the specified account. This method is only available to service account clients that have been delegated domain-wide authority.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]164
165Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]166 userId: string, User&#x27;s email address. The special value &quot;me&quot; can be used to indicate the authenticated user. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]167 x__xgafv: string, V1 error format.
168 Allowed values
169 1 - v1 error format
170 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]171
172Returns:
173 An object of the form:
174
175 { # Response for the ListDelegates method.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]176 &quot;delegates&quot;: [ # List of the user&#x27;s delegates (with any verification status). If an account doesn&#x27;t have delegates, this field doesn&#x27;t appear.
177 { # Settings for a delegate. Delegates can read, send, and delete messages, as well as view and add contacts, for the delegator&#x27;s account. See &quot;Set up mail delegation&quot; for more information about delegates.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]178 &quot;delegateEmail&quot;: &quot;A String&quot;, # The email address of the delegate.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]179 &quot;verificationStatus&quot;: &quot;A String&quot;, # Indicates whether this address has been verified and can act as a delegate for the account. Read-only.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]180 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]181 ],
182 }</pre>
183</div>
184
185</body></html>