KB-2215 How to update a custom plug-in using the JavaMail library to use the Jakarta Mail library

Kevin Kleinegger — Tue, 13 Sep 2022 15:29:11 GMT

Current Revision posted to Appian Knowledge Base by Kevin Kleinegger on 9/13/2022 3:29:11 PM

Purpose

In Appian 22.3, the mail library available for use in custom plug-ins has been updated from JavaMail (javax.mail) to Jakarta Mail (jakarta.mail). Custom plug-ins that reference the JavaMail library will need to be updated to use the Jakarta Mail library to continue to work in Appian 22.3.

This article outlines how to update a custom plug-in to use the Jakarta Mail library, which requires that import statements in each java class that reference the javax.mail and javax.activation packages to be updated to reference the jakarta.mail and jakarta.activation packages respectively.

Instructions - Gradle

In the project build.gradle file:

Ensure that any javax.mail and javax.activation dependencies are removed.

Add the jakarta.mail and jakarta.activation dependencies as compileOnly dependencies.

dependencies {
// .... other project dependencies ....

compileOnly 'com.sun.mail:jakarta.mail:2.0.1'
compileOnly 'com.sun.activation:jakarta.activation:2.0.1'

}

Instructions - Maven

In the project pom.xml file:

Ensure that any javax.mail and javax.activation dependencies are removed.

Add the jakarta.mail and jakarta.activation dependencies as system scoped dependencies.

<dependencies>
    <!-- .... other project dependencies .... -->
    <dependency>
        <groupId>com.sun.mail</groupId>
        <artifactId>jakarta.mail</artifactId>
        <version>2.0.1</version>
        <scope>system</scope>
    </dependency>
    <dependency>
        <groupId>com.sun.activation</groupId>
        <artifactId>jakarta.activation</artifactId>
        <version>2.0.1</version>
        <scope>system</scope>
    </dependency>
</dependencies>

Instructions - Eclipse IDE

Below are example steps for updating a plug-in project in Eclipse.

Open the existing plug-in project in Eclipse.
Ensure the project builds successfully.
1. Right click the project and click Export…
2. Select the JAR file option as the Export destination.
3. In the Resources to export dialog, clear the .classpath and .project selections as these files are used exclusively by Eclipse.
4. Select a destination directory for the export.
5. Click Finish.
Download the Jakarta Mail and Jakarta Activation JARs
1. Download the Jakarta Mail JAR at: https://repo1.maven.org/maven2/com/sun/mail/jakarta.mail/2.0.1/jakarta.mail-2.0.1.jar
2. Download the Jakarta Activation JAR at: https://repo1.maven.org/maven2/com/sun/activation/jakarta.activation/2.0.1/jakarta.activation-2.0.1.jar
3. Save these JARs locally in a location outside of the plugin project for use later.
Remove the JavaMail dependency JAR in META-INF/lib.
1. Delete the existing javax.mail and/or javax.activation JARs present in META-INF/lib.
Update the build path to remove the JavaMail library JAR
1. Update the Java Build Path to include any new JAR files; otherwise, the project will not build.
2. Right click the project and select Properties.
3. In the Package Explorer (left navigation), click Java Build Path.
4. Select the existing JavaMail libraries and click Remove.
Add the Jakarta JARs as external dependencies to the project
1. Right-click the project. Click Properties.
2. In the left navigation, select Java Build Path.
3. Select the Libraries tab. Click the Add External JARs… button.
4. Add the Jakarta Mail JAR as an external dependency and click OK.
  1. <LOCATION_SAVED_EARLIER>/jakarta.mail-2.0.1.jar
5. Click the Add External JARs… button. Add the Jakarta Activation JAR as an external dependency and click OK.
  1. <LOCATION_SAVED_EARLIER>/jakarta.activation-2.0.1.jar

Update any Java classes that reference the javax.mail or javax.activation packages to use the jakarta.mail and jakarta.activation packages respectively. The Jakarta Mail library implements the same classes as the JavaMail library because Jakarta is the updated version of this library.

Example class using javax.mail:
package com.appiancorp.plugins.example.mail; import java.util.Date; import java.util.Properties; import javax.mail.Authenticator; import javax.mail.Message; import javax.mail.PasswordAuthentication; import javax.mail.Session; import javax.mail.Transport; import javax.mail.internet.InternetAddress; import javax.mail.internet.MimeMessage; import org.apache.log4j.Logger;

Example class updated to use jakarta.mail:
package com.appiancorp.plugins.example.mail; import java.util.Date; import java.util.Properties; import jakarta.mail.Authenticator; import jakarta.mail.Message; import jakarta.mail.PasswordAuthentication; import jakarta.mail.Session; import jakarta.mail.Transport; import jakarta.mail.internet.InternetAddress; import jakarta.mail.internet.MimeMessage; import org.apache.log4j.Logger;

The updated classes and methods from the Jakarta Mail library will typically implement the same parameters and logic as the JavaMail equivalents. However, there may be some differences that will require updates to the plug-in beyond the update of the package naming alone.

Increment the plug-in version in appian-plugin.xml.
1. In order to differentiate this latest version of the plug-in from the existing release that implements the JavaMail library, increment the plug-in version within appian-plugin.xml.
2. As this is a change beyond a simple revision, the minor or major version of the plug-in can be incremented (e.g. <version>1.0.1</version> to <version>1.1.0</version>).
Ensure the updated plug-in builds successfully.
1. Right click the project and click Export…
2. Select the JAR file option as the Export destination.
3. In the Resources to export dialog, clear the .classpath and .project selections as these files are used exclusively by Eclipse.
4. Select the _admin/plugins folder of the installation directory for the export destination (this directory is created during application server startup).
5. Click Finish.

Affected Versions

This article applies to Appian 22.3 and later.

Last Reviewed: September 2022

Tags: integration, how-to, plugins

KB-2215 How to update a custom plug-in using the JavaMail library to use the Jakarta Mail library

Kevin Kleinegger — Tue, 13 Sep 2022 15:28:15 GMT

