-
Notifications
You must be signed in to change notification settings - Fork 16
/
Flags.Flag.html
405 lines (402 loc) · 13.2 KB
/
Flags.Flag.html
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
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>Flags.Flag (Jakarta Mail API documentation)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
<script type="text/javascript" src="../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../jquery/jquery-3.3.1.js"></script>
<script type="text/javascript" src="../../../jquery/jquery-migrate-3.0.1.js"></script>
<script type="text/javascript" src="../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Flags.Flag (Jakarta Mail API documentation)";
}
}
catch(err) {
}
//-->
var pathtoroot = "../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../module-summary.html">Module</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage">Jakarta Mail<br>v2.1.0</div>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses.html">All Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li><a href="#field.summary">Field</a> | </li>
<li>Constr | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field.detail">Field</a> | </li>
<li>Constr | </li>
<li>Method</li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding"> </div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="moduleLabelInType">Module</span> <a href="../../module-summary.html">jakarta.mail</a></div>
<div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">jakarta.mail</a></div>
<h2 title="Class Flags.Flag" class="title">Class Flags.Flag</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>jakarta.mail.Flags.Flag</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Enclosing class:</dt>
<dd><a href="Flags.html" title="class in jakarta.mail">Flags</a></dd>
</dl>
<hr>
<pre>public static final class <span class="typeNameLabel">Flags.Flag</span>
extends java.lang.Object</pre>
<div class="block">This inner class represents an individual system flag. A set
of standard system flag objects are predefined here.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary">
<caption><span>Fields</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="Flags.Flag.html" title="class in jakarta.mail">Flags.Flag</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#ANSWERED">ANSWERED</a></span></code></th>
<td class="colLast">
<div class="block">This message has been answered.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="Flags.Flag.html" title="class in jakarta.mail">Flags.Flag</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#DELETED">DELETED</a></span></code></th>
<td class="colLast">
<div class="block">This message is marked deleted.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="Flags.Flag.html" title="class in jakarta.mail">Flags.Flag</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#DRAFT">DRAFT</a></span></code></th>
<td class="colLast">
<div class="block">This message is a draft.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="Flags.Flag.html" title="class in jakarta.mail">Flags.Flag</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#FLAGGED">FLAGGED</a></span></code></th>
<td class="colLast">
<div class="block">This message is flagged.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="Flags.Flag.html" title="class in jakarta.mail">Flags.Flag</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#RECENT">RECENT</a></span></code></th>
<td class="colLast">
<div class="block">This message is recent.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="Flags.Flag.html" title="class in jakarta.mail">Flags.Flag</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#SEEN">SEEN</a></span></code></th>
<td class="colLast">
<div class="block">This message is seen.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="Flags.Flag.html" title="class in jakarta.mail">Flags.Flag</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#USER">USER</a></span></code></th>
<td class="colLast">
<div class="block">A special flag that indicates that this folder supports
user defined flags.</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a id="ANSWERED">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ANSWERED</h4>
<pre>public static final <a href="Flags.Flag.html" title="class in jakarta.mail">Flags.Flag</a> ANSWERED</pre>
<div class="block">This message has been answered. This flag is set by clients
to indicate that this message has been answered to.</div>
</li>
</ul>
<a id="DELETED">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DELETED</h4>
<pre>public static final <a href="Flags.Flag.html" title="class in jakarta.mail">Flags.Flag</a> DELETED</pre>
<div class="block">This message is marked deleted. Clients set this flag to
mark a message as deleted. The expunge operation on a folder
removes all messages in that folder that are marked for deletion.</div>
</li>
</ul>
<a id="DRAFT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DRAFT</h4>
<pre>public static final <a href="Flags.Flag.html" title="class in jakarta.mail">Flags.Flag</a> DRAFT</pre>
<div class="block">This message is a draft. This flag is set by clients
to indicate that the message is a draft message.</div>
</li>
</ul>
<a id="FLAGGED">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>FLAGGED</h4>
<pre>public static final <a href="Flags.Flag.html" title="class in jakarta.mail">Flags.Flag</a> FLAGGED</pre>
<div class="block">This message is flagged. No semantic is defined for this flag.
Clients alter this flag.</div>
</li>
</ul>
<a id="RECENT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>RECENT</h4>
<pre>public static final <a href="Flags.Flag.html" title="class in jakarta.mail">Flags.Flag</a> RECENT</pre>
<div class="block">This message is recent. Folder implementations set this flag
to indicate that this message is new to this folder, that is,
it has arrived since the last time this folder was opened. <p>
Clients cannot alter this flag.</div>
</li>
</ul>
<a id="SEEN">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>SEEN</h4>
<pre>public static final <a href="Flags.Flag.html" title="class in jakarta.mail">Flags.Flag</a> SEEN</pre>
<div class="block">This message is seen. This flag is implicitly set by the
implementation when this Message's content is returned
to the client in some form. The <code>getInputStream</code>
and <code>getContent</code> methods on Message cause this
flag to be set. <p>
Clients can alter this flag.</div>
</li>
</ul>
<a id="USER">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>USER</h4>
<pre>public static final <a href="Flags.Flag.html" title="class in jakarta.mail">Flags.Flag</a> USER</pre>
<div class="block">A special flag that indicates that this folder supports
user defined flags. <p>
The implementation sets this flag. Clients cannot alter
this flag but can use it to determine if a folder supports
user defined flags by using
<code>folder.getPermanentFlags().contains(Flags.Flag.USER)</code>.</div>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../module-summary.html">Module</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage">Jakarta Mail<br>v2.1.0</div>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li><a href="#field.summary">Field</a> | </li>
<li>Constr | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field.detail">Field</a> | </li>
<li>Constr | </li>
<li>Method</li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Comments to : <a href="mailto:mail-dev@eclipse.org">mail-dev@eclipse.org</a>.<br> Copyright © 2019, 2021 Eclipse Foundation. All rights reserved.<br> Use is subject to <a href="../../../doc-files/speclicense.html" target="_top">license terms</a>.</small></p>
</footer>
</body>
</html>