diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 82c7230f..ce4b8863 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,4 +1,4 @@ -# Contributing to Eclipse Project for Jakarta Mail +# Contributing to Eclipse Project for Angus Mail Thanks for your interest in this project. @@ -16,21 +16,21 @@ included in the Java EE platform. Information regarding source code management, builds, coding standards, and more. -* [https://eclipse-ee4j.github.io/mail/Contributions](https://eclipse-ee4j.github.io/mail/Contributions) +* [https://eclipse-ee4j.github.io/angus-mail/Contributions](https://eclipse-ee4j.github.io/angus-mail/Contributions) * [https://projects.eclipse.org/projects/ee4j.mail/developer](https://projects.eclipse.org/projects/ee4j.mail/developer) The project maintains the following source code repositories -* [https://github.com/eclipse-ee4j/mail](https://github.com/eclipse-ee4j/mail) -* [https://github.com/eclipse-ee4j/mail-spec](https://github.com/eclipse-ee4j/mail-spec) -* [https://github.com/eclipse-ee4j/mail-tck](https://github.com/eclipse-ee4j/mail-tck) +* [https://github.com/eclipse-ee4j/angus-mail](https://github.com/eclipse-ee4j/angus-mail) +* [https://github.com/jakartaee/mail-spec](https://github.com/jakartaee/mail-spec) +* [https://github.com/jakartaee/mail-tck](https://github.com/jakartaee/mail-tck) ## Eclipse Contributor Agreement Before your contribution can be accepted by the project team contributors must electronically sign the Eclipse Contributor Agreement (ECA). -* [http://www.eclipse.org/legal/ECA.php](http://www.eclipse.org/legal/ECA.php) +* [https://www.eclipse.org/legal/ECA.php](https://www.eclipse.org/legal/ECA.php) Commits that are provided by non-committers must have a Signed-off-by field in the footer indicating that the author is aware of the terms by which the @@ -60,4 +60,4 @@ Jakarta EE specification projects. Contact the project developers via the project's "dev" list. -* [https://accounts.eclipse.org/mailing-list/mail-dev](https://accounts.eclipse.org/mailing-list/mail-dev) +* [https://accounts.eclipse.org/mailing-list/angus-dev](https://accounts.eclipse.org/mailing-list/angus-dev) diff --git a/NOTICE.md b/NOTICE.md index 4061966c..84d0d273 100644 --- a/NOTICE.md +++ b/NOTICE.md @@ -18,7 +18,7 @@ source code repository logs. This program and the accompanying materials are made available under the terms of the Eclipse Public License v. 2.0 which is available at -http://www.eclipse.org/legal/epl-2.0. This Source Code may also be made +https://www.eclipse.org/legal/epl-2.0/. This Source Code may also be made available under the following Secondary Licenses when the conditions for such availability set forth in the Eclipse Public License v. 2.0 are satisfied: GNU General Public License, version 2 with the GNU Classpath Exception which is diff --git a/README.md b/README.md index 7f2e65a9..1b12c8b6 100644 --- a/README.md +++ b/README.md @@ -28,7 +28,7 @@ the license text included in every source file. ## Contributing We use [contribution policy](CONTRIBUTING.md), which means we can only accept contributions under -the terms of [Eclipse Contributor Agreement](http://www.eclipse.org/legal/ECA.php). +the terms of [Eclipse Contributor Agreement](https://www.eclipse.org/legal/ECA.php). ## Links diff --git a/doc/src/main/resources/docs/CHANGES.txt b/doc/src/main/resources/docs/CHANGES.txt index ed5f2ba1..e6a5b6ab 100644 --- a/doc/src/main/resources/docs/CHANGES.txt +++ b/doc/src/main/resources/docs/CHANGES.txt @@ -1,6 +1,6 @@ For changes related to mail you can refer to this file: - https://raw.githubusercontent.com/eclipse-ee4j/angus-mail/master/doc/src/main/resources/CHANGES.txt + https://raw.githubusercontent.com/eclipse-ee4j/angus-mail/master/doc/src/main/resources/docs/CHANGES.txt Bug IDs can be found in the GitHub Issue Tracker for the Eclipse EE4J Angus Mail project: diff --git a/doc/src/main/resources/docs/NOTES.txt b/doc/src/main/resources/docs/NOTES.txt index 7e35c6bc..43509fc6 100644 --- a/doc/src/main/resources/docs/NOTES.txt +++ b/doc/src/main/resources/docs/NOTES.txt @@ -9,15 +9,15 @@ Welcome to the ${angus-mail.version} release of the Angus Mail implementation. Please refer to CHANGES.txt for a list of the changes since the previous release. -Please see the FAQ at https://eclipse-ee4j.github.io/mail/FAQ +Please see the FAQ at https://eclipse-ee4j.github.io/angus-mail/FAQ Protocol Providers ------------------ -The Angus Mail jar file "jakarta.mail.jar" includes the full Jakarta Mail +The Angus Mail jar file "angus-mail.jar" includes the full Jakarta Mail API implementation, the Angus Mail runtime and the Sun protocol providers - IMAP, SMTP, and POP3. The simplest way to use the Angus Mail is to just use the -jakarta.mail.jar file and ignore the other jar files in this package. +angus-mail.jar file and ignore the other jar files in this package. In some cases it may be desirable to minimize the size of the Jakarta Mail API code used by an application (e.g., in a microservice). @@ -70,10 +70,10 @@ configure SASL support. DSN Support ----------- -This release of Jakarta Mail includes EXPERIMENTAL support for creating +This release of Angus Mail includes EXPERIMENTAL support for creating and parsing Delivery Status Notifications, as defined by RFC 3462 and RFC 3464. To make use of this support you need to include dsn.jar -in your CLASSPATH along with jakarta.mail.jar. See the javadocs for the +in your CLASSPATH along with angus-mail.jar. See the javadocs for the com.sun.mail.dsn package for more details. The DSN package also provides support for creating and parsing Message @@ -87,7 +87,7 @@ applications using the current APIs. NTLM Support ------------ -This release of Jakarta Mail includes EXPERIMENTAL support for the +This release of Angus Mail includes EXPERIMENTAL support for the Microsoft NTLM authentication mechanism used by Exchange. See the file NTLMNOTES.txt for details. @@ -103,7 +103,7 @@ How to submit bug reports ------------------------- If you've found a bug, or if you just need help figuring out how to use -the Jakarta Mail API or Angus Mail API, please try to include the following information in +the Jakarta Mail API or Angus Mail, please try to include the following information in your message to us: - a program or code snippet that shows the problem @@ -125,19 +125,19 @@ Our response: Turn on session debugging and send us the protocol trace. session debugging for the demo programs. In your own program, call "session.setDebug(true);". -Your problem: jakarta.mail or jakarta.activation classes not found when +Your problem: angus.mail or jakarta.activation classes not found when compiling. -Our response: You didn't set CLASSPATH correctly to find jakarta.mail.jar and +Our response: You didn't set CLASSPATH correctly to find angus-mail.jar and jakarta.activation.jar. See README.txt. Your problem: NoSuchProviderException - No such provider for rfc822. -Our response: You unjar'ed jakarta.mail.jar. Don't. +Our response: You unjar'ed angus-mail.jar. Don't. Your problem: How do I create a message with an attachment? Our response: Create a message with a MimeMultipart content. See the sendfile.html and msgmultisendsample.java demo programs. -Please check the FAQ at https://eclipse-ee4j.github.io/mail/FAQ +Please check the FAQ at https://eclipse-ee4j.github.io/angus-mail/FAQ before submitting bug reports. Send your bug reports to: @@ -201,7 +201,7 @@ Check out our website at https://eclipse-ee4j.github.io/angus-mail/. You can also find help on StackOverflow: - https://stackoverflow.com/questions/tagged/javamail + https://stackoverflow.com/questions/tagged/jakarta-mail ------------------------------------------------------------------ diff --git a/providers/imap/src/main/java/org/eclipse/angus/mail/imap/package-info.java b/providers/imap/src/main/java/org/eclipse/angus/mail/imap/package-info.java index f28ae627..19068cb7 100644 --- a/providers/imap/src/main/java/org/eclipse/angus/mail/imap/package-info.java +++ b/providers/imap/src/main/java/org/eclipse/angus/mail/imap/package-info.java @@ -18,7 +18,7 @@ * An IMAP protocol provider for the Jakarta Mail API * that provides access to an IMAP message store. * Both the IMAP4 and IMAP4rev1 protocols are supported. - * Refer to + * Refer to * RFC 3501 * for more information. * The IMAP protocol provider also supports many IMAP extensions (described below). @@ -32,7 +32,7 @@ * UIDPLUS Support *

