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:36 PST 2009 -->
  6. <META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
  7. <TITLE>
  8. MailEvent (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="MailEvent (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/MailEvent.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/FolderListener.html" title="interface in javax.mail.event"><B>PREV CLASS</B></A>&nbsp;
  60. &nbsp;<A HREF="../../../javax/mail/event/MessageChangedEvent.html" title="class 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/MailEvent.html" target="_top"><B>FRAMES</B></A>  &nbsp;
  63. &nbsp;<A HREF="MailEvent.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="#fields_inherited_from_class_java.util.EventObject">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;FIELD&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 MailEvent</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 "><B>javax.mail.event.MailEvent</B>
  99. </PRE>
  100. <DL>
  101. <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>
  102. </DL>
  103. <DL>
  104. <DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../javax/mail/event/ConnectionEvent.html" title="class in javax.mail.event">ConnectionEvent</A>, <A HREF="../../../javax/mail/event/FolderEvent.html" title="class in javax.mail.event">FolderEvent</A>, <A HREF="../../../javax/mail/event/MessageChangedEvent.html" title="class in javax.mail.event">MessageChangedEvent</A>, <A HREF="../../../javax/mail/event/MessageCountEvent.html" title="class in javax.mail.event">MessageCountEvent</A>, <A HREF="../../../javax/mail/event/StoreEvent.html" title="class in javax.mail.event">StoreEvent</A>, <A HREF="../../../javax/mail/event/TransportEvent.html" title="class in javax.mail.event">TransportEvent</A></DD>
  105. </DL>
  106. <HR>
  107. <DL>
  108. <DT><PRE>public abstract class <B>MailEvent</B><DT>extends <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></DL>
  109. </PRE>
  110.  
  111. <P>
  112. Common base class for mail events, defining the dispatch method.
  113. <P>
  114.  
  115. <P>
  116. <DL>
  117. <DT><B>See Also:</B><DD><A HREF="../../../serialized-form.html#javax.mail.event.MailEvent">Serialized Form</A></DL>
  118. <HR>
  119.  
  120. <P>
  121. <!-- =========== FIELD SUMMARY =========== -->
  122.  
  123. <A NAME="field_summary"><!-- --></A>
  124. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  125. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  126. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
  127. <B>Field Summary</B></FONT></TH>
  128. </TR>
  129. </TABLE>
  130. &nbsp;<A NAME="fields_inherited_from_class_java.util.EventObject"><!-- --></A>
  131. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  132. <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
  133. <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>
  134. </TR>
  135. <TR BGCOLOR="white" CLASS="TableRowColor">
  136. <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>
  137. </TR>
  138. </TABLE>
  139. &nbsp;
  140. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  141.  
  142. <A NAME="constructor_summary"><!-- --></A>
  143. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  144. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  145. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
  146. <B>Constructor Summary</B></FONT></TH>
  147. </TR>
  148. <TR BGCOLOR="white" CLASS="TableRowColor">
  149. <TD><CODE><B><A HREF="../../../javax/mail/event/MailEvent.html#MailEvent(java.lang.Object)">MailEvent</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;source)</CODE>
  150.  
  151. <BR>
  152. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
  153. </TR>
  154. </TABLE>
  155. &nbsp;
  156. <!-- ========== METHOD SUMMARY =========== -->
  157.  
  158. <A NAME="method_summary"><!-- --></A>
  159. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  160. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  161. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
  162. <B>Method Summary</B></FONT></TH>
  163. </TR>
  164. <TR BGCOLOR="white" CLASS="TableRowColor">
  165. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  166. <CODE>abstract &nbsp;void</CODE></FONT></TD>
  167. <TD><CODE><B><A HREF="../../../javax/mail/event/MailEvent.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>
  168.  
  169. <BR>
  170. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This method invokes the appropriate method on a listener for
  171.  this event.</TD>
  172. </TR>
  173. </TABLE>
  174. &nbsp;<A NAME="methods_inherited_from_class_java.util.EventObject"><!-- --></A>
  175. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  176. <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
  177. <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>
  178. </TR>
  179. <TR BGCOLOR="white" CLASS="TableRowColor">
  180. <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>
  181. </TR>
  182. </TABLE>
  183. &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
  184. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  185. <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
  186. <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>
  187. </TR>
  188. <TR BGCOLOR="white" CLASS="TableRowColor">
  189. <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>
  190. </TR>
  191. </TABLE>
  192. &nbsp;
  193. <P>
  194.  
  195. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  196.  
  197. <A NAME="constructor_detail"><!-- --></A>
  198. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  199. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  200. <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
  201. <B>Constructor Detail</B></FONT></TH>
  202. </TR>
  203. </TABLE>
  204.  
  205. <A NAME="MailEvent(java.lang.Object)"><!-- --></A><H3>
  206. MailEvent</H3>
  207. <PRE>
  208. public <B>MailEvent</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;source)</PRE>
  209. <DL>
  210. </DL>
  211.  
  212. <!-- ============ METHOD DETAIL ========== -->
  213.  
  214. <A NAME="method_detail"><!-- --></A>
  215. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  216. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  217. <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
  218. <B>Method Detail</B></FONT></TH>
  219. </TR>
  220. </TABLE>
  221.  
  222. <A NAME="dispatch(java.lang.Object)"><!-- --></A><H3>
  223. dispatch</H3>
  224. <PRE>
  225. public abstract 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>
  226. <DL>
  227. <DD>This method invokes the appropriate method on a listener for
  228.  this event. Subclasses provide the implementation.
  229. <P>
  230. <DD><DL>
  231. </DL>
  232. </DD>
  233. </DL>
  234. <!-- ========= END OF CLASS DATA ========= -->
  235. <HR>
  236.  
  237.  
  238. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  239. <A NAME="navbar_bottom"><!-- --></A>
  240. <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
  241. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
  242. <TR>
  243. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  244. <A NAME="navbar_bottom_firstrow"><!-- --></A>
  245. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  246.   <TR ALIGN="center" VALIGN="top">
  247.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  248.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  249.   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  250.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/MailEvent.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  251.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  252.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  253.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  254.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  255.   </TR>
  256. </TABLE>
  257. </TD>
  258. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  259. </EM>
  260. </TD>
  261. </TR>
  262.  
  263. <TR>
  264. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  265. &nbsp;<A HREF="../../../javax/mail/event/FolderListener.html" title="interface in javax.mail.event"><B>PREV CLASS</B></A>&nbsp;
  266. &nbsp;<A HREF="../../../javax/mail/event/MessageChangedEvent.html" title="class in javax.mail.event"><B>NEXT CLASS</B></A></FONT></TD>
  267. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  268.   <A HREF="../../../index.html?javax/mail/event/MailEvent.html" target="_top"><B>FRAMES</B></A>  &nbsp;
  269. &nbsp;<A HREF="MailEvent.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
  270. &nbsp;<SCRIPT type="text/javascript">
  271.   <!--
  272.   if(window==top) {
  273.     document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
  274.   }
  275.   //-->
  276. </SCRIPT>
  277. <NOSCRIPT>
  278.   <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
  279. </NOSCRIPT>
  280.  
  281.  
  282. </FONT></TD>
  283. </TR>
  284. <TR>
  285. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  286.   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#fields_inherited_from_class_java.util.EventObject">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
  287. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  288. DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
  289. </TR>
  290. </TABLE>
  291. <A NAME="skip-navbar_bottom"></A>
  292. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  293.  
  294. <HR>
  295. Copyright &#169; 2009 <a href="http://www.sun.com">Sun Microsystems, Inc.</a>. All Rights Reserved.
  296. </BODY>
  297. </HTML>
  298.