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:43 PST 2009 -->
  6. <META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
  7. <TITLE>
  8. com.sun.mail.imap (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="com.sun.mail.imap (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="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT>&nbsp;</TD>
  43.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>
  44.   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-use.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="../../../../com/sun/mail/dsn/package-summary.html"><B>PREV PACKAGE</B></A>&nbsp;
  60. &nbsp;<A HREF="../../../../com/sun/mail/pop3/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD>
  61. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  62.   <A HREF="../../../../index.html?com/sun/mail/imap/package-summary.html" target="_top"><B>FRAMES</B></A>  &nbsp;
  63. &nbsp;<A HREF="package-summary.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. </TABLE>
  79. <A NAME="skip-navbar_top"></A>
  80. <!-- ========= END OF TOP NAVBAR ========= -->
  81.  
  82. <HR>
  83. <H2>
  84. Package com.sun.mail.imap
  85. </H2>
  86. An IMAP protocol provider for the JavaMail API
  87. that provides access to an IMAP message store.
  88. <P>
  89. <B>See:</B>
  90. <BR>
  91. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<A HREF="#package_description"><B>Description</B></A>
  92. <P>
  93.  
  94. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  95. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  96. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
  97. <B>Interface Summary</B></FONT></TH>
  98. </TR>
  99. <TR BGCOLOR="white" CLASS="TableRowColor">
  100. <TD WIDTH="15%"><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.ProtocolCommand.html" title="interface in com.sun.mail.imap">IMAPFolder.ProtocolCommand</A></B></TD>
  101. <TD>A simple interface for user-defined IMAP protocol commands.</TD>
  102. </TR>
  103. </TABLE>
  104. &nbsp;
  105.  
  106. <P>
  107.  
  108. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  109. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  110. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
  111. <B>Class Summary</B></FONT></TH>
  112. </TR>
  113. <TR BGCOLOR="white" CLASS="TableRowColor">
  114. <TD WIDTH="15%"><B><A HREF="../../../../com/sun/mail/imap/ACL.html" title="class in com.sun.mail.imap">ACL</A></B></TD>
  115. <TD>An access control list entry for a particular authentication identifier
  116.  (user or group).</TD>
  117. </TR>
  118. <TR BGCOLOR="white" CLASS="TableRowColor">
  119. <TD WIDTH="15%"><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.html" title="class in com.sun.mail.imap">IMAPFolder</A></B></TD>
  120. <TD>This class implements an IMAP folder.</TD>
  121. </TR>
  122. <TR BGCOLOR="white" CLASS="TableRowColor">
  123. <TD WIDTH="15%"><B><A HREF="../../../../com/sun/mail/imap/IMAPFolder.FetchProfileItem.html" title="class in com.sun.mail.imap">IMAPFolder.FetchProfileItem</A></B></TD>
  124. <TD>A fetch profile item for fetching headers.</TD>
  125. </TR>
  126. <TR BGCOLOR="white" CLASS="TableRowColor">
  127. <TD WIDTH="15%"><B><A HREF="../../../../com/sun/mail/imap/IMAPMessage.html" title="class in com.sun.mail.imap">IMAPMessage</A></B></TD>
  128. <TD>This class implements an IMAPMessage object.</TD>
  129. </TR>
  130. <TR BGCOLOR="white" CLASS="TableRowColor">
  131. <TD WIDTH="15%"><B><A HREF="../../../../com/sun/mail/imap/IMAPSSLStore.html" title="class in com.sun.mail.imap">IMAPSSLStore</A></B></TD>
  132. <TD>This class provides access to an IMAP message store over SSL.</TD>
  133. </TR>
  134. <TR BGCOLOR="white" CLASS="TableRowColor">
  135. <TD WIDTH="15%"><B><A HREF="../../../../com/sun/mail/imap/IMAPStore.html" title="class in com.sun.mail.imap">IMAPStore</A></B></TD>
  136. <TD>This class provides access to an IMAP message store.</TD>
  137. </TR>
  138. <TR BGCOLOR="white" CLASS="TableRowColor">
  139. <TD WIDTH="15%"><B><A HREF="../../../../com/sun/mail/imap/Rights.html" title="class in com.sun.mail.imap">Rights</A></B></TD>
  140. <TD>The Rights class represents the set of rights for an authentication
  141.  identifier (for instance, a user or a group).</TD>
  142. </TR>
  143. <TR BGCOLOR="white" CLASS="TableRowColor">
  144. <TD WIDTH="15%"><B><A HREF="../../../../com/sun/mail/imap/Rights.Right.html" title="class in com.sun.mail.imap">Rights.Right</A></B></TD>
  145. <TD>This inner class represents an individual right.</TD>
  146. </TR>
  147. </TABLE>
  148. &nbsp;
  149.  
  150. <P>
  151. <A NAME="package_description"><!-- --></A><H2>
  152. Package com.sun.mail.imap Description
  153. </H2>
  154.  
  155. <P>
  156. An IMAP protocol provider for the JavaMail API
  157. that provides access to an IMAP message store.
  158. Both the IMAP4 and IMAP4rev1 protocols are supported.
  159. Refer to <A HREF="http://www.ietf.org/rfc/rfc2060.txt" TARGET="_top">
  160. RFC 2060</A>
  161. for more information.
  162. <P>
  163. The IMAP protocol provider can use SASL
  164. (<A HREF="http://www.ietf.org/rfc/rfc2222.txt" TARGET="_top">RFC 2222</A>)
  165. authentication mechanisms on systems that support the
  166. <CODE>javax.security.sasl</CODE> APIs, such as J2SE 5.0.
  167. In addition to the SASL mechanisms that are built into
  168. the SASL implementation, users can also provide additional
  169. SASL mechanisms of their own design to support custom authentication
  170. schemes.  See the
  171. <A HREF="http://java.sun.com/j2se/1.5.0/docs/guide/security/sasl/sasl-refguide.html" TARGET="_top">
  172. Java SASL API Programming and Deployment Guide</A> for details.
  173. Note that the current implementation doesn't support SASL mechanisms
  174. that provide their own integrity or confidentiality layer.
  175. <P>
  176. A connected IMAPStore maintains a pool of IMAP protocol objects for
  177. use in communicating with the IMAP server. The IMAPStore will create
  178. the initial AUTHENTICATED connection and seed the pool with this
  179. connection. As folders are opened and new IMAP protocol objects are
  180. needed, the IMAPStore will provide them from the connection pool,
  181. or create them if none are available. When a folder is closed,
  182. its IMAP protocol object is returned to the connection pool if the
  183. pool is not over capacity.
  184. <P>
  185. A mechanism is provided for timing out idle connection pool IMAP
  186. protocol objects. Timed out connections are closed and removed (pruned)
  187. from the connection pool.
  188. <P>
  189. The connected IMAPStore object may or may not maintain a separate IMAP
  190. protocol object that provides the store a dedicated connection to the
  191. IMAP server. This is provided mainly for compatibility with previous
  192. implementations of the IMAP protocol provider.
  193. <P>
  194. The IMAP protocol provider supports the following properties,
  195. which may be set in the JavaMail <code>Session</code> object.
  196. The properties are always set as strings; the Type column describes
  197. how the string is interpreted.  For example, use
  198. <PRE>
  199.        props.put("mail.imap.port", "888");
  200. </PRE>
  201. to set the <CODE>mail.imap.port</CODE> property, which is of type int.
  202. <P>
  203. Note that if you're using the "imaps" protocol to access IMAP over SSL,
  204. all the properties would be named "mail.imaps.*".
  205. <P>
  206. <TABLE BORDER>
  207. <TR>
  208. <TH>Name</TH>
  209. <TH>Type</TH>
  210. <TH>Description</TH>
  211. </TR>
  212.  
  213. <TR>
  214. <TD>mail.imap.user</TD>
  215. <TD>String</TD>
  216. <TD>Default user name for IMAP.</TD>
  217. </TR>
  218.  
  219. <TR>
  220. <TD>mail.imap.host</TD>
  221. <TD>String</TD>
  222. <TD>The IMAP server to connect to.</TD>
  223. </TR>
  224.  
  225. <TR>
  226. <TD>mail.imap.port</TD>
  227. <TD>int</TD>
  228. <TD>The IMAP server port to connect to, if the connect() method doesn't
  229. explicitly specify one. Defaults to 143.</TD>
  230. </TR>
  231.  
  232. <TR>
  233. <TD>mail.imap.partialfetch</TD>
  234. <TD>boolean</TD>
  235. <TD>Controls whether the IMAP partial-fetch capability should be used.
  236. Defaults to true.</TD>
  237. </TR>
  238.  
  239. <TR>
  240. <TD>mail.imap.fetchsize</TD>
  241. <TD>int</TD>
  242. <TD>Partial fetch size in bytes. Defaults to 16K.</TD>
  243. </TR>
  244.  
  245. <TR>
  246. <TD>mail.imap.connectiontimeout</TD>
  247. <TD>int</TD>
  248. <TD>Socket connection timeout value in milliseconds.
  249. Default is infinite timeout.</TD>
  250. </TR>
  251.  
  252. <TR>
  253. <TD>mail.imap.timeout</TD>
  254. <TD>int</TD>
  255. <TD>Socket I/O timeout value in milliseconds.  Default is infinite timeout.</TD>
  256. </TR>
  257.  
  258. <TR>
  259. <TD>mail.imap.statuscachetimeout</TD>
  260. <TD>int</TD>
  261. <TD>Timeout value in milliseconds for cache of STATUS command response.
  262. Default is 1000 (1 second).  Zero disables cache.</TD>
  263. </TR>
  264.  
  265. <TR>
  266. <TD>mail.imap.appendbuffersize</TD>
  267. <TD>int</TD>
  268. <TD>
  269. Maximum size of a message to buffer in memory when appending to an IMAP
  270. folder.  If not set, or set to -1, there is no maximum and all messages
  271. are buffered.  If set to 0, no messages are buffered.  If set to (e.g.)
  272. 8192, messages of 8K bytes or less are buffered, larger messages are
  273. not buffered.  Buffering saves cpu time at the expense of short term
  274. memory usage.  If you commonly append very large messages to IMAP
  275. mailboxes you might want to set this to a moderate value (1M or less).
  276. </TD>
  277. </TR>
  278.  
  279. <TR>
  280. <TD>mail.imap.connectionpoolsize</TD>
  281. <TD>int</TD>
  282. <TD>Maximum number of available connections in the connection pool.
  283. Default is 1.</TD>
  284. </TR>
  285.  
  286. <TR>
  287. <TD>mail.imap.connectionpooltimeout</TD>
  288. <TD>int</TD>
  289. <TD>Timeout value in milliseconds for connection pool connections.  Default
  290. is 45000 (45 seconds).</TD>
  291. </TR>
  292.  
  293. <TR>
  294. <TD>mail.imap.separatestoreconnection</TD>
  295. <TD>boolean</TD>
  296. <TD>Flag to indicate whether to use a dedicated store connection for store
  297. commands.  Default is false.</TD>
  298. </TR>
  299.  
  300. <TR>
  301. <TD>mail.imap.allowreadonlyselect</TD>
  302. <TD>boolean</TD>
  303. <TD>If false, attempts to open a folder read/write will fail
  304. if the SELECT command succeeds but indicates that the folder is READ-ONLY.
  305. This sometimes indicates that the folder contents can'tbe changed, but
  306. the flags are per-user and can be changed, such as might be the case for
  307. public shared folders.  If true, such open attempts will succeed, allowing
  308. the flags to be changed.  The <code>getMode</code> method on the
  309. <code>Folder</code> object will return <code>Folder.READ_ONLY</code>
  310. in this case even though the <code>open</code> method specified
  311. <code>Folder.READ_WRITE</code>.  Default is false.</TD>
  312. </TR>
  313.  
  314. <TR>
  315. <TD>mail.imap.auth.login.disable</TD>
  316. <TD>boolean</TD>
  317. <TD>If true, prevents use of the non-standard <code>AUTHENTICATE LOGIN</code>
  318. command, instead using the plain <code>LOGIN</code> command.
  319. Default is false.</TD>
  320. </TR>
  321.  
  322. <TR>
  323. <TD>mail.imap.auth.plain.disable</TD>
  324. <TD>boolean</TD>
  325. <TD>If true, prevents use of the <code>AUTHENTICATE PLAIN</code> command.
  326. Default is false.</TD>
  327. </TR>
  328.  
  329. <TR>
  330. <TD>mail.imap.proxyauth.user</TD>
  331. <TD>String</TD>
  332. <TD>If the server supports the PROXYAUTH extension, this property
  333. specifies the name of the user to act as.  Authenticate to the
  334. server using the administrator's credentials.  After authentication,
  335. the IMAP provider will issue the <code>PROXYAUTH</code> command with
  336. the user name specified in this property.
  337. </TD>
  338. </TR>
  339.  
  340. <TR>
  341. <TD>mail.imap.starttls.enable</TD>
  342. <TD>boolean</TD>
  343. <TD>If true, enables the use of the <code>STARTTLS</code> command (if
  344. supported by the server) to switch the connection to a TLS-protected
  345. connection before issuing any login commands.  Note that an appropriate
  346. trust store must configured so that the client will trust the server's
  347. certificate.  This feature only works on J2SE 1.4 and newer systems.
  348. Default is false.</TD>
  349. </TR>
  350.  
  351. <TR>
  352. <TD>mail.imap.starttls.required</TD>
  353. <TD>boolean</TD>
  354. <TD>
  355. If true, requires the use of the <code>STARTTLS</code> command.
  356. If the server doesn't support the STARTTLS command, or the command
  357. fails, the connect method will fail.
  358. Defaults to false.
  359. </TD>
  360. </TR>
  361.  
  362. <TR>
  363. <TD>mail.imap.localaddress</TD>
  364. <TD>String</TD>
  365. <TD>
  366. Local address (host name) to bind to when creating the IMAP socket.
  367. Defaults to the address picked by the Socket class.
  368. Should not normally need to be set, but useful with multi-homed hosts
  369. where it's important to pick a particular local address to bind to.
  370. </TD>
  371. </TR>
  372.  
  373. <TR>
  374. <TD>mail.imap.localport</TD>
  375. <TD>int</TD>
  376. <TD>
  377. Local port number to bind to when creating the IMAP socket.
  378. Defaults to the port number picked by the Socket class.
  379. </TD>
  380. </TR>
  381.  
  382. <TR>
  383. <TD>mail.imap.sasl.enable</TD>
  384. <TD>boolean</TD>
  385. <TD>
  386. If set to true, attempt to use the javax.security.sasl package to
  387. choose an authentication mechanism for login.
  388. Defaults to false.
  389. </TD>
  390. </TR>
  391.  
  392. <TR>
  393. <TD>mail.imap.sasl.mechanisms</TD>
  394. <TD>String</TD>
  395. <TD>
  396. A space or comma separated list of SASL mechanism names to try
  397. to use.
  398. </TD>
  399. </TR>
  400.  
  401. <TR>
  402. <TD>mail.imap.sasl.authorizationid</TD>
  403. <TD>String</TD>
  404. <TD>
  405. The authorization ID to use in the SASL authentication.
  406. If not set, the authentication ID (user name) is used.
  407. </TD>
  408. </TR>
  409.  
  410. <TR>
  411. <TD>mail.imap.sasl.realm</TD>
  412. <TD>String</TD>
  413. <TD>The realm to use with SASL authentication mechanisms that
  414. require a realm, such as DIGEST-MD5.</TD>
  415. </TR>
  416.  
  417. <TR>
  418. <TD>mail.imap.sasl.xgwtrustedapphack.enable</TD>
  419. <TD>boolean</TD>
  420. <TD>
  421. If set to true, enables a workaround for a bug in the Novell Groupwise
  422. XGWTRUSTEDAPP SASL mechanism, when that mechanism is being used.
  423. Defaults to true.
  424. </TD>
  425. </TR>
  426.  
  427. <TR>
  428. <TD>mail.imap.auth.ntlm.domain</TD>
  429. <TD>String</TD>
  430. <TD>
  431. The NTLM authentication domain.
  432. </TD>
  433. </TR>
  434.  
  435. <TR>
  436. <TD>mail.imap.auth.ntlm.flags</TD>
  437. <TD>int</TD>
  438. <TD>
  439. NTLM protocol-specific flags.
  440. See <A HREF="http://curl.haxx.se/rfc/ntlm.html#theNtlmFlags" TARGET="_top">
  441. http://curl.haxx.se/rfc/ntlm.html#theNtlmFlags</A> for details.
  442. </TD>
  443. </TR>
  444.  
  445. <!--
  446. <TR>
  447. <TD>mail.imap.auth.ntlm.unicode</TD>
  448. <TD>boolean</TD>
  449. <TD>
  450. Set this to "true" if the username or password may use
  451. Unicode UTF-8 encoded characters.  Default is "true".
  452. Currently has no effect.
  453. </TD>
  454. </TR>
  455.  
  456. <TR>
  457. <TD>mail.imap.auth.ntlm.lmcompat</TD>
  458. <TD>int</TD>
  459. <TD>
  460. Sets the LM compatibility level, as described here:
  461. <A HREF="http://curl.haxx.se/rfc/ntlm.html#ntlmVersion2" TARGET="_top">
  462. http://curl.haxx.se/rfc/ntlm.html#ntlmVersion2</A>
  463. Defaults to "3".  Currently not used.
  464. </TD>
  465. </TR>
  466. -->
  467.  
  468. <TR>
  469. <TD>mail.imap.socketFactory</TD>
  470. <TD>SocketFactory</TD>
  471. <TD>
  472. If set to a class that implements the
  473. <code>javax.net.SocketFactory</code> interface, this class
  474. will be used to create IMAP sockets.  Note that this is an
  475. instance of a class, not a name, and must be set using the
  476. <code>put</code> method, not the <code>setProperty</code> method.
  477. </TD>
  478. </TR>
  479.  
  480. <TR>
  481. <TD>mail.imap.socketFactory.class</TD>
  482. <TD>String</TD>
  483. <TD>
  484. If set, specifies the name of a class that implements the
  485. <code>javax.net.SocketFactory</code> interface.  This class
  486. will be used to create IMAP sockets.
  487. </TD>
  488. </TR>
  489.  
  490. <TR>
  491. <TD>mail.imap.socketFactory.fallback</TD>
  492. <TD>boolean</TD>
  493. <TD>
  494. If set to true, failure to create a socket using the specified
  495. socket factory class will cause the socket to be created using
  496. the <code>java.net.Socket</code> class.
  497. Defaults to true.
  498. </TD>
  499. </TR>
  500.  
  501. <TR>
  502. <TD>mail.imap.socketFactory.port</TD>
  503. <TD>int</TD>
  504. <TD>
  505. Specifies the port to connect to when using the specified socket
  506. factory.
  507. If not set, the default port will be used.
  508. </TD>
  509. </TR>
  510.  
  511. <TR>
  512. <TD>mail.imap.ssl.enable</TD>
  513. <TD>boolean</TD>
  514. <TD>
  515. If set to true, use SSL to connect and use the SSL port by default.
  516. Defaults to false for the "imap" protocol and true for the "imaps" protocol.
  517. </TD>
  518. </TR>
  519.  
  520. <TR>
  521. <TD>mail.imap.ssl.checkserveridentity</TD>
  522. <TD>boolean</TD>
  523. <TD>
  524. If set to true, check the server identity as specified by
  525. <A HREF="http://www.ietf.org/rfc/rfc2595.txt" TARGET="_top">RFC 2595</A>.
  526. These additional checks based on the content of the server's certificate
  527. are intended to prevent man-in-the-middle attacks.
  528. Defaults to false.
  529. </TD>
  530. </TR>
  531.  
  532. <TR>
  533. <TD>mail.imap.ssl.trust</TD>
  534. <TD>String</TD>
  535. <TD>
  536. If set, and a socket factory hasn't been specified, enables use of a
  537. <A HREF="../../../../com/sun/mail/util/MailSSLSocketFactory.html" title="class in com.sun.mail.util"><CODE>MailSSLSocketFactory</CODE></A>.
  538. If set to "*", all hosts are trusted.
  539. If set to a whitespace separated list of hosts, those hosts are trusted.
  540. Otherwise, trust depends on the certificate the server presents.
  541. </TD>
  542. </TR>
  543.  
  544. <TR>
  545. <TD>mail.imap.ssl.socketFactory</TD>
  546. <TD>SSLSocketFactory</TD>
  547. <TD>
  548. If set to a class that extends the
  549. <code>javax.net.ssl.SSLSocketFactory</code> class, this class
  550. will be used to create IMAP SSL sockets.  Note that this is an
  551. instance of a class, not a name, and must be set using the
  552. <code>put</code> method, not the <code>setProperty</code> method.
  553. </TD>
  554. </TR>
  555.  
  556. <TR>
  557. <TD>mail.imap.ssl.socketFactory.class</TD>
  558. <TD>String</TD>
  559. <TD>
  560. If set, specifies the name of a class that extends the
  561. <code>javax.net.ssl.SSLSocketFactory</code> class.  This class
  562. will be used to create IMAP SSL sockets.
  563. </TD>
  564. </TR>
  565.  
  566. <TR>
  567. <TD>mail.imap.ssl.socketFactory.port</TD>
  568. <TD>int</TD>
  569. <TD>
  570. Specifies the port to connect to when using the specified socket
  571. factory.
  572. If not set, the default port will be used.
  573. </TD>
  574. </TR>
  575.  
  576. <TR>
  577. <TD>mail.imap.ssl.protocols</TD>
  578. <TD>string</TD>
  579. <TD>
  580. Specifies the SSL protocols that will be enabled for SSL connections.
  581. The property value is a whitespace separated list of tokens acceptable
  582. to the <code>javax.net.ssl.SSLSocket.setEnabledProtocols</code> method.
  583. </TD>
  584. </TR>
  585.  
  586. <TR>
  587. <TD>mail.imap.ssl.ciphersuites</TD>
  588. <TD>string</TD>
  589. <TD>
  590. Specifies the SSL cipher suites that will be enabled for SSL connections.
  591. The property value is a whitespace separated list of tokens acceptable
  592. to the <code>javax.net.ssl.SSLSocket.setEnabledCipherSuites</code> method.
  593. </TD>
  594. </TR>
  595.  
  596. <TR>
  597. <TD>mail.imap.minidletime</TD>
  598. <TD>int</TD>
  599. <TD>
  600. Applications typically call the idle method in a loop.  If another
  601. thread termiantes the IDLE command, it needs a chance to do its
  602. work before another IDLE command is issued.  The idle method enforces
  603. a delay to prevent thrashing between the IDLE command and regular
  604. commands.  This property sets the delay in milliseconds.  If not
  605. set, the default is 10 milliseconds.
  606. </TD>
  607. </TR>
  608.  
  609. <TR>
  610. <TD>mail.imap.enableimapevents</TD>
  611. <TD>boolean</TD>
  612. <TD>
  613. Enable special IMAP-specific events to be delivered to the Store's
  614. <code>ConnectionListener</code>.  If true, unsolicited responses
  615. received during the Store's <code>idle</code> method will be sent
  616. as <code>ConnectionEvent</code>s with a type of
  617. <code>IMAPStore.RESPONSE</code>.  The event's message will be the
  618. raw IMAP response string.
  619. By default, these events are not sent.
  620. NOTE: This capability is highly experimental and likely will change
  621. in future releases.
  622. </TD>
  623. </TR>
  624.  
  625. </TABLE>
  626. <P>
  627. In general, applications should not need to use the classes in this
  628. package directly.  Instead, they should use the APIs defined by
  629. <code>javax.mail</code> package (and subpackages).  Applications should
  630. never construct instances of <code>IMAPStore</code> or
  631. <code>IMAPFolder</code> directly.  Instead, they should use the
  632. <code>Session</code> method <code>getStore</code> to acquire an
  633. appropriate <code>Store</code> object, and from that acquire
  634. <code>Folder</code> objects.
  635. <P>
  636. <strong>WARNING:</strong> The APIs unique to this package should be
  637. considered <strong>EXPERIMENTAL</strong>.  They may be changed in the
  638. future in ways that are incompatible with applications using the
  639. current APIs.
  640. <P>
  641.  
  642. <P>
  643. <DL>
  644. </DL>
  645. <HR>
  646.  
  647.  
  648. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  649. <A NAME="navbar_bottom"><!-- --></A>
  650. <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
  651. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
  652. <TR>
  653. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  654. <A NAME="navbar_bottom_firstrow"><!-- --></A>
  655. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  656.  <TR ALIGN="center" VALIGN="top">
  657.  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  658.  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT>&nbsp;</TD>
  659.  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>
  660.  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-use.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  661.  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  662.  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  663.  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  664.  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  665.  </TR>
  666. </TABLE>
  667. </TD>
  668. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  669. </EM>
  670. </TD>
  671. </TR>
  672.  
  673. <TR>
  674. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  675. &nbsp;<A HREF="../../../../com/sun/mail/dsn/package-summary.html"><B>PREV PACKAGE</B></A>&nbsp;
  676. &nbsp;<A HREF="../../../../com/sun/mail/pop3/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD>
  677. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  678.  <A HREF="../../../../index.html?com/sun/mail/imap/package-summary.html" target="_top"><B>FRAMES</B></A>  &nbsp;
  679. &nbsp;<A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
  680. &nbsp;<SCRIPT type="text/javascript">
  681.  <!--
  682.  if(window==top) {
  683.    document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
  684.  }
  685.  //-->
  686. </SCRIPT>
  687. <NOSCRIPT>
  688.  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
  689. </NOSCRIPT>
  690.  
  691.  
  692. </FONT></TD>
  693. </TR>
  694. </TABLE>
  695. <A NAME="skip-navbar_bottom"></A>
  696. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  697.  
  698. <HR>
  699. Copyright &#169; 2009 <a href="http://www.sun.com">Sun Microsystems, Inc.</a>. All Rights Reserved.
  700. </BODY>
  701. </HTML>
  702.