Mailspring/docs/ChangeLabelsTask.html
2015-10-02 10:57:48 -07:00

26 lines
1.1 KiB
HTML

---
layout: docs
title: ChangeLabelsTask
---
<h2>Summary</h2>
<div class="markdown-from-sourecode">
<p><p>Create a new task to apply labels to a message or thread.</p>
<p>Takes an options object of the form:</p>
<ul>
<li>labelsToAdd: An <a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/array'>Array</a> of <a href='label.html'>Label</a>s or <a href='label.html'>Label</a> ids to add</li>
<li>labelsToRemove: An <a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/array'>Array</a> of <a href='label.html'>Label</a>s or <a href='label.html'>Label</a> ids to remove</li>
<li>threads: An <a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/array'>Array</a> of <a href='thread.html'>Thread</a>s or <a href='thread.html'>Thread</a> ids</li>
<li>messages: An <a href='https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/array'>Array</a> of <a href='message.html'>Message</a>s or <a href='message.html'>Message</a> ids </li>
</ul>
</p>
</div>
<ul>
</ul>