Revision 13 posted to Appian Knowledge Base by Kevin Kleinegger on 9/13/2022 3:28:15 PM

Purpose

Instructions - Gradle

In the project build.gradle file:

Ensure that any javax.mail and javax.activation dependencies are removed.

Add the jakarta.mail and jakarta.activation dependencies as compileOnly dependencies.

dependencies {
// .... other project dependencies ....

compileOnly 'com.sun.mail:jakarta.mail:2.0.1'
compileOnly 'com.sun.activation:jakarta.activation:2.0.1'

}

Instructions - Maven

In the project pom.xml file:

Ensure that any javax.mail and javax.activation dependencies are removed.

Add the jakarta.mail and jakarta.activation dependencies as system scoped dependencies.

<dependencies>
    <!-- .... other project dependencies .... -->
    <dependency>
        <groupId>com.sun.mail</groupId>
        <artifactId>jakarta.mail</artifactId>
        <version>2.0.1</version>
        <scope>system</scope>
    </dependency>
    <dependency>
        <groupId>com.sun.activation</groupId>
        <artifactId>jakarta.activation</artifactId>
        <version>2.0.1</version>
        <scope>system</scope>
    </dependency>
</dependencies>

Instructions - Eclipse IDE

Below are example steps for updating a plug-in project in Eclipse.

Open the existing plug-in project in Eclipse.
Ensure the project builds successfully.
1. Right click the project and click Export…
2. Select the JAR file option as the Export destination.
3. In the Resources to export dialog, clear the .classpath and .project selections as these files are used exclusively by Eclipse.
4. Select a destination directory for the export.
5. Click Finish.
Download the Jakarta Mail and Jakarta Activation JARs
1. Download the Jakarta Mail JAR at: https://repo1.maven.org/maven2/com/sun/mail/jakarta.mail/2.0.1/jakarta.mail-2.0.1.jar
2. Download the Jakarta Activation JAR at: https://repo1.maven.org/maven2/com/sun/activation/jakarta.activation/2.0.1/jakarta.activation-2.0.1.jar
3. Save these JARs locally in a location outside of the plugin project for use later.
Remove the JavaMail dependency JAR in META-INF/lib.
1. Delete the existing javax.mail and/or javax.activation JARs present in META-INF/lib.
Update the build path to remove the JavaMail library JAR
1. Update the Java Build Path to include any new JAR files; otherwise, the project will not build.
2. Right click the project and select Properties.
3. In the Package Explorer (left navigation), click Java Build Path.
4. Select the existing JavaMail libraries and click Remove.
Add the Jakarta JARs as external dependencies to the project
1. Right-click the project. Click Properties.
2. In the left navigation, select Java Build Path.
3. Select the Libraries tab. Click the Add External JARs… button.
4. Add the Jakarta Mail JAR as an external dependency and click OK.
  1. <LOCATION_SAVED_EARLIER>/jakarta.mail-2.0.1.jar
5. Click the Add External JARs… button. Add the Jakarta Activation JAR as an external dependency and click OK.
  1. <LOCATION_SAVED_EARLIER>/jakarta.activation-2.0.1.jar

The updated classes and methods from the Jakarta Mail library will typically implement the same parameters and logic as the JavaMail equivalents. However, there may be some differences that will require updates to the plug-in beyond the update of the package naming alone.

Increment the plug-in version in appian-plugin.xml.
1. In order to differentiate this latest version of the plug-in from the existing release that implements the JavaMail library, increment the plug-in version within appian-plugin.xml.
2. As this is a change beyond a simple revision, the minor or major version of the plug-in can be incremented (e.g. <version>1.0.1</version> to <version>1.1.0</version>).
Ensure the updated plug-in builds successfully.
1. Right click the project and click Export…
2. Select the JAR file option as the Export destination.
3. In the Resources to export dialog, clear the .classpath and .project selections as these files are used exclusively by Eclipse.
4. Select the _admin/plugins folder of the installation directory for the export destination (this directory is created during application server startup).
5. Click Finish.

Affected Versions

This article applies to Appian 22.3 and later.

Last Reviewed: September 2022

Tags: integration, how-to, plugins

KB-2215 How to update a custom plug-in using the JavaMail library to use the Jakarta Mail library

Kevin Kleinegger — Tue, 13 Sep 2022 15:24:26 GMT

Revision 12 posted to Appian Knowledge Base by Kevin Kleinegger on 9/13/2022 3:24:26 PM

** Updated as of 2022-09-13 with updated instructions to avoid Java classloader conflicts

Purpose

Instructions - Gradle

In the project build.gradle file:

Ensure that any javax.mail and javax.activation dependencies are removed.

Add the jakarta.mail and jakarta.activation dependencies as compileOnly dependencies.

dependencies {
// .... other project dependencies ....

compileOnly 'com.sun.mail:jakarta.mail:2.0.1'
compileOnly 'com.sun.activation:jakarta.activation:2.0.1'

}

Instructions - Maven

In the project pom.xml file:

Ensure that any javax.mail and javax.activation dependencies are removed.

Add the jakarta.mail and jakarta.activation dependencies as system scoped dependencies.

<dependencies>
    <!-- .... other project dependencies .... -->
    <dependency>
        <groupId>com.sun.mail</groupId>
        <artifactId>jakarta.mail</artifactId>
        <version>2.0.1</version>
        <scope>system</scope>
    </dependency>
    <dependency>
        <groupId>com.sun.activation</groupId>
        <artifactId>jakarta.activation</artifactId>
        <version>2.0.1</version>
        <scope>system</scope>
    </dependency>
</dependencies>

Instructions - Eclipse IDE

Below are example steps for updating a plug-in project in Eclipse.