* The IMAP UIDPLUS extension - * (RFC 4315) + * (RFC 4315) * is supported via the IMAPFolder methods * {@link org.eclipse.angus.mail.imap.IMAPFolder#addMessages addMessages}, * {@link org.eclipse.angus.mail.imap.IMAPFolder#appendUIDMessages appendUIDMessages}, and @@ -41,7 +41,7 @@ * MOVE Support *

* The IMAP MOVE extension - * (RFC 6851) + * (RFC 6851) * is supported via the IMAPFolder methods * {@link org.eclipse.angus.mail.imap.IMAPFolder#moveMessages moveMessages} and * {@link org.eclipse.angus.mail.imap.IMAPFolder#moveUIDMessages moveUIDMessages}. @@ -49,17 +49,17 @@ * SASL Support *

* The IMAP protocol provider can use SASL - * (RFC 4422) + * (RFC 4422) * authentication mechanisms on systems that support the * javax.security.sasl APIs. * The SASL-IR - * (RFC 4959) + * (RFC 4959) * capability is also supported. * In addition to the SASL mechanisms that are built into * the SASL implementation, users can also provide additional * SASL mechanisms of their own design to support custom authentication * schemes. See the - * + * * Java SASL API Programming and Deployment Guide for details. * Note that the current implementation doesn't support SASL mechanisms * that provide their own integrity or confidentiality layer. @@ -67,12 +67,12 @@ * OAuth 2.0 Support *

* Support for OAuth 2.0 authentication via the - * + * * XOAUTH2 authentication mechanism is provided either through the SASL * support described above or as a built-in authentication mechanism in the * IMAP provider. * The OAuth 2.0 Access Token should be passed as the password for this mechanism. - * See + * See * OAuth2 Support for details. *

* Connection Pool @@ -100,7 +100,7 @@ * QUOTA Support *

* The IMAP QUOTA extension - * (RFC 2087) + * (RFC 2087) * is supported via the * {@link jakarta.mail.QuotaAwareStore QuotaAwareStore} interface implemented by * {@link org.eclipse.angus.mail.imap.IMAPStore IMAPStore}, and the @@ -109,7 +109,7 @@ * ACL Support *

* The IMAP ACL extension - * (RFC 2086) + * (RFC 2086) * is supported via the * {@link org.eclipse.angus.mail.imap.Rights Rights} class and the IMAPFolder methods * {@link org.eclipse.angus.mail.imap.IMAPFolder#getACL getACL}, @@ -123,7 +123,7 @@ * SORT Support *

* The IMAP SORT extension - * (RFC 5256) + * (RFC 5256) * is supported via the * {@link org.eclipse.angus.mail.imap.SortTerm SortTerm} class and the IMAPFolder * {@link org.eclipse.angus.mail.imap.IMAPFolder#getSortedMessages getSortedMessages} @@ -132,9 +132,9 @@ * CONDSTORE and QRESYNC Support *

* Basic support is provided for the IMAP CONDSTORE - * (RFC 4551) + * (RFC 4551) * and QRESYNC - * (RFC 5162) + * (RFC 5162) * extensions for the purpose of resynchronizing a folder after offline operation. * Of course, the server must support these extensions. * Use of these extensions is enabled by using the new @@ -182,7 +182,7 @@ * WITHIN Search Support *

* The IMAP WITHIN search extension - * (RFC 5032) + * (RFC 5032) * is supported via the * {@link org.eclipse.angus.mail.imap.YoungerTerm YoungerTerm} and * {@link org.eclipse.angus.mail.imap.OlderTerm OlderTerm} @@ -195,7 +195,7 @@ * LOGIN-REFERRAL Support *

* The IMAP LOGIN-REFERRAL extension - * (RFC 2221) + * (RFC 2221) * is supported. * If a login referral is received when connecting or when authentication fails, a * {@link org.eclipse.angus.mail.imap.ReferralException ReferralException} is thrown. @@ -206,7 +206,7 @@ * COMPRESS Support *

* The IMAP COMPRESS extension - * (RFC 4978) + * (RFC 4978) * is supported. * If the server supports the extension and the * mail.imap.compress.enable property is set to "true", @@ -215,7 +215,7 @@ * UTF-8 Support *

* The IMAP UTF8 extension - * (RFC 6855) + * (RFC 6855) * is supported. * If the server supports the extension, the client will enable use of UTF-8, * allowing use of UTF-8 in IMAP protocol strings such as folder names. @@ -454,8 +454,8 @@ * int * * NTLM protocol-specific flags. - * See - * http://curl.haxx.se/rfc/ntlm.html#theNtlmFlags for details. + * See + * https://curl.se/rfc/ntlm.html#theNtlmFlags for details. * * * @@ -624,7 +624,7 @@ * boolean * * If set to false, it does not check the server identity as specified by - * RFC 2595. + * RFC 2595. * These additional checks based on the content of the server's certificate * are intended to prevent man-in-the-middle attacks. * Defaults to true. diff --git a/providers/pop3/src/main/java/org/eclipse/angus/mail/pop3/package-info.java b/providers/pop3/src/main/java/org/eclipse/angus/mail/pop3/package-info.java index 913e6672..67a856e4 100644 --- a/providers/pop3/src/main/java/org/eclipse/angus/mail/pop3/package-info.java +++ b/providers/pop3/src/main/java/org/eclipse/angus/mail/pop3/package-info.java @@ -17,7 +17,7 @@ /** * A POP3 protocol provider for the Jakarta Mail API * that provides access to a POP3 message store. - * Refer to + * Refer to * RFC 1939 * for more information. *

@@ -30,7 +30,7 @@ *

* Note that Jakarta Mail does not include a local store into * which messages can be downloaded and stored. See our - * + * * Third Party Products * web page for availability of "mbox" and "MH" local store providers. *

@@ -135,7 +135,7 @@ *

*

* The POP3 CAPA command (defined by - * RFC 2449) + * RFC 2449) * will be used to determine the capabilities supported by the server. * Some servers don't implement the CAPA command, and some servers don't * return correct information, so various properties are available to @@ -143,7 +143,7 @@ *

*

* If the server advertises the PIPELINING capability (defined by - * RFC 2449), + * RFC 2449), * or the mail.pop3.pipelining property is set, the POP3 * provider will send some commands in batches, which can significantly * improve performance and memory use. @@ -362,8 +362,8 @@ * int * * NTLM protocol-specific flags. - * See - * http://curl.haxx.se/rfc/ntlm.html#theNtlmFlags for details. + * See + * https://curl.se/rfc/ntlm.html#theNtlmFlags for details. * * * @@ -383,8 +383,8 @@ * int * * Sets the LM compatibility level, as described here: - * - * http://curl.haxx.se/rfc/ntlm.html#ntlmVersion2 + * + * https://curl.se/rfc/ntlm.html#ntlmVersion2 * Defaults to "3". Currently not used. * * @@ -464,7 +464,7 @@ * boolean * * If set to false, it does not check the server identity as specified by - * RFC 2595. + * RFC 2595. * These additional checks based on the content of the server's certificate * are intended to prevent man-in-the-middle attacks. * Defaults to true. diff --git a/providers/smtp/src/main/java/org/eclipse/angus/mail/smtp/package-info.java b/providers/smtp/src/main/java/org/eclipse/angus/mail/smtp/package-info.java index 822aad62..9929a836 100644 --- a/providers/smtp/src/main/java/org/eclipse/angus/mail/smtp/package-info.java +++ b/providers/smtp/src/main/java/org/eclipse/angus/mail/smtp/package-info.java @@ -17,7 +17,7 @@ /** * An SMTP protocol provider for the Jakarta Mail API * that provides access to an SMTP server. - * Refer to RFC 821 + * Refer to RFC 821 * for more information. *

* When sending a message, detailed information on each address that @@ -37,12 +37,12 @@ *

*

* The SMTP provider also supports ESMTP - * (RFC 1651). + * (RFC 1651). * It can optionally use SMTP Authentication - * (RFC 2554) + * (RFC 2554) * using the LOGIN, PLAIN, DIGEST-MD5, and NTLM mechanisms - * (RFC 4616 - * and RFC 2831). + * (RFC 4616 + * and RFC 2831). *

*

* To use SMTP authentication you'll need to set the mail.smtp.auth @@ -98,14 +98,14 @@ *

*

* The SMTP protocol provider can use SASL - * (RFC 2222) + * (RFC 2222) * authentication mechanisms on systems that support the * javax.security.sasl APIs, such as J2SE 5.0. * In addition to the SASL mechanisms that are built into * the SASL implementation, users can also provide additional * SASL mechanisms of their own design to support custom authentication * schemes. See the - * + * * Java SASL API Programming and Deployment Guide for details. * Note that the current implementation doesn't support SASL mechanisms * that provide their own integrity or confidentiality layer. @@ -117,17 +117,17 @@ * support described above or as a built-in authentication mechanism in the * SMTP provider. * The OAuth 2.0 Access Token should be passed as the password for this mechanism. - * See + * See * OAuth2 Support for details. *

*

* SMTP can also optionally request Delivery Status Notifications - * (RFC 1891). + * (RFC 1891). * The delivery status will typically be reported using * a "multipart/report" - * (RFC 1892) + * (RFC 1892) * message type with a "message/delivery-status" - * (RFC 1894) + * (RFC 1894) * part. * You can use the classes in the org.eclipse.angus.mail.dsn package to * handle these MIME types. @@ -146,7 +146,7 @@ *

*

* The SMTP protocol provider supports the CHUNKING extension defined in - * RFC 3030. + * RFC 3030. * Set the mail.smtp.chunksize property to the desired chunk * size in bytes. * If the server supports the CHUNKING extension, the BDAT command will be @@ -358,8 +358,8 @@ * int * * NTLM protocol-specific flags. - * See - * http://curl.haxx.se/rfc/ntlm.html#theNtlmFlags for details. + * See + * https://curl.se/rfc/ntlm.html#theNtlmFlags for details. * * * @@ -379,8 +379,8 @@ * int * * Sets the LM compatibility level, as described here: - * - * http://curl.haxx.se/rfc/ntlm.html#ntlmVersion2 + * + * https://curl.se/rfc/ntlm.html#ntlmVersion2 * Defaults to "3". Currently not used. * * @@ -587,7 +587,7 @@ * boolean * * If set to false, it does not check the server identity as specified by - * RFC 2595. + * RFC 2595. * These additional checks based on the content of the server's certificate * are intended to prevent man-in-the-middle attacks. * Defaults to true. @@ -753,7 +753,7 @@ * method {@link org.eclipse.angus.mail.smtp.SMTPTransport#supportsExtension * supportsExtension} * to verify that the server supports the desired service extension. - * See RFC 1869 + * See RFC 1869 * and other RFCs that define specific extensions. * * diff --git a/www/FAQ.html b/www/FAQ.html index 2c43d0b9..65d02377 100644 --- a/www/FAQ.html +++ b/www/FAQ.html @@ -1,8 +1,8 @@ --- layout: default -title: Jakarta Mail FAQ +title: Angus Mail FAQ --- -

Jakarta Mail FAQ

+

Angus Mail FAQ

@@ -18,7 +18,7 @@

General

operating system?
  • Do the Jakarta Mail APIs work in web browsers?
    -
  • Can I use Jakarta Mail to read mail from my web mail account +
  • Can I use Angus Mail to read mail from my web mail account (such as Yahoo or Hotmail)?
    @@ -32,12 +32,11 @@

    General


  • Where do I find documentation on the protocol providers?
    -
  • Is the Jakarta Mail API implementation completely free? +
  • Is Angus Mail completely free? Can I ship it along with my product?
    -
  • Can I get the source code for the Jakarta Mail API - implementation? +
  • Can I get the source code for Angus Mail?
    -
  • Is Jakarta Mail Y2K compliant?
    +
  • Is Angus Mail Y2K compliant?
  • The answer to my question isn't here, where else should I look?
    @@ -57,19 +56,19 @@

    Installation and Configuration

  • How do I set my CLASSPATH on Windows?
    -
  • How do I add the Jakarta Mail library to my NetBeans Java Project? +
  • How do I add the Angus Mail library to my NetBeans Java Project?
    -
  • How do I add the Jakarta Mail library to my Eclipse Java Project? +
  • How do I add the Angus Mail library to my Eclipse Java Project?
    -
  • Does Jakarta Mail include all the necessary mail servers? +
  • Does Angus Mail include all the necessary mail servers?
  • Where can I get the necessary mail servers?
  • What host name, user name, or password should I use?
    -
  • How do I configure Jakarta Mail to work through my proxy server? +
  • How do I configure Angus Mail to work through my proxy server? [updated!]
  • When connecting to my mail server over SSL I get an exception like @@ -78,16 +77,16 @@

    Installation and Configuration


  • While trying to run my program on Linux I get a very strange error message and the program fails. What did I do wrong?
    -
  • How do I use Jakarta Mail in an application run under a SecurityManager; - what permissions must I grant to the application and to Jakarta Mail? +
  • How do I use Angus Mail in an application run under a SecurityManager; + what permissions must I grant to the application and to Angus Mail?
    -
  • How do I configure Tomcat to allow me to use Jakarta Mail in my +
  • How do I configure Tomcat to allow me to use Angus Mail in my web application?
    -
  • When using Jakarta Mail in my servlet, it is unable to find any of - the Jakarta Mail classes. I've added jakarta.mail.jar to the server's CLASSPATH. +
  • When using Angus Mail in my servlet, it is unable to find any of + the Angus Mail classes. I've added angus-mail.jar to the server's CLASSPATH.
  • I'm sure I've set my CLASSPATH correctly, but I'm still getting @@ -95,12 +94,12 @@

    Installation and Configuration

    classes.
    -
  • My servlet can find the Jakarta Mail classes, but Jakarta Mail complains +
  • My servlet can find the Angus Mail classes, but Angus Mail complains that it can't find a service provider for "smtp" or "imap" or address type "rfc822".
    -
  • How do I access Gmail with Jakarta Mail? +
  • How do I access Gmail with Angus Mail?
  • Why do I get AuthenticationFailedException when accessing Gmail? @@ -115,11 +114,11 @@

    Installation and Configuration

    [new!]
    -
  • How do I access Yahoo! Mail with Jakarta Mail? +
  • How do I access Yahoo! Mail with Angus Mail?
    -
  • How do I access Hotmail (Windows Live mail) with Jakarta Mail? +
  • How do I access Hotmail (Windows Live mail) with Angus Mail?
    -
  • How do I access Outlook.com with Jakarta Mail? +
  • How do I access Outlook.com with Angus Mail?

    @@ -127,12 +126,12 @@

    Installation and Configuration

    Programming



    -

    Jakarta Mail in servlets

    +

    Angus Mail in servlets

    -

    Jakarta Mail in applets

    +

    Angus Mail in applets