/usr/share/doc/libgnumail-java/api/javax/mail/Session.html is in libgnumail-java-doc 1.1.2-7.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_24) on Mon Apr 09 04:18:34 UTC 2012 -->
<TITLE>
Session (GNU JavaMail API documentation)
</TITLE>
<META NAME="date" CONTENT="2012-04-09">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Session (GNU JavaMail API documentation)";
}
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<HR>
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Session.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../javax/mail/Service.html" title="class in javax.mail"><B>PREV CLASS</B></A>
<A HREF="../../javax/mail/Store.html" title="class in javax.mail"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../index.html?javax/mail/Session.html" target="_top"><B>FRAMES</B></A>
<A HREF="Session.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
javax.mail</FONT>
<BR>
Class Session</H2>
<PRE>
<A HREF="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A>
<IMG SRC="../../resources/inherit.gif" ALT="extended by "><B>javax.mail.Session</B>
</PRE>
<HR>
<DL>
<DT><PRE>public final class <B>Session</B><DT>extends <A HREF="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></DL>
</PRE>
<P>
A session represents the context of a messaging transaction. It provides
a repository of configuration information in the form of properties.
<P>
<P>
<DL>
<DT><B>Version:</B></DT>
<DD>1.4</DD>
<DT><B>Author:</B></DT>
<DD>Andrew Selkirk, <a href="mailto:dog@gnu.org">Chris Burdess</a>, <a href="mailto:nferrier@tapsellferrier.co.uk">Nic Ferrier</a></DD>
</DL>
<HR>
<P>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../javax/mail/Session.html#addProvider(javax.mail.Provider)">addProvider</A></B>(<A HREF="../../javax/mail/Provider.html" title="class in javax.mail">Provider</A> provider)</CODE>
<BR>
Adds the specified provider to the session.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../javax/mail/Session.html#getDebug()">getDebug</A></B>()</CODE>
<BR>
Get the debug setting for this Session.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="/usr/share/doc/default-jdk-doc/api/java/io/PrintStream.html?is-external=true" title="class or interface in java.io">PrintStream</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../javax/mail/Session.html#getDebugOut()">getDebugOut</A></B>()</CODE>
<BR>
Returns the stream to be used for debugging output.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static <A HREF="../../javax/mail/Session.html" title="class in javax.mail">Session</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../javax/mail/Session.html#getDefaultInstance(java.util.Properties)">getDefaultInstance</A></B>(<A HREF="/usr/share/doc/default-jdk-doc/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</A> props)</CODE>
<BR>
Get the default Session object.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static <A HREF="../../javax/mail/Session.html" title="class in javax.mail">Session</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../javax/mail/Session.html#getDefaultInstance(java.util.Properties, javax.mail.Authenticator)">getDefaultInstance</A></B>(<A HREF="/usr/share/doc/default-jdk-doc/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</A> props,
<A HREF="../../javax/mail/Authenticator.html" title="class in javax.mail">Authenticator</A> authenticator)</CODE>
<BR>
Returns the default session.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../javax/mail/Folder.html" title="class in javax.mail">Folder</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../javax/mail/Session.html#getFolder(javax.mail.URLName)">getFolder</A></B>(<A HREF="../../javax/mail/URLName.html" title="class in javax.mail">URLName</A> url)</CODE>
<BR>
Get a closed Folder object for the given URLName.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static <A HREF="../../javax/mail/Session.html" title="class in javax.mail">Session</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../javax/mail/Session.html#getInstance(java.util.Properties)">getInstance</A></B>(<A HREF="/usr/share/doc/default-jdk-doc/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</A> props)</CODE>
<BR>
Returns a new Session.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static <A HREF="../../javax/mail/Session.html" title="class in javax.mail">Session</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../javax/mail/Session.html#getInstance(java.util.Properties, javax.mail.Authenticator)">getInstance</A></B>(<A HREF="/usr/share/doc/default-jdk-doc/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</A> props,
<A HREF="../../javax/mail/Authenticator.html" title="class in javax.mail">Authenticator</A> authenticator)</CODE>
<BR>
Returns a new session.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../javax/mail/PasswordAuthentication.html" title="class in javax.mail">PasswordAuthentication</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../javax/mail/Session.html#getPasswordAuthentication(javax.mail.URLName)">getPasswordAuthentication</A></B>(<A HREF="../../javax/mail/URLName.html" title="class in javax.mail">URLName</A> url)</CODE>
<BR>
Return any saved PasswordAuthentication for this(store or transport)
URLName.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="/usr/share/doc/default-jdk-doc/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../javax/mail/Session.html#getProperties()">getProperties</A></B>()</CODE>
<BR>
Returns the Properties object associated with this Session.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../javax/mail/Session.html#getProperty(java.lang.String)">getProperty</A></B>(<A HREF="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name)</CODE>
<BR>
Returns the value of the specified property.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../javax/mail/Provider.html" title="class in javax.mail">Provider</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../javax/mail/Session.html#getProvider(java.lang.String)">getProvider</A></B>(<A HREF="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> protocol)</CODE>
<BR>
Returns the default Provider for the protocol specified.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../javax/mail/Provider.html" title="class in javax.mail">Provider</A>[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../javax/mail/Session.html#getProviders()">getProviders</A></B>()</CODE>
<BR>
This method returns an array of all the implementations installed
via the javamail.[default.]providers files that can be loaded
using the ClassLoader available to this application.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../javax/mail/Store.html" title="class in javax.mail">Store</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../javax/mail/Session.html#getStore()">getStore</A></B>()</CODE>
<BR>
Get a Store object that implements this user's desired Store protocol.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../javax/mail/Store.html" title="class in javax.mail">Store</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../javax/mail/Session.html#getStore(javax.mail.Provider)">getStore</A></B>(<A HREF="../../javax/mail/Provider.html" title="class in javax.mail">Provider</A> provider)</CODE>
<BR>
Get an instance of the store specified by Provider.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../javax/mail/Store.html" title="class in javax.mail">Store</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../javax/mail/Session.html#getStore(java.lang.String)">getStore</A></B>(<A HREF="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> protocol)</CODE>
<BR>
Get a Store object that implements the specified protocol.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../javax/mail/Store.html" title="class in javax.mail">Store</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../javax/mail/Session.html#getStore(javax.mail.URLName)">getStore</A></B>(<A HREF="../../javax/mail/URLName.html" title="class in javax.mail">URLName</A> url)</CODE>
<BR>
Get a Store object for the given URLName.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../javax/mail/Transport.html" title="class in javax.mail">Transport</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../javax/mail/Session.html#getTransport()">getTransport</A></B>()</CODE>
<BR>
Get a Transport object that implements this user's desired Transport
protocol.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../javax/mail/Transport.html" title="class in javax.mail">Transport</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../javax/mail/Session.html#getTransport(javax.mail.Address)">getTransport</A></B>(<A HREF="../../javax/mail/Address.html" title="class in javax.mail">Address</A> address)</CODE>
<BR>
Get a Transport object that can transport a Message to the specified
address type.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../javax/mail/Transport.html" title="class in javax.mail">Transport</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../javax/mail/Session.html#getTransport(javax.mail.Provider)">getTransport</A></B>(<A HREF="../../javax/mail/Provider.html" title="class in javax.mail">Provider</A> provider)</CODE>
<BR>
Get an instance of the transport specified in the Provider.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../javax/mail/Transport.html" title="class in javax.mail">Transport</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../javax/mail/Session.html#getTransport(java.lang.String)">getTransport</A></B>(<A HREF="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> protocol)</CODE>
<BR>
Get a Transport object that implements the specified protocol.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../javax/mail/Transport.html" title="class in javax.mail">Transport</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../javax/mail/Session.html#getTransport(javax.mail.URLName)">getTransport</A></B>(<A HREF="../../javax/mail/URLName.html" title="class in javax.mail">URLName</A> url)</CODE>
<BR>
Get a Transport object for the given URLName.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../javax/mail/PasswordAuthentication.html" title="class in javax.mail">PasswordAuthentication</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../javax/mail/Session.html#requestPasswordAuthentication(java.net.InetAddress, int, java.lang.String, java.lang.String, java.lang.String)">requestPasswordAuthentication</A></B>(<A HREF="/usr/share/doc/default-jdk-doc/api/java/net/InetAddress.html?is-external=true" title="class or interface in java.net">InetAddress</A> address,
int port,
<A HREF="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> protocol,
<A HREF="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> prompt,
<A HREF="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> defaultUserName)</CODE>
<BR>
Call back to the application to get the needed user name and password.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../javax/mail/Session.html#setDebug(boolean)">setDebug</A></B>(boolean debug)</CODE>
<BR>
Set the debug setting for this Session.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../javax/mail/Session.html#setDebugOut(java.io.PrintStream)">setDebugOut</A></B>(<A HREF="/usr/share/doc/default-jdk-doc/api/java/io/PrintStream.html?is-external=true" title="class or interface in java.io">PrintStream</A> out)</CODE>
<BR>
Set the stream to be used for debugging output for this session.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../javax/mail/Session.html#setPasswordAuthentication(javax.mail.URLName, javax.mail.PasswordAuthentication)">setPasswordAuthentication</A></B>(<A HREF="../../javax/mail/URLName.html" title="class in javax.mail">URLName</A> url,
<A HREF="../../javax/mail/PasswordAuthentication.html" title="class in javax.mail">PasswordAuthentication</A> pw)</CODE>
<BR>
Save a PasswordAuthentication for this(store or transport) URLName.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../javax/mail/Session.html#setProtocolForAddress(java.lang.String, java.lang.String)">setProtocolForAddress</A></B>(<A HREF="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> addressType,
<A HREF="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> protocol)</CODE>
<BR>
Sets the default transport protocol for the given address type.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../javax/mail/Session.html#setProvider(javax.mail.Provider)">setProvider</A></B>(<A HREF="../../javax/mail/Provider.html" title="class in javax.mail">Provider</A> provider)</CODE>
<BR>
Set the passed Provider to be the default implementation for the protocol
in Provider.protocol overriding any previous values.</TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A>, <A HREF="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
</TR>
</TABLE>
<P>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="getInstance(java.util.Properties, javax.mail.Authenticator)"><!-- --></A><H3>
getInstance</H3>
<PRE>
public static <A HREF="../../javax/mail/Session.html" title="class in javax.mail">Session</A> <B>getInstance</B>(<A HREF="/usr/share/doc/default-jdk-doc/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</A> props,
<A HREF="../../javax/mail/Authenticator.html" title="class in javax.mail">Authenticator</A> authenticator)</PRE>
<DL>
<DD>Returns a new session.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>props</CODE> - a properties object holding relevant properties.
It is expected that the client supplies values for the properties
listed in Appendix A of the JavaMail spec (particularly
<code>mail.store.protocol</code>,
<code>mail.transport.protocol</code>,
<code>mail.host</code>,
<code>mail.user</code>,
and <code>mail.from</code>)
as the defaults are unlikely to work in all cases.<DD><CODE>authenticator</CODE> - an authenticator used to call back to the
application when a user name and password is needed.</DL>
</DD>
</DL>
<HR>
<A NAME="getInstance(java.util.Properties)"><!-- --></A><H3>
getInstance</H3>
<PRE>
public static <A HREF="../../javax/mail/Session.html" title="class in javax.mail">Session</A> <B>getInstance</B>(<A HREF="/usr/share/doc/default-jdk-doc/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</A> props)</PRE>
<DL>
<DD>Returns a new Session.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>props</CODE> - a properties object holding relevant properties.
It is expected that the client supplies values for the properties
listed in Appendix A of the JavaMail spec (particularly
<code>mail.store.protocol</code>,
<code>mail.transport.protocol</code>,
<code>mail.host</code>,
<code>mail.user</code>,
and <code>mail.from</code>)
as the defaults are unlikely to work in all cases.</DL>
</DD>
</DL>
<HR>
<A NAME="getDefaultInstance(java.util.Properties, javax.mail.Authenticator)"><!-- --></A><H3>
getDefaultInstance</H3>
<PRE>
public static <A HREF="../../javax/mail/Session.html" title="class in javax.mail">Session</A> <B>getDefaultInstance</B>(<A HREF="/usr/share/doc/default-jdk-doc/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</A> props,
<A HREF="../../javax/mail/Authenticator.html" title="class in javax.mail">Authenticator</A> authenticator)</PRE>
<DL>
<DD>Returns the default session.
If a default has not yet been setup, a new session is created
and installed as the default.
<p>
Since the default session is potentially available to all code
executing in the same Java virtual machine, and the session can
contain security sensitive information such as user names and
passwords, access to the default session is restricted.
The Authenticator object, which must be created by the caller,
is used indirectly to check access permission. The Authenticator
object passed in when the session is created is compared with
the Authenticator object passed in to subsequent requests to get the
default session. If both objects are the same, or are from the same
ClassLoader, the request is allowed. Otherwise, it is denied.
<p>
Note that if the Authenticator object used to create the session is null,
anyone can get the default session by passing in null.
<p>
In JDK 1.2, additional security Permission objects may be used to control
access to the default session.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>props</CODE> - Properties object that hold relevant properties.
It is expected that the client supplies values for the properties
listed in Appendix A of the JavaMail spec (particularly
<code>mail.store.protocol</code>,
<code>mail.transport.protocol</code>,
<code>mail.host</code>,
<code>mail.user</code>,
and <code>mail.from</code>)
as the defaults are unlikely to work in all cases.<DD><CODE>authenticator</CODE> - Authenticator object used to call back to the
application when a user name and password is needed.</DL>
</DD>
</DL>
<HR>
<A NAME="getDefaultInstance(java.util.Properties)"><!-- --></A><H3>
getDefaultInstance</H3>
<PRE>
public static <A HREF="../../javax/mail/Session.html" title="class in javax.mail">Session</A> <B>getDefaultInstance</B>(<A HREF="/usr/share/doc/default-jdk-doc/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</A> props)</PRE>
<DL>
<DD>Get the default Session object.
If a default has not yet been setup, a new Session object is created
and installed as the default.
<p>
Note that a default session created with no Authenticator is available
to all code executing in the same Java virtual machine, and the session
can contain security sensitive information such as user names and
passwords.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>props</CODE> - Properties object that hold relevant properties.
It is expected that the client supplies values for the properties
listed in Appendix A of the JavaMail spec(particularly
<code>mail.store.protocol</code>,
<code>mail.transport.protocol</code>,
<code>mail.host</code>,
<code>mail.user</code>,
and <code>mail.from</code>)
as the defaults are unlikely to work in all cases.</DL>
</DD>
</DL>
<HR>
<A NAME="setDebug(boolean)"><!-- --></A><H3>
setDebug</H3>
<PRE>
public void <B>setDebug</B>(boolean debug)</PRE>
<DL>
<DD>Set the debug setting for this Session.
<p>
Since the debug setting can be turned on only after the Session has been
created, to turn on debugging in the Session constructor, set the property
<code>mail.debug</code> in the Properties object passed in to the
constructor to true. The value of the <code>mail.debug</code> property
is used to initialize the per-Session debugging flag. Subsequent calls
to the <code>setDebug</code> method manipulate the per-Session debugging
flag and have no affect on the <code>mail.debug</code> property.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getDebug()"><!-- --></A><H3>
getDebug</H3>
<PRE>
public boolean <B>getDebug</B>()</PRE>
<DL>
<DD>Get the debug setting for this Session.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getProviders()"><!-- --></A><H3>
getProviders</H3>
<PRE>
public <A HREF="../../javax/mail/Provider.html" title="class in javax.mail">Provider</A>[] <B>getProviders</B>()</PRE>
<DL>
<DD>This method returns an array of all the implementations installed
via the javamail.[default.]providers files that can be loaded
using the ClassLoader available to this application.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getProvider(java.lang.String)"><!-- --></A><H3>
getProvider</H3>
<PRE>
public <A HREF="../../javax/mail/Provider.html" title="class in javax.mail">Provider</A> <B>getProvider</B>(<A HREF="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> protocol)
throws <A HREF="../../javax/mail/NoSuchProviderException.html" title="class in javax.mail">NoSuchProviderException</A></PRE>
<DL>
<DD>Returns the default Provider for the protocol specified.
Checks <code>mail.<protocol>.class</code> property first
and if it exists, returns the Provider associated with
this implementation. If it doesn't exist, returns the Provider that
appeared first in the configuration files.
If an implementation for the protocol isn't found,
throws NoSuchProviderException
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>protocol</CODE> - Configured protocol(i.e. smtp, imap, etc)<DD><CODE>NoSuchProviderException</CODE> - If a provider for the given protocol
is not found.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../javax/mail/NoSuchProviderException.html" title="class in javax.mail">NoSuchProviderException</A></CODE></DL>
</DD>
</DL>
<HR>
<A NAME="setProvider(javax.mail.Provider)"><!-- --></A><H3>
setProvider</H3>
<PRE>
public void <B>setProvider</B>(<A HREF="../../javax/mail/Provider.html" title="class in javax.mail">Provider</A> provider)
throws <A HREF="../../javax/mail/NoSuchProviderException.html" title="class in javax.mail">NoSuchProviderException</A></PRE>
<DL>
<DD>Set the passed Provider to be the default implementation for the protocol
in Provider.protocol overriding any previous values.
<P>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../javax/mail/NoSuchProviderException.html" title="class in javax.mail">NoSuchProviderException</A></CODE></DL>
</DD>
</DL>
<HR>
<A NAME="getStore()"><!-- --></A><H3>
getStore</H3>
<PRE>
public <A HREF="../../javax/mail/Store.html" title="class in javax.mail">Store</A> <B>getStore</B>()
throws <A HREF="../../javax/mail/NoSuchProviderException.html" title="class in javax.mail">NoSuchProviderException</A></PRE>
<DL>
<DD>Get a Store object that implements this user's desired Store protocol.
The <code>mail.store.protocol</code> property specifies the desired
protocol. If an appropriate Store object is not obtained,
NoSuchProviderException is thrown
<P>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../javax/mail/NoSuchProviderException.html" title="class in javax.mail">NoSuchProviderException</A></CODE></DL>
</DD>
</DL>
<HR>
<A NAME="getStore(java.lang.String)"><!-- --></A><H3>
getStore</H3>
<PRE>
public <A HREF="../../javax/mail/Store.html" title="class in javax.mail">Store</A> <B>getStore</B>(<A HREF="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> protocol)
throws <A HREF="../../javax/mail/NoSuchProviderException.html" title="class in javax.mail">NoSuchProviderException</A></PRE>
<DL>
<DD>Get a Store object that implements the specified protocol.
If an appropriate Store object cannot be obtained,
NoSuchProviderException is thrown.
<P>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../javax/mail/NoSuchProviderException.html" title="class in javax.mail">NoSuchProviderException</A></CODE></DL>
</DD>
</DL>
<HR>
<A NAME="getStore(javax.mail.URLName)"><!-- --></A><H3>
getStore</H3>
<PRE>
public <A HREF="../../javax/mail/Store.html" title="class in javax.mail">Store</A> <B>getStore</B>(<A HREF="../../javax/mail/URLName.html" title="class in javax.mail">URLName</A> url)
throws <A HREF="../../javax/mail/NoSuchProviderException.html" title="class in javax.mail">NoSuchProviderException</A></PRE>
<DL>
<DD>Get a Store object for the given URLName.
If the requested Store object cannot be obtained,
NoSuchProviderException is thrown.
The "scheme" part of the URL string(Refer RFC 1738) is used to
locate the Store protocol.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>url</CODE> - URLName that represents the desired Store
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../javax/mail/NoSuchProviderException.html" title="class in javax.mail">NoSuchProviderException</A></CODE></DL>
</DD>
</DL>
<HR>
<A NAME="getStore(javax.mail.Provider)"><!-- --></A><H3>
getStore</H3>
<PRE>
public <A HREF="../../javax/mail/Store.html" title="class in javax.mail">Store</A> <B>getStore</B>(<A HREF="../../javax/mail/Provider.html" title="class in javax.mail">Provider</A> provider)
throws <A HREF="../../javax/mail/NoSuchProviderException.html" title="class in javax.mail">NoSuchProviderException</A></PRE>
<DL>
<DD>Get an instance of the store specified by Provider.
Instantiates the store and returns it.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>provider</CODE> - Store Provider that will be instantiated
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../javax/mail/NoSuchProviderException.html" title="class in javax.mail">NoSuchProviderException</A></CODE></DL>
</DD>
</DL>
<HR>
<A NAME="getTransport()"><!-- --></A><H3>
getTransport</H3>
<PRE>
public <A HREF="../../javax/mail/Transport.html" title="class in javax.mail">Transport</A> <B>getTransport</B>()
throws <A HREF="../../javax/mail/NoSuchProviderException.html" title="class in javax.mail">NoSuchProviderException</A></PRE>
<DL>
<DD>Get a Transport object that implements this user's desired Transport
protocol.
The <code>mail.transport.protocol</code> property specifies the desired
protocol. If an appropriate Transport object cannot be obtained,
MessagingException is thrown.
<P>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../javax/mail/NoSuchProviderException.html" title="class in javax.mail">NoSuchProviderException</A></CODE> - If the provider is not found.</DL>
</DD>
</DL>
<HR>
<A NAME="getTransport(java.lang.String)"><!-- --></A><H3>
getTransport</H3>
<PRE>
public <A HREF="../../javax/mail/Transport.html" title="class in javax.mail">Transport</A> <B>getTransport</B>(<A HREF="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> protocol)
throws <A HREF="../../javax/mail/NoSuchProviderException.html" title="class in javax.mail">NoSuchProviderException</A></PRE>
<DL>
<DD>Get a Transport object that implements the specified protocol.
If an appropriate Transport object cannot be obtained, null is returned.
<P>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../javax/mail/NoSuchProviderException.html" title="class in javax.mail">NoSuchProviderException</A></CODE> - If the provider is not found.</DL>
</DD>
</DL>
<HR>
<A NAME="getTransport(javax.mail.URLName)"><!-- --></A><H3>
getTransport</H3>
<PRE>
public <A HREF="../../javax/mail/Transport.html" title="class in javax.mail">Transport</A> <B>getTransport</B>(<A HREF="../../javax/mail/URLName.html" title="class in javax.mail">URLName</A> url)
throws <A HREF="../../javax/mail/NoSuchProviderException.html" title="class in javax.mail">NoSuchProviderException</A></PRE>
<DL>
<DD>Get a Transport object for the given URLName.
If the requested Transport object cannot be obtained,
NoSuchProviderException is thrown. The "scheme" part of the URL
string(Refer RFC 1738) is used to locate the Transport protocol.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>url</CODE> - URLName that represents the desired Transport
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../javax/mail/NoSuchProviderException.html" title="class in javax.mail">NoSuchProviderException</A></CODE> - If the provider is not found.</DL>
</DD>
</DL>
<HR>
<A NAME="getTransport(javax.mail.Provider)"><!-- --></A><H3>
getTransport</H3>
<PRE>
public <A HREF="../../javax/mail/Transport.html" title="class in javax.mail">Transport</A> <B>getTransport</B>(<A HREF="../../javax/mail/Provider.html" title="class in javax.mail">Provider</A> provider)
throws <A HREF="../../javax/mail/NoSuchProviderException.html" title="class in javax.mail">NoSuchProviderException</A></PRE>
<DL>
<DD>Get an instance of the transport specified in the Provider.
Instantiates the transport and returns it.
<P>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../javax/mail/NoSuchProviderException.html" title="class in javax.mail">NoSuchProviderException</A></CODE> - If the provider is not found.</DL>
</DD>
</DL>
<HR>
<A NAME="getTransport(javax.mail.Address)"><!-- --></A><H3>
getTransport</H3>
<PRE>
public <A HREF="../../javax/mail/Transport.html" title="class in javax.mail">Transport</A> <B>getTransport</B>(<A HREF="../../javax/mail/Address.html" title="class in javax.mail">Address</A> address)
throws <A HREF="../../javax/mail/NoSuchProviderException.html" title="class in javax.mail">NoSuchProviderException</A></PRE>
<DL>
<DD>Get a Transport object that can transport a Message to the specified
address type.
<P>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../javax/mail/NoSuchProviderException.html" title="class in javax.mail">NoSuchProviderException</A></CODE> - If the provider is not found.</DL>
</DD>
</DL>
<HR>
<A NAME="getFolder(javax.mail.URLName)"><!-- --></A><H3>
getFolder</H3>
<PRE>
public <A HREF="../../javax/mail/Folder.html" title="class in javax.mail">Folder</A> <B>getFolder</B>(<A HREF="../../javax/mail/URLName.html" title="class in javax.mail">URLName</A> url)
throws <A HREF="../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></PRE>
<DL>
<DD>Get a closed Folder object for the given URLName.
If the requested Folder object cannot be obtained, null is returned.
<p>
The "scheme" part of the URL string(Refer RFC 1738) is used to locate
the Store protocol. The rest of the URL string(that is, the
"schemepart", as per RFC 1738) is used by that Store in a protocol
dependent manner to locate and instantiate the appropriate Folder object.
<p>
Note that RFC 1738 also specifies the syntax for the "schemepart" for
IP-based protocols(IMAP4, POP3, etc.). Providers of IP-based mail Stores
should implement that syntax for referring to Folders.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>url</CODE> - URLName that represents the desired folder<DD><CODE>MessagingException</CODE> - if the Folder could not be located or created.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../javax/mail/NoSuchProviderException.html" title="class in javax.mail">NoSuchProviderException</A></CODE> - If a provider for the given URLName
is not found.
<DD><CODE><A HREF="../../javax/mail/MessagingException.html" title="class in javax.mail">MessagingException</A></CODE></DL>
</DD>
</DL>
<HR>
<A NAME="setPasswordAuthentication(javax.mail.URLName, javax.mail.PasswordAuthentication)"><!-- --></A><H3>
setPasswordAuthentication</H3>
<PRE>
public void <B>setPasswordAuthentication</B>(<A HREF="../../javax/mail/URLName.html" title="class in javax.mail">URLName</A> url,
<A HREF="../../javax/mail/PasswordAuthentication.html" title="class in javax.mail">PasswordAuthentication</A> pw)</PRE>
<DL>
<DD>Save a PasswordAuthentication for this(store or transport) URLName.
If <code>pw</code> is null the entry corresponding to the URLName
is removed.
<p>
This is normally used only by the store or transport implementations to
allow authentication information to be shared among multiple uses of a
session.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getPasswordAuthentication(javax.mail.URLName)"><!-- --></A><H3>
getPasswordAuthentication</H3>
<PRE>
public <A HREF="../../javax/mail/PasswordAuthentication.html" title="class in javax.mail">PasswordAuthentication</A> <B>getPasswordAuthentication</B>(<A HREF="../../javax/mail/URLName.html" title="class in javax.mail">URLName</A> url)</PRE>
<DL>
<DD>Return any saved PasswordAuthentication for this(store or transport)
URLName. Normally used only by store or transport implementations.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="requestPasswordAuthentication(java.net.InetAddress, int, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
requestPasswordAuthentication</H3>
<PRE>
public <A HREF="../../javax/mail/PasswordAuthentication.html" title="class in javax.mail">PasswordAuthentication</A> <B>requestPasswordAuthentication</B>(<A HREF="/usr/share/doc/default-jdk-doc/api/java/net/InetAddress.html?is-external=true" title="class or interface in java.net">InetAddress</A> address,
int port,
<A HREF="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> protocol,
<A HREF="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> prompt,
<A HREF="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> defaultUserName)</PRE>
<DL>
<DD>Call back to the application to get the needed user name and password.
The application should put up a dialog something like:
<pre>
Connecting to <protocol> mail service on host <addr>, port <port>.
<prompt>
User Name: <defaultUserName>
Password:
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>addr</CODE> - InetAddress of the host. may be null.<DD><CODE>protocol</CODE> - protocol scheme(e.g. imap, pop3, etc.)<DD><CODE>prompt</CODE> - any additional String to show as part of the prompt; may be
null.<DD><CODE>defaultUserName</CODE> - the default username. may be null.</DL>
</DD>
</DL>
<HR>
<A NAME="getProperties()"><!-- --></A><H3>
getProperties</H3>
<PRE>
public <A HREF="/usr/share/doc/default-jdk-doc/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</A> <B>getProperties</B>()</PRE>
<DL>
<DD>Returns the Properties object associated with this Session.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getProperty(java.lang.String)"><!-- --></A><H3>
getProperty</H3>
<PRE>
public <A HREF="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getProperty</B>(<A HREF="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name)</PRE>
<DL>
<DD>Returns the value of the specified property.
Returns null if this property does not exist.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="setDebugOut(java.io.PrintStream)"><!-- --></A><H3>
setDebugOut</H3>
<PRE>
public void <B>setDebugOut</B>(<A HREF="/usr/share/doc/default-jdk-doc/api/java/io/PrintStream.html?is-external=true" title="class or interface in java.io">PrintStream</A> out)</PRE>
<DL>
<DD>Set the stream to be used for debugging output for this session.
If <code>out</code> is null, <code>System.out</code> will be used. Note
that debugging output that occurs before any session is created, as a
result of setting the <code>mail.debug</code> property, will always be
sent to <code>System.out</code>.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>out</CODE> - the PrintStream to use for debugging output<DT><B>Since:</B></DT>
<DD>JavaMail 1.3</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="getDebugOut()"><!-- --></A><H3>
getDebugOut</H3>
<PRE>
public <A HREF="/usr/share/doc/default-jdk-doc/api/java/io/PrintStream.html?is-external=true" title="class or interface in java.io">PrintStream</A> <B>getDebugOut</B>()</PRE>
<DL>
<DD>Returns the stream to be used for debugging output. If no stream has
been set, <code>System.out</code> is returned.
<P>
<DD><DL>
<DT><B>Since:</B></DT>
<DD>JavaMail 1.3</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="addProvider(javax.mail.Provider)"><!-- --></A><H3>
addProvider</H3>
<PRE>
public void <B>addProvider</B>(<A HREF="../../javax/mail/Provider.html" title="class in javax.mail">Provider</A> provider)</PRE>
<DL>
<DD>Adds the specified provider to the session.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>provider</CODE> - the new provider<DT><B>Since:</B></DT>
<DD>JavaMail 1.4</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="setProtocolForAddress(java.lang.String, java.lang.String)"><!-- --></A><H3>
setProtocolForAddress</H3>
<PRE>
public void <B>setProtocolForAddress</B>(<A HREF="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> addressType,
<A HREF="/usr/share/doc/default-jdk-doc/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> protocol)</PRE>
<DL>
<DD>Sets the default transport protocol for the given address type.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>addressType</CODE> - the type of address, e.g. "rfc822"<DD><CODE>protocol</CODE> - the transport protocol to use<DT><B>Since:</B></DT>
<DD>JavaMail 1.4</DD>
</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Session.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../javax/mail/Service.html" title="class in javax.mail"><B>PREV CLASS</B></A>
<A HREF="../../javax/mail/Store.html" title="class in javax.mail"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../index.html?javax/mail/Session.html" target="_top"><B>FRAMES</B></A>
<A HREF="Session.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
© Copyright 2003, 2004
The Free Software Foundation, All rights reserved
</BODY>
</HTML>
|