Open the existing plug-in project in Eclipse.
Ensure the project builds successfully.
1. Right click the project and click Export…
2. Select the JAR file option as the Export destination.
3. In the Resources to export dialog, clear the .classpath and .project selections as these files are used exclusively by Eclipse.
4. Select a destination directory for the export.
5. Click Finish.
Download the Jakarta Mail and Jakarta Activation JARs
1. Download the Jakarta Mail JAR at: https://repo1.maven.org/maven2/com/sun/mail/jakarta.mail/2.0.1/jakarta.mail-2.0.1.jar
2. Download the Jakarta Activation JAR at: https://repo1.maven.org/maven2/com/sun/activation/jakarta.activation/2.0.1/jakarta.activation-2.0.1.jar
3. Save these JARs locally in a location outside of the plugin project for use later.
Remove the JavaMail dependency JAR in META-INF/lib.
1. Delete the existing javax.mail and/or javax.activation JARs present in META-INF/lib.
Update the build path to remove the JavaMail library JAR
1. Update the Java Build Path to include any new JAR files; otherwise, the project will not build.
2. Right click the project and select Properties.
3. In the Package Explorer (left navigation), click Java Build Path.
4. Select the existing JavaMail libraries and click Remove.
Add the Jakarta JARs as external dependencies to the project
1. Right-click the project. Click Properties.
2. In the left navigation, select Java Build Path.
3. Select the Libraries tab. Click the Add External JARs… button.
4. Add the Jakarta Mail JAR as an external dependency and click OK.
  1. <LOCATION_SAVED_EARLIER>/jakarta.mail-2.0.1.jar
5. Click the Add External JARs… button. Add the Jakarta Activation JAR as an external dependency and click OK.
  1. <LOCATION_SAVED_EARLIER>/jakarta.activation-2.0.1.jar

The updated classes and methods from the Jakarta Mail library will typically implement the same parameters and logic as the JavaMail equivalents. However, there may be some differences that will require updates to the plug-in beyond the update of the package naming alone.

Increment the plug-in version in appian-plugin.xml.
1. In order to differentiate this latest version of the plug-in from the existing release that implements the JavaMail library, increment the plug-in version within appian-plugin.xml.
2. As this is a change beyond a simple revision, the minor or major version of the plug-in can be incremented (e.g. <version>1.0.1</version> to <version>1.1.0</version>).
Ensure the updated plug-in builds successfully.
1. Right click the project and click Export…
2. Select the JAR file option as the Export destination.
3. In the Resources to export dialog, clear the .classpath and .project selections as these files are used exclusively by Eclipse.
4. Select the _admin/plugins folder of the installation directory for the export destination (this directory is created during application server startup).
5. Click Finish.

Affected Versions

This article applies to Appian 22.3 and later.

Last Reviewed: September 2022

Tags: integration, how-to, plugins

KB-2215 How to update a custom plug-in using the JavaMail library to use the Jakarta Mail library

Elly Meng — Wed, 18 May 2022 15:48:32 GMT

Revision 10 posted to Appian Knowledge Base by Elly Meng on 5/18/2022 3:48:32 PM

Purpose

Instructions

Below are example steps for updating a plug-in project in Eclipse.

Open the existing plug-in project in Eclipse.
Ensure the project builds successfully.
1. Right click the project and click Export…
2. Select the JAR file option as the Export destination.
3. In the Resources to export dialog, clear the .classpath and .project selections as these files are used exclusively by Eclipse.
4. Select a destination directory for the export.
5. Click Finish.
Replace the JavaMail dependency JAR with the Jakarta Mail JAR in META-INF/lib.
1. Ensure the Jakarta Mail JAR is included within the plug-in. The library that contains the classes used in the plug-in should always be included so that the plug-in uses the same version of the library regardless of which version of Appian it runs in. See here for more details.
Update the build path to remove the JavaMail library JAR and add the Jakarta Mail library JAR.
1. Update the Java Build Path to include any new JAR files; otherwise, the project will not build.
2. Right click the project and select Properties.
3. In the Package Explorer (left navigation), click Java Build Path.
4. In the Libraries tab, click Add JARs…
5. Select the Jakarta Mail JAR file in the project.
6. Select the existing JavaMail library and click Remove.

The updated classes and methods from the Jakarta Mail library will typically implement the same parameters and logic as the JavaMail equivalents. However, there may be some differences that will require updates to the plug-in beyond the update of the package naming alone.

Increment the plug-in version in appian-plugin.xml.
1. In order to differentiate this latest version of the plug-in from the existing release that implements the JavaMail library, increment the plug-in version within appian-plugin.xml.
2. As this is a change beyond a simple revision, the minor or major version of the plug-in can be incremented (e.g. <version>1.0.1</version> to <version>1.1.0</version>).
Ensure the updated plug-in builds successfully.
1. Right click the project and click Export…
2. Select the JAR file option as the Export destination.
3. In the Resources to export dialog, clear the .classpath and .project selections as these files are used exclusively by Eclipse.
4. Select the _admin/plugins folder of the installation directory for the export destination (this directory is created during application server startup).
5. Click Finish.

Affected Versions

This article applies to Appian 22.3 and later.

Last Reviewed: May 2022

Tags: integration, how-to, plugins

KB-2215 How to update a custom plug-in using the JavaMail library to use the Jakarta Mail library

Elly Meng — Wed, 18 May 2022 15:48:32 GMT

Revision 11 posted to Appian Knowledge Base by Elly Meng on 5/18/2022 3:48:32 PM

Purpose

Instructions

Below are example steps for updating a plug-in project in Eclipse.

Open the existing plug-in project in Eclipse.
Ensure the project builds successfully.
1. Right click the project and click Export…
2. Select the JAR file option as the Export destination.
3. In the Resources to export dialog, clear the .classpath and .project selections as these files are used exclusively by Eclipse.
4. Select a destination directory for the export.
5. Click Finish.
Replace the JavaMail dependency JAR with the Jakarta Mail JAR in META-INF/lib.
1. Ensure the Jakarta Mail JAR is included within the plug-in. The library that contains the classes used in the plug-in should always be included so that the plug-in uses the same version of the library regardless of which version of Appian it runs in. See here for more details.
Update the build path to remove the JavaMail library JAR and add the Jakarta Mail library JAR.
1. Update the Java Build Path to include any new JAR files; otherwise, the project will not build.
2. Right click the project and select Properties.
3. In the Package Explorer (left navigation), click Java Build Path.
4. In the Libraries tab, click Add JARs…
5. Select the Jakarta Mail JAR file in the project.
6. Select the existing JavaMail library and click Remove.

