Subversion Repositories javautils

Rev

Blame | Last modification | View Log | RSS feed

  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2. <!--NewPage-->
  3. <HTML>
  4. <HEAD>
  5. <!-- Generated by javadoc (build 1.6.0_10) on Tue Nov 17 12:13:37 PST 2009 -->
  6. <META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
  7. <TITLE>
  8. MessageCountEvent (JavaMail API documentation)
  9. </TITLE>
  10.  
  11. <META NAME="date" CONTENT="2009-11-17">
  12.  
  13. <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
  14.  
  15. <SCRIPT type="text/javascript">
  16. function windowTitle()
  17. {
  18.     if (location.href.indexOf('is-external=true') == -1) {
  19.         parent.document.title="MessageCountEvent (JavaMail API documentation)";
  20.     }
  21. }
  22. </SCRIPT>
  23. <NOSCRIPT>
  24. </NOSCRIPT>
  25.  
  26. </HEAD>
  27.  
  28. <BODY BGCOLOR="white" onload="windowTitle();">
  29. <HR>
  30.  
  31.  
  32. <!-- ========= START OF TOP NAVBAR ======= -->
  33. <A NAME="navbar_top"><!-- --></A>
  34. <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
  35. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
  36. <TR>
  37. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  38. <A NAME="navbar_top_firstrow"><!-- --></A>
  39. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  40.   <TR ALIGN="center" VALIGN="top">
  41.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  42.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  43.   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  44.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/MessageCountEvent.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  45.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  46.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  47.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  48.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  49.   </TR>
  50. </TABLE>
  51. </TD>
  52. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  53. </EM>
  54. </TD>
  55. </TR>
  56.  
  57. <TR>
  58. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  59. &nbsp;<A HREF="../../../javax/mail/event/MessageCountAdapter.html" title="class in javax.mail.event"><B>PREV CLASS</B></A>&nbsp;
  60. &nbsp;<A HREF="../../../javax/mail/event/MessageCountListener.html" title="interface in javax.mail.event"><B>NEXT CLASS</B></A></FONT></TD>
  61. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  62.   <A HREF="../../../index.html?javax/mail/event/MessageCountEvent.html" target="_top"><B>FRAMES</B></A>  &nbsp;
  63. &nbsp;<A HREF="MessageCountEvent.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
  64. &nbsp;<SCRIPT type="text/javascript">
  65.   <!--
  66.   if(window==top) {
  67.     document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
  68.   }
  69.   //-->
  70. </SCRIPT>
  71. <NOSCRIPT>
  72.   <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
  73. </NOSCRIPT>
  74.  
  75.  
  76. </FONT></TD>
  77. </TR>
  78. <TR>
  79. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  80.   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
  81. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  82. DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
  83. </TR>
  84. </TABLE>
  85. <A NAME="skip-navbar_top"></A>
  86. <!-- ========= END OF TOP NAVBAR ========= -->
  87.  
  88. <HR>
  89. <!-- ======== START OF CLASS DATA ======== -->
  90. <H2>
  91. <FONT SIZE="-1">
  92. javax.mail.event</FONT>
  93. <BR>
  94. Class MessageCountEvent</H2>
  95. <PRE>
  96. <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A>
  97.   <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/util/EventObject.html?is-external=true" title="class or interface in java.util">java.util.EventObject</A>
  98.       <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../javax/mail/event/MailEvent.html" title="class in javax.mail.event">javax.mail.event.MailEvent</A>
  99.           <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>javax.mail.event.MessageCountEvent</B>
  100. </PRE>
  101. <DL>
  102. <DT><B>All Implemented Interfaces:</B> <DD><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</A></DD>
  103. </DL>
  104. <HR>
  105. <DL>
  106. <DT><PRE>public class <B>MessageCountEvent</B><DT>extends <A HREF="../../../javax/mail/event/MailEvent.html" title="class in javax.mail.event">MailEvent</A></DL>
  107. </PRE>
  108.  
  109. <P>
  110. This class notifies changes in the number of messages in a folder. <p>
  111.  
  112.  Note that some folder types may only deliver MessageCountEvents at
  113.  certain times or after certain operations.  IMAP in particular will
  114.  only notify the client of MessageCountEvents when a client issues a
  115.  new command.
  116.  Refer to RFC 2060 <A HREF="http://www.ietf.org/rfc/rfc2060.txt">
  117.  http://www.ietf.org/rfc/rfc2060.txt</A> for details.
  118.  A client may want "poll" the folder by occasionally calling the
  119.  <code>getMessageCount</code> or <code>isConnected</code> methods
  120.  to solicit any such notifications.
  121. <P>
  122.  
  123. <P>
  124. <DL>
  125. <DT><B>See Also:</B><DD><A HREF="../../../serialized-form.html#javax.mail.event.MessageCountEvent">Serialized Form</A></DL>
  126. <HR>
  127.  
  128. <P>
  129. <!-- =========== FIELD SUMMARY =========== -->
  130.  
  131. <A NAME="field_summary"><!-- --></A>
  132. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  133. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  134. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
  135. <B>Field Summary</B></FONT></TH>
  136. </TR>
  137. <TR BGCOLOR="white" CLASS="TableRowColor">
  138. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  139. <CODE>static&nbsp;int</CODE></FONT></TD>
  140. <TD><CODE><B><A HREF="../../../javax/mail/event/MessageCountEvent.html#ADDED">ADDED</A></B></CODE>
  141.  
  142. <BR>
  143. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The messages were added to their folder</TD>
  144. </TR>
  145. <TR BGCOLOR="white" CLASS="TableRowColor">
  146. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  147. <CODE>protected &nbsp;<A HREF="../../../javax/mail/Message.html" title="class in javax.mail">Message</A>[]</CODE></FONT></TD>
  148. <TD><CODE><B><A HREF="../../../javax/mail/event/MessageCountEvent.html#msgs">msgs</A></B></CODE>
  149.  
  150. <BR>
  151. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The messages.</TD>
  152. </TR>
  153. <TR BGCOLOR="white" CLASS="TableRowColor">
  154. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  155. <CODE>protected &nbsp;boolean</CODE></FONT></TD>
  156. <TD><CODE><B><A HREF="../../../javax/mail/event/MessageCountEvent.html#removed">removed</A></B></CODE>
  157.  
  158. <BR>
  159. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;If true, this event is the result of an explicit
  160.  expunge by this client, and the messages in this
  161.  folder have been renumbered to account for this.</TD>
  162. </TR>
  163. <TR BGCOLOR="white" CLASS="TableRowColor">
  164. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  165. <CODE>static&nbsp;int</CODE></FONT></TD>
  166. <TD><CODE><B><A HREF="../../../javax/mail/event/MessageCountEvent.html#REMOVED">REMOVED</A></B></CODE>
  167.  
  168. <BR>
  169. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The messages were removed from their folder</TD>
  170. </TR>
  171. <TR BGCOLOR="white" CLASS="TableRowColor">
  172. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  173. <CODE>protected &nbsp;int</CODE></FONT></TD>
  174. <TD><CODE><B><A HREF="../../../javax/mail/event/MessageCountEvent.html#type">type</A></B></CODE>
  175.  
  176. <BR>
  177. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The event type.</TD>
  178. </TR>
  179. </TABLE>
  180. &nbsp;<A NAME="fields_inherited_from_class_java.util.EventObject"><!-- --></A>
  181. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  182. <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
  183. <TH ALIGN="left"><B>Fields inherited from class java.util.<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/util/EventObject.html?is-external=true" title="class or interface in java.util">EventObject</A></B></TH>
  184. </TR>
  185. <TR BGCOLOR="white" CLASS="TableRowColor">
  186. <TD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/util/EventObject.html?is-external=true#source" title="class or interface in java.util">source</A></CODE></TD>
  187. </TR>
  188. </TABLE>
  189. &nbsp;
  190. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  191.  
  192. <A NAME="constructor_summary"><!-- --></A>
  193. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  194. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  195. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
  196. <B>Constructor Summary</B></FONT></TH>
  197. </TR>
  198. <TR BGCOLOR="white" CLASS="TableRowColor">
  199. <TD><CODE><B><A HREF="../../../javax/mail/event/MessageCountEvent.html#MessageCountEvent(javax.mail.Folder, int, boolean, javax.mail.Message[])">MessageCountEvent</A></B>(<A HREF="../../../javax/mail/Folder.html" title="class in javax.mail">Folder</A>&nbsp;folder,
  200.                   int&nbsp;type,
  201.                   boolean&nbsp;removed,
  202.                   <A HREF="../../../javax/mail/Message.html" title="class in javax.mail">Message</A>[]&nbsp;msgs)</CODE>
  203.  
  204. <BR>
  205. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructor.</TD>
  206. </TR>
  207. </TABLE>
  208. &nbsp;
  209. <!-- ========== METHOD SUMMARY =========== -->
  210.  
  211. <A NAME="method_summary"><!-- --></A>
  212. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  213. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  214. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
  215. <B>Method Summary</B></FONT></TH>
  216. </TR>
  217. <TR BGCOLOR="white" CLASS="TableRowColor">
  218. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  219. <CODE>&nbsp;void</CODE></FONT></TD>
  220. <TD><CODE><B><A HREF="../../../javax/mail/event/MessageCountEvent.html#dispatch(java.lang.Object)">dispatch</A></B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>&nbsp;listener)</CODE>
  221.  
  222. <BR>
  223. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Invokes the appropriate MessageCountListener method.</TD>
  224. </TR>
  225. <TR BGCOLOR="white" CLASS="TableRowColor">
  226. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  227. <CODE>&nbsp;<A HREF="../../../javax/mail/Message.html" title="class in javax.mail">Message</A>[]</CODE></FONT></TD>
  228. <TD><CODE><B><A HREF="../../../javax/mail/event/MessageCountEvent.html#getMessages()">getMessages</A></B>()</CODE>
  229.  
  230. <BR>
  231. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return the array of messages added or removed.</TD>
  232. </TR>
  233. <TR BGCOLOR="white" CLASS="TableRowColor">
  234. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  235. <CODE>&nbsp;int</CODE></FONT></TD>
  236. <TD><CODE><B><A HREF="../../../javax/mail/event/MessageCountEvent.html#getType()">getType</A></B>()</CODE>
  237.  
  238. <BR>
  239. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return the type of this event.</TD>
  240. </TR>
  241. <TR BGCOLOR="white" CLASS="TableRowColor">
  242. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  243. <CODE>&nbsp;boolean</CODE></FONT></TD>
  244. <TD><CODE><B><A HREF="../../../javax/mail/event/MessageCountEvent.html#isRemoved()">isRemoved</A></B>()</CODE>
  245.  
  246. <BR>
  247. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Indicates whether this event is the result of an explicit
  248.  expunge by this client, or due to an expunge from external
  249.  sources.</TD>
  250. </TR>
  251. </TABLE>
  252. &nbsp;<A NAME="methods_inherited_from_class_java.util.EventObject"><!-- --></A>
  253. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  254. <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
  255. <TH ALIGN="left"><B>Methods inherited from class java.util.<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/util/EventObject.html?is-external=true" title="class or interface in java.util">EventObject</A></B></TH>
  256. </TR>
  257. <TR BGCOLOR="white" CLASS="TableRowColor">
  258. <TD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/util/EventObject.html?is-external=true#getSource()" title="class or interface in java.util">getSource</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/util/EventObject.html?is-external=true#toString()" title="class or interface in java.util">toString</A></CODE></TD>
  259. </TR>
  260. </TABLE>
  261. &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
  262. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  263. <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
  264. <TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH>
  265. </TR>
  266. <TR BGCOLOR="white" CLASS="TableRowColor">
  267. <TD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
  268. </TR>
  269. </TABLE>
  270. &nbsp;
  271. <P>
  272.  
  273. <!-- ============ FIELD DETAIL =========== -->
  274.  
  275. <A NAME="field_detail"><!-- --></A>
  276. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  277. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  278. <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
  279. <B>Field Detail</B></FONT></TH>
  280. </TR>
  281. </TABLE>
  282.  
  283. <A NAME="ADDED"><!-- --></A><H3>
  284. ADDED</H3>
  285. <PRE>
  286. public static final int <B>ADDED</B></PRE>
  287. <DL>
  288. <DD>The messages were added to their folder
  289. <P>
  290. <DL>
  291. <DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#javax.mail.event.MessageCountEvent.ADDED">Constant Field Values</A></DL>
  292. </DL>
  293. <HR>
  294.  
  295. <A NAME="REMOVED"><!-- --></A><H3>
  296. REMOVED</H3>
  297. <PRE>
  298. public static final int <B>REMOVED</B></PRE>
  299. <DL>
  300. <DD>The messages were removed from their folder
  301. <P>
  302. <DL>
  303. <DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#javax.mail.event.MessageCountEvent.REMOVED">Constant Field Values</A></DL>
  304. </DL>
  305. <HR>
  306.  
  307. <A NAME="type"><!-- --></A><H3>
  308. type</H3>
  309. <PRE>
  310. protected int <B>type</B></PRE>
  311. <DL>
  312. <DD>The event type.
  313. <P>
  314. <DL>
  315. </DL>
  316. </DL>
  317. <HR>
  318.  
  319. <A NAME="removed"><!-- --></A><H3>
  320. removed</H3>
  321. <PRE>
  322. protected boolean <B>removed</B></PRE>
  323. <DL>
  324. <DD>If true, this event is the result of an explicit
  325.  expunge by this client, and the messages in this
  326.  folder have been renumbered to account for this.
  327.  If false, this event is the result of an expunge
  328.  by external sources.
  329. <P>
  330. <DL>
  331. </DL>
  332. </DL>
  333. <HR>
  334.  
  335. <A NAME="msgs"><!-- --></A><H3>
  336. msgs</H3>
  337. <PRE>
  338. protected transient <A HREF="../../../javax/mail/Message.html" title="class in javax.mail">Message</A>[] <B>msgs</B></PRE>
  339. <DL>
  340. <DD>The messages.
  341. <P>
  342. <DL>
  343. </DL>
  344. </DL>
  345.  
  346. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  347.  
  348. <A NAME="constructor_detail"><!-- --></A>
  349. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  350. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  351. <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
  352. <B>Constructor Detail</B></FONT></TH>
  353. </TR>
  354. </TABLE>
  355.  
  356. <A NAME="MessageCountEvent(javax.mail.Folder, int, boolean, javax.mail.Message[])"><!-- --></A><H3>
  357. MessageCountEvent</H3>
  358. <PRE>
  359. public <B>MessageCountEvent</B>(<A HREF="../../../javax/mail/Folder.html" title="class in javax.mail">Folder</A>&nbsp;folder,
  360.                          int&nbsp;type,
  361.                          boolean&nbsp;removed,
  362.                          <A HREF="../../../javax/mail/Message.html" title="class in javax.mail">Message</A>[]&nbsp;msgs)</PRE>
  363. <DL>
  364. <DD>Constructor.
  365. <P>
  366. <DL>
  367. <DT><B>Parameters:</B><DD><CODE>folder</CODE> - The containing folder<DD><CODE>type</CODE> - The event type<DD><CODE>removed</CODE> - If true, this event is the result of an explicit
  368.                         expunge by this client, and the messages in this
  369.                         folder have been renumbered to account for this.
  370.                         If false, this event is the result of an expunge
  371.                         by external sources.<DD><CODE>msgs</CODE> - The messages added/removed</DL>
  372. </DL>
  373.  
  374. <!-- ============ METHOD DETAIL ========== -->
  375.  
  376. <A NAME="method_detail"><!-- --></A>
  377. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  378. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  379. <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
  380. <B>Method Detail</B></FONT></TH>
  381. </TR>
  382. </TABLE>
  383.  
  384. <A NAME="getType()"><!-- --></A><H3>
  385. getType</H3>
  386. <PRE>
  387. public int <B>getType</B>()</PRE>
  388. <DL>
  389. <DD>Return the type of this event.
  390. <P>
  391. <DD><DL>
  392.  
  393. <DT><B>Returns:</B><DD>type</DL>
  394. </DD>
  395. </DL>
  396. <HR>
  397.  
  398. <A NAME="isRemoved()"><!-- --></A><H3>
  399. isRemoved</H3>
  400. <PRE>
  401. public boolean <B>isRemoved</B>()</PRE>
  402. <DL>
  403. <DD>Indicates whether this event is the result of an explicit
  404.  expunge by this client, or due to an expunge from external
  405.  sources. If <code>true</code>, this event is due to an
  406.  explicit expunge and hence all remaining messages in this
  407.  folder have been renumbered. If <code>false</code>, this event
  408.  is due to an external expunge. <p>
  409.  
  410.  Note that this method is valid only if the type of this event
  411.  is <code>REMOVED</code>
  412. <P>
  413. <DD><DL>
  414. </DL>
  415. </DD>
  416. </DL>
  417. <HR>
  418.  
  419. <A NAME="getMessages()"><!-- --></A><H3>
  420. getMessages</H3>
  421. <PRE>
  422. public <A HREF="../../../javax/mail/Message.html" title="class in javax.mail">Message</A>[] <B>getMessages</B>()</PRE>
  423. <DL>
  424. <DD>Return the array of messages added or removed.
  425. <P>
  426. <DD><DL>
  427.  
  428. <DT><B>Returns:</B><DD>array of messages</DL>
  429. </DD>
  430. </DL>
  431. <HR>
  432.  
  433. <A NAME="dispatch(java.lang.Object)"><!-- --></A><H3>
  434. dispatch</H3>
  435. <PRE>
  436. public void <B>dispatch</B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>&nbsp;listener)</PRE>
  437. <DL>
  438. <DD>Invokes the appropriate MessageCountListener method.
  439. <P>
  440. <DD><DL>
  441. <DT><B>Specified by:</B><DD><CODE><A HREF="../../../javax/mail/event/MailEvent.html#dispatch(java.lang.Object)">dispatch</A></CODE> in class <CODE><A HREF="../../../javax/mail/event/MailEvent.html" title="class in javax.mail.event">MailEvent</A></CODE></DL>
  442. </DD>
  443. <DD><DL>
  444. </DL>
  445. </DD>
  446. </DL>
  447. <!-- ========= END OF CLASS DATA ========= -->
  448. <HR>
  449.  
  450.  
  451. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  452. <A NAME="navbar_bottom"><!-- --></A>
  453. <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
  454. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
  455. <TR>
  456. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  457. <A NAME="navbar_bottom_firstrow"><!-- --></A>
  458. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  459.   <TR ALIGN="center" VALIGN="top">
  460.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  461.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  462.   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  463.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/MessageCountEvent.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  464.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  465.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  466.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  467.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  468.   </TR>
  469. </TABLE>
  470. </TD>
  471. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  472. </EM>
  473. </TD>
  474. </TR>
  475.  
  476. <TR>
  477. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  478. &nbsp;<A HREF="../../../javax/mail/event/MessageCountAdapter.html" title="class in javax.mail.event"><B>PREV CLASS</B></A>&nbsp;
  479. &nbsp;<A HREF="../../../javax/mail/event/MessageCountListener.html" title="interface in javax.mail.event"><B>NEXT CLASS</B></A></FONT></TD>
  480. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  481.   <A HREF="../../../index.html?javax/mail/event/MessageCountEvent.html" target="_top"><B>FRAMES</B></A>  &nbsp;
  482. &nbsp;<A HREF="MessageCountEvent.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
  483. &nbsp;<SCRIPT type="text/javascript">
  484.   <!--
  485.   if(window==top) {
  486.     document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
  487.   }
  488.   //-->
  489. </SCRIPT>
  490. <NOSCRIPT>
  491.   <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
  492. </NOSCRIPT>
  493.  
  494.  
  495. </FONT></TD>
  496. </TR>
  497. <TR>
  498. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  499.   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
  500. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  501. DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
  502. </TR>
  503. </TABLE>
  504. <A NAME="skip-navbar_bottom"></A>
  505. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  506.  
  507. <HR>
  508. Copyright &#169; 2009 <a href="http://www.sun.com">Sun Microsystems, Inc.</a>. All Rights Reserved.
  509. </BODY>
  510. </HTML>
  511.