Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / c72efbc6b71c963997c5728d471c04ab33d95e4f / . / docs / dyn / gmail_v1.users.settings.delegates.html
blob: 29f6d0ee41ac6f5614f6e3af21e95289bb3be899 [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">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]78 <code><a href="#create">create(userId, body=None)</a></code></p>
79<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.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]80<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]81 <code><a href="#delete">delete(userId, delegateEmail)</a></code></p>
82<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.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]83<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]84 <code><a href="#get">get(userId, delegateEmail)</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">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]87 <code><a href="#list">list(userId)</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">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]91 <code class="details" id="create">create(userId, body=None)</code>
92 <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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]93
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]94Gmail 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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]95
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]96Note that a delegate user must be referred to by their primary email address, and not an email alias.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]97
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]98Also 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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]99
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]100This 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:
Bu Sun Kim65020912020-05-20 12:08:20 -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
Bu Sun Kim65020912020-05-20 12:08:20 -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.
108 &quot;delegateEmail&quot;: &quot;A String&quot;, # The email address of the delegate.
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 Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]110 }
111
112
113Returns:
114 An object of the form:
115
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]116 { # 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.
117 &quot;delegateEmail&quot;: &quot;A String&quot;, # The email address of the delegate.
118 &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 Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]119 }</pre>
120</div>
121
122<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]123 <code class="details" id="delete">delete(userId, delegateEmail)</code>
124 <pre>Removes the specified delegate (which can be of any verification status), and revokes any verification that may have been required for using it.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]125
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]126Note that a delegate user must be referred to by their primary email address, and not an email alias.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]127
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]128This 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:
Bu Sun Kim65020912020-05-20 12:08:20 -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)
133</pre>
134</div>
135
136<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]137 <code class="details" id="get">get(userId, delegateEmail)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]138 <pre>Gets the specified delegate.
139
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]140Note that a delegate user must be referred to by their primary email address, and not an email alias.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]141
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]142This 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:
Bu Sun Kim65020912020-05-20 12:08:20 -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 Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]147
148Returns:
149 An object of the form:
150
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]151 { # 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.
152 &quot;delegateEmail&quot;: &quot;A String&quot;, # The email address of the delegate.
153 &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 Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]154 }</pre>
155</div>
156
157<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]158 <code class="details" id="list">list(userId)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]159 <pre>Lists the delegates for the specified account.
160
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]161This 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]162
163Args:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]164 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]165
166Returns:
167 An object of the form:
168
169 { # Response for the ListDelegates method.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]170 &quot;delegates&quot;: [ # List of the user&#x27;s delegates (with any verification status).
171 { # 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.
172 &quot;delegateEmail&quot;: &quot;A String&quot;, # The email address of the delegate.
173 &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 Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]174 },
175 ],
176 }</pre>
177</div>
178
179</body></html>