The updated classes and methods from the Jakarta Mail library will typically implement the same parameters and logic as the JavaMail equivalents. However, there may be some differences that will require updates to the plug-in beyond the update of the package naming alone.

Increment the plug-in version in appian-plugin.xml.
1. In order to differentiate this latest version of the plug-in from the existing release that implements the JavaMail library, increment the plug-in version within appian-plugin.xml.
2. As this is a change beyond a simple revision, the minor or major version of the plug-in can be incremented (e.g. <version>1.0.1</version> to <version>1.1.0</version>).
Ensure the updated plug-in builds successfully.
1. Right click the project and click Export…
2. Select the JAR file option as the Export destination.
3. In the Resources to export dialog, clear the .classpath and .project selections as these files are used exclusively by Eclipse.
4. Select the _admin/plugins folder of the installation directory for the export destination (this directory is created during application server startup).
5. Click Finish.

Affected Versions

This article applies to Appian 22.3 and later.

Last Reviewed: May 2022

Tags: integration, how-to, plugins

How to update a custom plug-in using the JavaMail library to use the Jakarta Mail library

Elly Meng — Wed, 18 May 2022 15:42:51 GMT

Revision 9 posted to Appian Knowledge Base by Elly Meng on 5/18/2022 3:42:51 PM

Purpose

Instructions

Below are example steps for updating a plug-in project in Eclipse.

Open the existing plug-in project in Eclipse.
Ensure the project builds successfully.
1. Right click the project and click Export…
2. Select the JAR file option as the Export destination.
3. In the Resources to export dialog, clear the .classpath and .project selections as these files are used exclusively by Eclipse.
4. Select a destination directory for the export.
5. Click Finish.
Replace the JavaMail dependency JAR with the Jakarta Mail JAR in META-INF/lib.
1. Ensure the Jakarta Mail JAR is included within the plug-in. The library that contains the classes used in the plug-in should always be included so that the plug-in uses the same version of the library regardless of which version of Appian it runs in. See here for more details.
Update the build path to remove the JavaMail library JAR and add the Jakarta Mail library JAR.
1. Update the Java Build Path to include any new JAR files; otherwise, the project will not build.
2. Right click the project and select Properties.
3. In the Package Explorer (left navigation), click Java Build Path.
4. In the Libraries tab, click Add JARs…
5. Select the Jakarta Mail JAR file in the project.
6. Select the existing JavaMail library and click Remove.

The updated classes and methods from the Jakarta Mail library will typically implement the same parameters and logic as the JavaMail equivalents. However, there may be some differences that will require updates to the plug-in beyond the update of the package naming alone.

Increment the plug-in version in appian-plugin.xml.
1. In order to differentiate this latest version of the plug-in from the existing release that implements the JavaMail library, increment the plug-in version within appian-plugin.xml.
2. As this is a change beyond a simple revision, the minor or major version of the plug-in can be incremented (e.g. <version>1.0.1</version> to <version>1.1.0</version>).
Ensure the updated plug-in builds successfully.
1. Right click the project and click Export…
2. Select the JAR file option as the Export destination.
3. In the Resources to export dialog, clear the .classpath and .project selections as these files are used exclusively by Eclipse.
4. Select the _admin/plugins folder of the installation directory for the export destination (this directory is created during application server startup).
5. Click Finish.

Affected Versions

This article applies to Appian 22.3 and later.

Last Reviewed: May 2022

How to update a custom plug-in using the JavaMail library to use the Jakarta Mail library

Elly Meng — Wed, 18 May 2022 15:42:32 GMT

Revision 8 posted to Appian Knowledge Base by Elly Meng on 5/18/2022 3:42:32 PM

Purpose

Instructions

Below are example steps for updating a plug-in project in Eclipse.

Open the existing plug-in project in Eclipse.
Ensure the project builds successfully.
1. Right click the project and click Export…
2. Select the JAR file option as the Export destination.
3. In the Resources to export dialog, clear the .classpath and .project selections as these files are used exclusively by Eclipse.
4. Select a destination directory for the export.
5. Click Finish.
Replace the JavaMail dependency JAR with the Jakarta Mail JAR in META-INF/lib.
1. Ensure the Jakarta Mail JAR is included within the plug-in. The library that contains the classes used in the plug-in should always be included so that the plug-in uses the same version of the library regardless of which version of Appian it runs in. See here for more details.
Update the build path to remove the JavaMail library JAR and add the Jakarta Mail library JAR.
1. Update the Java Build Path to include any new JAR files; otherwise, the project will not build.
2. Right click the project and select Properties.
3. In the Package Explorer (left navigation), click Java Build Path.
4. In the Libraries tab, click Add JARs…
5. Select the Jakarta Mail JAR file in the project.
6. Select the existing JavaMail library and click Remove.

The updated classes and methods from the Jakarta Mail library will typically implement the same parameters and logic as the JavaMail equivalents. However, there may be some differences that will require updates to the plug-in beyond the update of the package naming alone.

Increment the plug-in version in appian-plugin.xml.
1. In order to differentiate this latest version of the plug-in from the existing release that implements the JavaMail library, increment the plug-in version within appian-plugin.xml.
2. As this is a change beyond a simple revision, the minor or major version of the plug-in can be incremented (e.g. <version>1.0.1</version> to <version>1.1.0</version>).
Ensure the updated plug-in builds successfully.
1. Right click the project and click Export…
2. Select the JAR file option as the Export destination.
3. In the Resources to export dialog, clear the .classpath and .project selections as these files are used exclusively by Eclipse.
4. Select the _admin/plugins folder of the installation directory for the export destination (this directory is created during application server startup).
5. Click Finish.

Affected Versions

