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"> 78 <code><a href="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#create">create(userId, body=None, x__xgafv=None)</a></code></p> 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> 83<p class="toc_element"> 84 <code><a href="#delete">delete(userId, delegateEmail, x__xgafv=None)</a></code></p> 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> 86<p class="toc_element"> 87 <code><a href="#get">get(userId, delegateEmail, x__xgafv=None)</a></code></p> 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> 89<p class="toc_element"> 90 <code><a href="#list">list(userId, x__xgafv=None)</a></code></p> 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> 92<h3>Method Details</h3> 93<div class="method"> 94 <code class="details" id="close">close()</code> 95 <pre>Close httplib2 connections.</pre> 96</div> 97 98<div class="method"> 99 <code class="details" id="create">create(userId, body=None, x__xgafv=None)</code> 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. 101 102Args: 103 userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required) 104 body: object, The request body. 105 The object takes the form of: 106 107{ # 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. 108 "delegateEmail": "A String", # The email address of the delegate. 109 "verificationStatus": "A String", # Indicates whether this address has been verified and can act as a delegate for the account. Read-only. 110} 111 112 x__xgafv: string, V1 error format. 113 Allowed values 114 1 - v1 error format 115 2 - v2 error format 116 117Returns: 118 An object of the form: 119 120 { # 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. 121 "delegateEmail": "A String", # The email address of the delegate. 122 "verificationStatus": "A String", # Indicates whether this address has been verified and can act as a delegate for the account. Read-only. 123}</pre> 124</div> 125 126<div class="method"> 127 <code class="details" id="delete">delete(userId, delegateEmail, x__xgafv=None)</code> 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. 129 130Args: 131 userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required) 132 delegateEmail: string, The email address of the user to be removed as a delegate. (required) 133 x__xgafv: string, V1 error format. 134 Allowed values 135 1 - v1 error format 136 2 - v2 error format 137</pre> 138</div> 139 140<div class="method"> 141 <code class="details" id="get">get(userId, delegateEmail, x__xgafv=None)</code> 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. 143 144Args: 145 userId: string, User's email address. The special value "me" 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) 147 x__xgafv: string, V1 error format. 148 Allowed values 149 1 - v1 error format 150 2 - v2 error format 151 152Returns: 153 An object of the form: 154 155 { # 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. 156 "delegateEmail": "A String", # The email address of the delegate. 157 "verificationStatus": "A String", # Indicates whether this address has been verified and can act as a delegate for the account. Read-only. 158}</pre> 159</div> 160 161<div class="method"> 162 <code class="details" id="list">list(userId, x__xgafv=None)</code> 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. 164 165Args: 166 userId: string, User's email address. The special value "me" can be used to indicate the authenticated user. (required) 167 x__xgafv: string, V1 error format. 168 Allowed values 169 1 - v1 error format 170 2 - v2 error format 171 172Returns: 173 An object of the form: 174 175 { # Response for the ListDelegates method. 176 "delegates": [ # List of the user's delegates (with any verification status). If an account doesn't have delegates, this field doesn't appear. 177 { # 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. 178 "delegateEmail": "A String", # The email address of the delegate. 179 "verificationStatus": "A String", # Indicates whether this address has been verified and can act as a delegate for the account. Read-only. 180 }, 181 ], 182}</pre> 183</div> 184 185</body></html>