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
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<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>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#create">create(userId, body)</a></code></p>
<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>
<p class="toc_element">
<code><a href="#delete">delete(userId, delegateEmail)</a></code></p>
<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>
<p class="toc_element">
<code><a href="#get">get(userId, delegateEmail)</a></code></p>
<p class="firstline">Gets the specified delegate.</p>
<p class="toc_element">
<code><a href="#list">list(userId)</a></code></p>
<p class="firstline">Lists the delegates for the specified account.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="create">create(userId, body)</code>
<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 limtations 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.
Args:
userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required)
body: object, The request body. (required)
The object takes the form of:
{ # Settings for a delegate. Delegates can read, send, and delete messages, as well as view and add contacts, for the delegator's account. See "Set up mail delegation" for more information about delegates.
"delegateEmail": "A String", # The email address of the delegate.
"verificationStatus": "A String", # Indicates whether this address has been verified and can act as a delegate for the account. Read-only.
}
Returns:
An object of the form:
{ # Settings for a delegate. Delegates can read, send, and delete messages, as well as view and add contacts, for the delegator's account. See "Set up mail delegation" for more information about delegates.
"delegateEmail": "A String", # The email address of the delegate.
"verificationStatus": "A String", # Indicates whether this address has been verified and can act as a delegate for the account. Read-only.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(userId, delegateEmail)</code>
<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.
Args:
userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required)
delegateEmail: string, The email address of the user to be removed as a delegate. (required)
</pre>
</div>
<div class="method">
<code class="details" id="get">get(userId, delegateEmail)</code>
<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.
Args:
userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required)
delegateEmail: string, The email address of the user whose delegate relationship is to be retrieved. (required)
Returns:
An object of the form:
{ # Settings for a delegate. Delegates can read, send, and delete messages, as well as view and add contacts, for the delegator's account. See "Set up mail delegation" for more information about delegates.
"delegateEmail": "A String", # The email address of the delegate.
"verificationStatus": "A String", # Indicates whether this address has been verified and can act as a delegate for the account. Read-only.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(userId)</code>
<pre>Lists the delegates for the specified account.
This method is only available to service account clients that have been delegated domain-wide authority.
Args:
userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required)
Returns:
An object of the form:
{ # Response for the ListDelegates method.
"delegates": [ # List of the user's delegates (with any verification status).
{ # Settings for a delegate. Delegates can read, send, and delete messages, as well as view and add contacts, for the delegator's account. See "Set up mail delegation" for more information about delegates.
"delegateEmail": "A String", # The email address of the delegate.
"verificationStatus": "A String", # Indicates whether this address has been verified and can act as a delegate for the account. Read-only.
},
],
}</pre>
</div>
</body></html>
|