This article applies to Appian 22.3 and later.

Last Reviewed: May 2022

How to migrate a Custom Plug-in using the JavaMail library to use the Jakarta Mail library

Elly Meng — Wed, 18 May 2022 15:40:47 GMT

Revision 7 posted to Appian Knowledge Base by Elly Meng on 5/18/2022 3:40:47 PM

Purpose

Instructions

Below are example steps for updating a plug-in project in Eclipse.

Open the existing plug-in project in Eclipse.
Ensure the project builds successfully.
1. Right click the project and click Export…
2. Select the JAR file option as the Export destination.
3. In the Resources to export dialog, clear the .classpath and .project selections as these files are used exclusively by Eclipse.
4. Select a destination directory for the export.
5. Click Finish.
Replace the JavaMail dependency JAR with the Jakarta Mail JAR in META-INF/lib.
1. Ensure the Jakarta Mail JAR is included within the plug-in. The library that contains the classes used in the plug-in should always be included so that the plug-in uses the same version of the library regardless of which version of Appian it runs in. See here for more details.
Update the build path to remove the JavaMail library JAR and add the Jakarta Mail library JAR.
1. Update the Java Build Path to include any new JAR files; otherwise, the project will not build.
2. Right click the project and select Properties.
3. In the Package Explorer (left navigation), click Java Build Path.
4. In the Libraries tab, click Add JARs…
5. Select the Jakarta Mail JAR file in the project.
6. Select the existing JavaMail library and click Remove.

The updated classes and methods from the Jakarta Mail library will typically implement the same parameters and logic as the JavaMail equivalents. However, there may be some differences that will require updates to the plug-in beyond the update of the package naming alone.

Increment the plug-in version in appian-plugin.xml.
1. In order to differentiate this latest version of the plug-in from the existing release that implements the JavaMail library, increment the plug-in version within appian-plugin.xml.
2. As this is a change beyond a simple revision, the minor or major version of the plug-in can be incremented (e.g. <version>1.0.1</version> to <version>1.1.0</version>).
Ensure the updated plug-in builds successfully.
1. Right click the project and click Export…
2. Select the JAR file option as the Export destination.
3. In the Resources to export dialog, clear the .classpath and .project selections as these files are used exclusively by Eclipse.
4. Select the _admin/plugins folder of the installation directory for the export destination (this directory is created during application server startup).
5. Click Finish.

Affected Versions

This article applies to Appian 22.3 and later.

Last Reviewed: May 2022

How to migrate a Custom Plug-in using the JavaMail library to use the Jakarta Mail library

Elly Meng — Wed, 18 May 2022 15:37:38 GMT

Revision 6 posted to Appian Knowledge Base by Elly Meng on 5/18/2022 3:37:38 PM

Purpose

Instructions

Below are example steps for updating a plug-in project in Eclipse.

Open the existing plug-in project in Eclipse.
Ensure the project builds successfully.
1. Right click the project and click Export…
2. Select the JAR file option as the Export destination.
3. In the Resources to export dialog, clear the .classpath and .project selections as these files are used exclusively by Eclipse.
4. Select a destination directory for the export.
5. Click Finish.
Replace the JavaMail dependency JAR with the Jakarta Mail JAR in META-INF/lib.
1. Ensure the Jakarta Mail JAR is included within the plug-in. The library that contains the classes used in the plug-in should always be included so that the plug-in uses the same version of the library regardless of which version of Appian it runs in. See here for more details.
Update the build path to remove the JavaMail library JAR and add the Jakarta Mail library JAR.
1. Update the Java Build Path to include any new JAR files; otherwise, the project will not build.
2. Right click the project and select Properties.
3. In the Package Explorer (left navigation), click Java Build Path.
4. In the Libraries tab, click Add JARs…
5. Select the Jakarta Mail JAR file in the project.
6. Select the existing JavaMail library and click Remove.

The updated classes and methods from the Jakarta Mail library will typically implement the same parameters and logic as the JavaMail equivalents. However, there may be some differences that will require updates to the plug-in beyond the update of the package naming alone.

Increment the plug-in version in appian-plugin.xml.
1. In order to differentiate this latest version of the plug-in from the existing release that implements the JavaMail library, increment the plug-in version within appian-plugin.xml.
2. As this is a change beyond a simple revision, the minor or major version of the plug-in can be incremented (e.g. <version>1.0.1</version> to <version>1.1.0</version>).
Ensure the updated plug-in builds successfully.
1. Right click the project and click Export…
2. Select the JAR file option as the Export destination.
3. In the Resources to export dialog, clear the .classpath and .project selections as these files are used exclusively by Eclipse.
4. Select the _admin/plugins folder of the installation directory for the export destination (this directory is created during application server startup).
5. Click Finish.

Affected Versions

This article applies to Appian 22.3 and later.

Last Reviewed: May 2022

DRAFT: Migrating a Custom Plug-in using the JavaMail library to use the Jakarta Mail library

Tom Ryan — Tue, 17 May 2022 01:06:45 GMT

Revision 5 posted to Appian Knowledge Base by Tom Ryan on 5/17/2022 1:06:45 AM

The update to use the Jakarta Mail library requires import statements in each java class that reference the javax.mail package and the javax.activation package to be updated to reference the jakarta.mail package and the jakarta.activation package respectively.

Example steps to update a plug-in project in Eclipse:

