Files
google-apis-rs/google_gmail1_cli/users_labels-delete/index.html
2022-03-08 15:36:16 +08:00

570 lines
20 KiB
HTML

<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Labels Delete - Gmail v3.0.0+20220228</title>
<link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
<link rel="stylesheet" href="../css/theme.css" type="text/css" />
<link rel="stylesheet" href="../css/theme_extra.css" type="text/css" />
<link rel="stylesheet" href="../css/highlight.css">
<script src="//cdnjs.cloudflare.com/ajax/libs/jquery/2.1.1/jquery.min.js"></script>
<script src="//cdnjs.cloudflare.com/ajax/libs/modernizr/2.8.3/modernizr.min.js"></script>
<script type="text/javascript" src="../js/highlight.pack.js"></script>
<script src="../js/theme.js"></script>
<style>
body {font-size: 90%;}
pre, code {font-size: 100%;}
h3, h4, h5, h6 {color: #2980b9; font-weight: 300}
</style>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
<div class="wy-side-nav-search">
<a href=".." class="icon icon-home"> Gmail v3.0.0+20220228</a>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<span>Users</span>
<li class="toctree-l1 ">
<a class="" href="../users_drafts-create">Drafts Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../users_drafts-delete">Drafts Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../users_drafts-get">Drafts Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../users_drafts-list">Drafts List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../users_drafts-send">Drafts Send</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../users_drafts-update">Drafts Update</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../users_get-profile">Get Profile</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../users_history-list">History List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../users_labels-create">Labels Create</a>
</li>
<li class="toctree-l1 current">
<a class="current" href=".">Labels Delete</a>
<ul>
<li class="toctree-l2"><a href="#scopes">Scopes</a></li>
<li class="toctree-l2"><a href="#required-scalar-arguments">Required Scalar Arguments</a></li>
<li class="toctree-l2"><a href="#optional-general-properties">Optional General Properties</a></li>
</ul>
</li>
<li class="toctree-l1 ">
<a class="" href="../users_labels-get">Labels Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../users_labels-list">Labels List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../users_labels-patch">Labels Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../users_labels-update">Labels Update</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../users_messages-attachments-get">Messages Attachments Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../users_messages-batch-delete">Messages Batch Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../users_messages-batch-modify">Messages Batch Modify</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../users_messages-delete">Messages Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../users_messages-get">Messages Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../users_messages-import">Messages Import</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../users_messages-insert">Messages Insert</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../users_messages-list">Messages List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../users_messages-modify">Messages Modify</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../users_messages-send">Messages Send</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../users_messages-trash">Messages Trash</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../users_messages-untrash">Messages Untrash</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../users_settings-delegates-create">Settings Delegates Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../users_settings-delegates-delete">Settings Delegates Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../users_settings-delegates-get">Settings Delegates Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../users_settings-delegates-list">Settings Delegates List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../users_settings-filters-create">Settings Filters Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../users_settings-filters-delete">Settings Filters Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../users_settings-filters-get">Settings Filters Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../users_settings-filters-list">Settings Filters List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../users_settings-forwarding-addresses-create">Settings Forwarding Addresses Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../users_settings-forwarding-addresses-delete">Settings Forwarding Addresses Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../users_settings-forwarding-addresses-get">Settings Forwarding Addresses Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../users_settings-forwarding-addresses-list">Settings Forwarding Addresses List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../users_settings-get-auto-forwarding">Settings Get Auto Forwarding</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../users_settings-get-imap">Settings Get Imap</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../users_settings-get-language">Settings Get Language</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../users_settings-get-pop">Settings Get Pop</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../users_settings-get-vacation">Settings Get Vacation</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../users_settings-send-as-create">Settings Send As Create</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../users_settings-send-as-delete">Settings Send As Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../users_settings-send-as-get">Settings Send As Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../users_settings-send-as-list">Settings Send As List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../users_settings-send-as-patch">Settings Send As Patch</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../users_settings-send-as-smime-info-delete">Settings Send As Smime Info Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../users_settings-send-as-smime-info-get">Settings Send As Smime Info Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../users_settings-send-as-smime-info-insert">Settings Send As Smime Info Insert</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../users_settings-send-as-smime-info-list">Settings Send As Smime Info List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../users_settings-send-as-smime-info-set-default">Settings Send As Smime Info Set Default</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../users_settings-send-as-update">Settings Send As Update</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../users_settings-send-as-verify">Settings Send As Verify</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../users_settings-update-auto-forwarding">Settings Update Auto Forwarding</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../users_settings-update-imap">Settings Update Imap</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../users_settings-update-language">Settings Update Language</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../users_settings-update-pop">Settings Update Pop</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../users_settings-update-vacation">Settings Update Vacation</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../users_stop">Stop</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../users_threads-delete">Threads Delete</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../users_threads-get">Threads Get</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../users_threads-list">Threads List</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../users_threads-modify">Threads Modify</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../users_threads-trash">Threads Trash</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../users_threads-untrash">Threads Untrash</a>
</li>
<li class="toctree-l1 ">
<a class="" href="../users_watch">Watch</a>
</li>
</ul>
</div>
&nbsp;
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="icon icon-reorder"></i>
<a href=".."></a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="..">Docs</a> &raquo;</li>
<li>Labels Delete</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/gmail1-cli" class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main">
<div class="section">
<p>Immediately and permanently deletes the specified label and removes it from any messages and threads that it is applied to.</p>
<h1 id="scopes">Scopes</h1>
<p>You will need authorization for at least one of the following scopes to make a valid call:</p>
<ul>
<li><em>https://mail.google.com/</em></li>
<li><em>https://www.googleapis.com/auth/gmail.labels</em></li>
<li><em>https://www.googleapis.com/auth/gmail.modify</em></li>
</ul>
<p>If unset, the scope for this method defaults to <em>https://mail.google.com/</em>.
You can set the scope for this method like this: <code>gmail1 --scope &lt;scope&gt; users labels-delete ...</code></p>
<h1 id="required-scalar-arguments">Required Scalar Arguments</h1>
<ul>
<li><strong>&lt;user-id&gt;</strong> <em>(string)</em><ul>
<li>The user&#39;s email address. The special value <code>me</code> can be used to indicate the authenticated user.</li>
</ul>
</li>
<li><strong>&lt;id&gt;</strong> <em>(string)</em><ul>
<li>The ID of the label to delete.</li>
</ul>
</li>
</ul>
<h1 id="optional-general-properties">Optional General Properties</h1>
<p>The following properties can configure any call, and are not specific to this method.</p>
<ul>
<li>
<p><strong>-p $-xgafv=string</strong></p>
<ul>
<li>V1 error format.</li>
</ul>
</li>
<li>
<p><strong>-p access-token=string</strong></p>
<ul>
<li>OAuth access token.</li>
</ul>
</li>
<li>
<p><strong>-p alt=string</strong></p>
<ul>
<li>Data format for response.</li>
</ul>
</li>
<li>
<p><strong>-p callback=string</strong></p>
<ul>
<li>JSONP</li>
</ul>
</li>
<li>
<p><strong>-p fields=string</strong></p>
<ul>
<li>Selector specifying which fields to include in a partial response.</li>
</ul>
</li>
<li>
<p><strong>-p key=string</strong></p>
<ul>
<li>API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.</li>
</ul>
</li>
<li>
<p><strong>-p oauth-token=string</strong></p>
<ul>
<li>OAuth 2.0 token for the current user.</li>
</ul>
</li>
<li>
<p><strong>-p pretty-print=boolean</strong></p>
<ul>
<li>Returns response with indentations and line breaks.</li>
</ul>
</li>
<li>
<p><strong>-p quota-user=string</strong></p>
<ul>
<li>Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.</li>
</ul>
</li>
<li>
<p><strong>-p upload-type=string</strong></p>
<ul>
<li>Legacy upload protocol for media (e.g. &#34;media&#34;, &#34;multipart&#34;).</li>
</ul>
</li>
<li>
<p><strong>-p upload-protocol=string</strong></p>
<ul>
<li>Upload protocol for media (e.g. &#34;raw&#34;, &#34;multipart&#34;).</li>
</ul>
</li>
</ul>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="../users_labels-get" class="btn btn-neutral float-right" title="Labels Get"/>Next <span class="icon icon-circle-arrow-right"></span></a>
<a href="../users_labels-create" class="btn btn-neutral" title="Labels Create"><span class="icon icon-circle-arrow-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
<!-- Copyright etc -->
</p>
</div>
Built with <a href="http://www.mkdocs.org">MkDocs</a>, using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<div class="rst-versions" role="note" style="cursor: pointer">
<span class="rst-current-version" data-toggle="rst-current-version">
<a class="icon icon-github" style="float: left; color: #fcfcfc"> GitHub</a>
<span><a href="../users_labels-create" style="color: #fcfcfc;">&laquo; Previous</a></span>
<span style="margin-left: 15px"><a href="../users_labels-get" style="color: #fcfcfc">Next &raquo;</a></span>
</span>
</div>
</body>
</html>