| <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=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Adds a delegate with its verification status set directly to</p> |
| <p class="toc_element"> |
| <code><a href="#delete">delete(userId, delegateEmail, x__xgafv=None)</a></code></p> |
| <p class="firstline">Removes the specified delegate (which can be of any verification status),</p> |
| <p class="toc_element"> |
| <code><a href="#get">get(userId, delegateEmail, x__xgafv=None)</a></code></p> |
| <p class="firstline">Gets the specified delegate.</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(userId, x__xgafv=None)</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=None, x__xgafv=None)</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 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. |
| |
| 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. |
| 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 |
| # <a href="https://support.google.com/mail/answer/138350">"Set up |
| # mail delegation"</a> 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. |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| 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 |
| # <a href="https://support.google.com/mail/answer/138350">"Set up |
| # mail delegation"</a> 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, x__xgafv=None)</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) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| </pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="get">get(userId, delegateEmail, x__xgafv=None)</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) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| 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 |
| # <a href="https://support.google.com/mail/answer/138350">"Set up |
| # mail delegation"</a> 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, x__xgafv=None)</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) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| 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 |
| # <a href="https://support.google.com/mail/answer/138350">"Set up |
| # mail delegation"</a> 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> |