Open your existing plug-in project in Eclipse.
Ensure the project builds successfully.
1. Right click your project and click Export….
2. Select the JAR file option as the Export destination.
3. On the Resources to export dialog, clear the .classpath and .project selections as these files are used exclusively by Eclipse.
4. Select a destination directory for the export.
5. Click Finish.
Replace the JavaMail dependency JAR with the Jakarta Mail JAR in META-INF/lib
1. Ensure you include the Jakarta Mail JAR within your plug-in. You should always include the library that contains the classes used in your plug-in so that the plug-in uses the same version of the library regardless of which version of Appian it runs in. See: https://docs.appian.com/suite/help/latest/Custom_Plug-in_Packages.html
Update the build path to remove the JavaMail library JAR and add the Jakarta Mail library JAR.
1. Update your Java Build Path to include any new JAR files; otherwise, the project won't build.
2. Right click the project and select Properties.
3. In the Package Explorer (left navigation) click Java Build Path.
4. On the Libraries tab, click Add JARs….
5. Select the Jakarta Mail JAR file in your project.
6. Select the existing JavaMail library and click Remove.
Update any Java classes that reference the javax.mail or javax.activation packages to use the jakarta.mail and jakarta.activation packages.
1. The Jakarta Mail library implements the same classes as the JavaMail library because Jakarta is the updated version of this same library. As such, we need to update the classes in the project to use the jakarta.mail package instead of the javax.mail package and the jakarta.activation package instead of the javax.activation package.
2. Example class using javax.mail:
  1. package com.appiancorp.plugins.example.mail; import java.util.Date; import java.util.Properties; import javax.mail.Authenticator; import javax.mail.Message; import javax.mail.PasswordAuthentication; import javax.mail.Session; import javax.mail.Transport; import javax.mail.internet.InternetAddress; import javax.mail.internet.MimeMessage; import org.apache.log4j.Logger;
3. Example class updated to use jakarta.mail:
  1. package com.appiancorp.plugins.example.mail; import java.util.Date; import java.util.Properties; import jakarta.mail.Authenticator; import jakarta.mail.Message; import jakarta.mail.PasswordAuthentication; import jakarta.mail.Session; import jakarta.mail.Transport; import jakarta.mail.internet.InternetAddress; import jakarta.mail.internet.MimeMessage; import org.apache.log4j.Logger;
4. The updated classes and methods from the Jakarta Mail library will typically implement the same parameters and logic as the JavaMail equivalents. However, there may be some differences that will require updates to your plug-in beyond the update of the package naming alone.
Increment the plug-in version in appian-plugin.xml.
1. In order to differentiate this latest version of your plug-in from the existing release that implements the JavaMail library, you should increment the version of this plug-in within the appian-plugin.xml file.
  1. Example current version:
    1. <version>1.0.1</version>
  2. Example new version:
    1. <version>1.1.0</version>
2. As this is a change beyond a simple revision, you may wish to increment the minor or major version of the plug-in.
Ensure the updated plug-in builds successfully.
1. Right click your project and click Export….
2. Select the JAR file option as the Export destination.
3. On the Resources to export dialog, clear the .classpath and .project selections as these files are used exclusively by Eclipse.
4. Select the _admin/plugins folder of your installation directory for your export destination. - This directory is created during application server startup.
5. Click Finish.

DRAFT: Migrating a Custom Plugin using the JavaMail library to the Jakarta Mail library

Tom Ryan — Tue, 17 May 2022 01:04:30 GMT

Revision 4 posted to Appian Knowledge Base by Tom Ryan on 5/17/2022 1:04:30 AM

For custom plug-ins that reference the JavaMail library, the update to use the Jakarta Mail library requires the update of the import statements in each java class to move from the use of the javax.mail package to the jakarta.mail package, and from the javax.activation package to the jakarta.activation package.

Example steps to update a plug-in project in Eclipse:

Open your existing plug-in project in Eclipse.
Ensure the project builds successfully.
1. Right click your project and click Export….
2. Select the JAR file option as the Export destination.
3. On the Resources to export dialog, clear the .classpath and .project selections as these files are used exclusively by Eclipse.
4. Select a destination directory for the export.
5. Click Finish.
Replace the JavaMail dependency JAR with the Jakarta Mail JAR in META-INF/lib
1. Ensure you include the Jakarta Mail JAR within your plug-in. You should always include the library that contains the classes used in your plug-in so that the plug-in uses the same version of the library regardless of which version of Appian it runs in. See: https://docs.appian.com/suite/help/latest/Custom_Plug-in_Packages.html
Update the build path to remove the JavaMail library JAR and add the Jakarta Mail library JAR.
1. Update your Java Build Path to include any new JAR files; otherwise, the project won't build.
2. Right click the project and select Properties.
3. In the Package Explorer (left navigation) click Java Build Path.
4. On the Libraries tab, click Add JARs….
5. Select the Jakarta Mail JAR file in your project.
6. Select the existing JavaMail library and click Remove.
Update any Java classes that reference the javax.mail or javax.activation packages to use the jakarta.mail and jakarta.activation packages.
1. The Jakarta Mail library implements the same classes as the JavaMail library because Jakarta is the updated version of this same library. As such, we need to update the classes in the project to use the jakarta.mail package instead of the javax.mail package and the jakarta.activation package instead of the javax.activation package.
2. Example class using javax.mail:
  1. package com.appiancorp.plugins.example.mail; import java.util.Date; import java.util.Properties; import javax.mail.Authenticator; import javax.mail.Message; import javax.mail.PasswordAuthentication; import javax.mail.Session; import javax.mail.Transport; import javax.mail.internet.InternetAddress; import javax.mail.internet.MimeMessage; import org.apache.log4j.Logger;
3. Example class updated to use jakarta.mail:
  1. package com.appiancorp.plugins.example.mail; import java.util.Date; import java.util.Properties; import jakarta.mail.Authenticator; import jakarta.mail.Message; import jakarta.mail.PasswordAuthentication; import jakarta.mail.Session; import jakarta.mail.Transport; import jakarta.mail.internet.InternetAddress; import jakarta.mail.internet.MimeMessage; import org.apache.log4j.Logger;
4. The updated classes and methods from the Jakarta Mail library will typically implement the same parameters and logic as the JavaMail equivalents. However, there may be some differences that will require updates to your plug-in beyond the update of the package naming alone.
Increment the plug-in version in appian-plugin.xml.
1. In order to differentiate this latest version of your plug-in from the existing release that implements the JavaMail library, you should increment the version of this plug-in within the appian-plugin.xml file.
  1. Example current version:
    1. <version>1.0.1</version>
  2. Example new version:
    1. <version>1.1.0</version>
2. As this is a change beyond a simple revision, you may wish to increment the minor or major version of the plug-in.
Ensure the updated plug-in builds successfully.
1. Right click your project and click Export….
2. Select the JAR file option as the Export destination.
3. On the Resources to export dialog, clear the .classpath and .project selections as these files are used exclusively by Eclipse.
4. Select the _admin/plugins folder of your installation directory for your export destination. - This directory is created during application server startup.
5. Click Finish.

DRAFT: Migrating a Custom Plugin using the JavaMail library to the Jakarta Mail library

Tom Ryan — Tue, 17 May 2022 01:03:56 GMT

Revision 3 posted to Appian Knowledge Base by Tom Ryan on 5/17/2022 1:03:56 AM

In Appian 22.3, the mail library available for use in custom plug-ins has been updated from JavaMail (javax.mail) to Jakarta Mail (jakarta.mail). Custom plug-ins that reference the JavaMail library will need to be updated to use the Jakarta Mail library to continue to work in Appian 22.3.

Example steps to update a plug-in project in Eclipse:

Open your existing plug-in project in Eclipse.
Ensure the project builds successfully.
1. Right click your project and click Export….
2. Select the JAR file option as the Export destination.
3. On the Resources to export dialog, clear the .classpath and .project selections as these files are used exclusively by Eclipse.
4. Select a destination directory for the export.
5. Click Finish.
Replace the JavaMail dependency JAR with the Jakarta Mail JAR in META-INF/lib
1. Ensure you include the Jakarta Mail JAR within your plug-in. You should always include the library that contains the classes used in your plug-in so that the plug-in uses the same version of the library regardless of which version of Appian it runs in. See: https://docs.appian.com/suite/help/latest/Custom_Plug-in_Packages.html
Update the build path to remove the JavaMail library JAR and add the Jakarta Mail library JAR.
1. Update your Java Build Path to include any new JAR files; otherwise, the project won't build.
2. Right click the project and select Properties.
3. In the Package Explorer (left navigation) click Java Build Path.
4. On the Libraries tab, click Add JARs….
5. Select the Jakarta Mail JAR file in your project.
6. Select the existing JavaMail library and click Remove.
Update any Java classes that reference the javax.mail or javax.activation packages to use the jakarta.mail and jakarta.activation packages.
1. The Jakarta Mail library implements the same classes as the JavaMail library because Jakarta is the updated version of this same library. As such, we need to update the classes in the project to use the jakarta.mail package instead of the javax.mail package and the jakarta.activation package instead of the javax.activation package.
2. Example class using javax.mail:
  1. package com.appiancorp.plugins.example.mail; import java.util.Date; import java.util.Properties; import javax.mail.Authenticator; import javax.mail.Message; import javax.mail.PasswordAuthentication; import javax.mail.Session; import javax.mail.Transport; import javax.mail.internet.InternetAddress; import javax.mail.internet.MimeMessage; import org.apache.log4j.Logger;
3. Example class updated to use jakarta.mail:
  1. package com.appiancorp.plugins.example.mail; import java.util.Date; import java.util.Properties; import jakarta.mail.Authenticator; import jakarta.mail.Message; import jakarta.mail.PasswordAuthentication; import jakarta.mail.Session; import jakarta.mail.Transport; import jakarta.mail.internet.InternetAddress; import jakarta.mail.internet.MimeMessage; import org.apache.log4j.Logger;
4. The updated classes and methods from the Jakarta Mail library will typically implement the same parameters and logic as the JavaMail equivalents. However, there may be some differences that will require updates to your plug-in beyond the update of the package naming alone.
Increment the plug-in version in appian-plugin.xml.
1. In order to differentiate this latest version of your plug-in from the existing release that implements the JavaMail library, you should increment the version of this plug-in within the appian-plugin.xml file.
  1. Example current version:
    1. <version>1.0.1</version>
  2. Example new version:
    1. <version>1.1.0</version>
2. As this is a change beyond a simple revision, you may wish to increment the minor or major version of the plug-in.
Ensure the updated plug-in builds successfully.
1. Right click your project and click Export….
2. Select the JAR file option as the Export destination.
3. On the Resources to export dialog, clear the .classpath and .project selections as these files are used exclusively by Eclipse.
4. Select the _admin/plugins folder of your installation directory for your export destination. - This directory is created during application server startup.
5. Click Finish.

DRAFT: Migrating a Custom Plugin using the JavaMail library to the Jakarta Mail library

chase.putnam — Wed, 11 May 2022 04:35:18 GMT

Revision 2 posted to Appian Knowledge Base by chase.putnam on 5/11/2022 4:35:18 AM

Please note that Appian 22.3+ uses the Jakarta Mail library. Appian versions prior to this use the JavaMail library.

Appian is deprecating the use of the JavaMail (javax.mail) library in Appian 22.2 for replacement with the modern Jakarta Mail (jakarta.mail) library in Appian 22.3.

The Jakarta Mail library is a set of abstract APIs that model a mail system. (Jakarta Mail was previously known as JavaMail before migration into the Apache Foundation.) The library provides a platform independent and protocol independent framework to build Java technology based email client applications.

For many of the custom plugins implementing the JavaMail library, the update to use the Jakarta Mail library requires the update of the import statements in each java class to move from the use of ‘javax.mail’ to the ‘jakarta.mail’ package and the ‘javax.activation’ to the ‘jakarta.activation’ package in order to use the new library appropriately.

Steps:

Open your existing plugin project in Eclipse.
Ensure the current code base compiles successfully.
1. Right click your project and click Export….
2. Select the JAR file option as the Export destination.
3. On the Resources to export dialog, clear the .classpath and .project selections as these files are used exclusively by Eclipse.
4. Select a destination directory for the export.
5. Click Finish.
Replace the JavaMail dependency JAR with the Jakarta Mail JAR in META-INF/lib
1. (If your plugin is not importing a self-contained dependency JAR and is using a dependency inherited from the Appian product, please ensure you include the Jakarta Mail JAR within your plugin. You should always include the library that contains the classes used in your plug-in so that the plug-in uses the same version of the library regardless of which version of Appian it runs in. See: https://docs.appian.com/suite/help/latest/Custom_Plug-in_Packages.html)
Update the build path to remove the JavaMail library JAR and add the Jakarta Mail library JAR.
1. Update your Java Build Path to include any new JAR files; otherwise, Eclipse won't compile.
2. Right click the project and select Properties.
3. In the Package Explorer (left navigation) click Java Build Path.
4. On the Libraries tab, click Add JARs….
5. Select the Jakarta Mail JAR file in your project.
6. Select the existing JavaMail library and click Remove.

Update Java classes to use the jakarta.mail and jakarta.activation packages.

The Jakarta Mail library implements the same classes as the JavaMail library because Jakarta is the updated version of this same library. As such, we need to update the classes in the project to use the ‘jakarta.mail’ package instead of the ‘javax.mail’ package and the ‘jakarta.activation’ package instead of the ‘javax.activation’ package.

Example class using javax.mail:

package com.appiancorp.plugins.example.mail; import java.util.Date; import java.util.Properties; import javax.mail.Authenticator; import javax.mail.Message; import javax.mail.PasswordAuthentication; import javax.mail.Session; import javax.mail.Transport; import javax.mail.internet.InternetAddress; import javax.mail.internet.MimeMessage; import org.apache.log4j.Logger;

Example class updated to use jakarta.mail:

package com.appiancorp.plugins.example.mail; import java.util.Date; import java.util.Properties; import jakarta.mail.Authenticator; import jakarta.mail.Message; import jakarta.mail.PasswordAuthentication; import jakarta.mail.Session; import jakarta.mail.Transport; import jakarta.mail.internet.InternetAddress; import jakarta.mail.internet.MimeMessage; import org.apache.log4j.Logger;

(The updated classes and methods from the Jakarta Mail library will typically implement the same parameters and logic as the JavaMail equivalents. However, there may be some differences that will require updates to your plugin code base beyond the update of the package naming alone.)

Increment the plugin version in appian-plugin.xml.
1. In order to differentiate this latest version of your plugin from the existing release that implements the JavaMail library, you should increment the version of this plugin within the appian-plugin.xml file.
  1. Example current version:
    1. <version>1.0.1</version>
  2. Example new version:
    1. <version>1.1.0</version>
2. (As this is a change beyond a simple revision, you may wish to increment the minor or major version of the plugin.)
Ensure the updated code base compiles successfully.
1. Right click your project and click Export….
2. Select the JAR file option as the Export destination.
3. On the Resources to export dialog, clear the .classpath and .project selections as these files are used exclusively by Eclipse.
4. Select the _admin/plugins folder of your installation directory for your export destination. - This directory is created during application server startup.
5. Click Finish.

DRAFT: Migrating a Custom Plugin using the JavaMail library to the Jakarta Mail library

chase.putnam — Wed, 11 May 2022 04:28:04 GMT

Revision 1 posted to Appian Knowledge Base by chase.putnam on 5/11/2022 4:28:04 AM

Please note that Appian 22.3+ uses the Jakarta Mail library. Appian versions prior to this use the JavaMail library.

Appian is deprecating the use of the JavaMail (javax.mail) library in Appian 22.2 for replacement with the modern Jakarta Mail (jakarta.mail) library in Appian 22.3.

Steps:

Open your existing plugin project in Eclipse.
Ensure the current code base compiles successfully.
1. Right click your project and click Export….
2. Select the JAR file option as the Export destination.
3. On the Resources to export dialog, clear the .classpath and .project selections as these files are used exclusively by Eclipse.
4. Select a destination directory for the export.
5. Click Finish.
Replace the JavaMail dependency JAR with the Jakarta Mail JAR in META-INF/lib
1. (If your plugin is not importing a self-contained dependency JAR and is using a dependency inherited from the Appian product, please ensure you include the Jakarta Mail JAR within your plugin. You should always include the library that contains the classes used in your plug-in so that the plug-in uses the same version of the library regardless of which version of Appian it runs in. See: https://docs.appian.com/suite/help/latest/Custom_Plug-in_Packages.html)
Update the build path to remove the JavaMail library JAR and add the Jakarta Mail library JAR.
1. Update your Java Build Path to include any new JAR files; otherwise, Eclipse won't compile.
2. Right click the project and select Properties.
3. In the Package Explorer (left navigation) click Java Build Path.
4. On the Libraries tab, click Add JARs….
5. Select the Jakarta Mail JAR file in your project.
6. Select the existing JavaMail library and click Remove.

Update Java classes to use the jakarta.mail and jakarta.activation packages.

The Jakarta Mail library implements the same classes as the JavaMail library because Jakarta is the updated version of this same library. As such, we need to update the classes in the project to use the ‘jakarta.mail’ package instead of the ‘javax.mail’ package and the ‘jakarta.activation’ package instead of the ‘javax.activation’ package.

Example class using javax.mail:

Example class updated to use jakarta.mail:

(The updated classes and methods from the Jakarta Mail library will typically implement the same parameters and logic as the JavaMail equivalents. However, there may be some differences that will require updates to your plugin code base beyond the update of the package naming alone.)

Increment the plugin version in appian-plugin.xml.
1. In order to differentiate this latest version of your plugin from the existing release that implements the JavaMail library, you should increment the version of this plugin within the appian-plugin.xml file.
  1. Example current version:
    1. <version>1.0.1</version>
  2. Example new version:
    1. <version>1.1.0</version>
2. (As this is a change beyond a simple revision, you may wish to increment the minor or major version of the plugin.)
Ensure the updated code base compiles successfully.
1. Right click your project and click Export….
2. Select the JAR file option as the Export destination.
3. On the Resources to export dialog, clear the .classpath and .project selections as these files are used exclusively by Eclipse.
4. Select the _admin/plugins folder of your installation directory for your export destination. - This directory is created during application server startup.
5. Click Finish.