Work with mail session properties files

Use properties files to create or change mail session properties.

Determine the changes to make to your mail session configuration or its configuration objects.

Start the wsadmin scripting tool. To start wsadmin using the Jython language, run the wsadmin -lang jython command from the bin directory of the server profile.

Use a properties file to create, modify, or delete a mail session object and its configuration properties.

Run administrative commands using wsadmin to create or change a properties file for a mail session, validate the properties, and apply them to the configuration.

Action	Procedure
create	Set properties and then run the applyConfigProperties command.
modify	Edit properties and then run the applyConfigProperties command.
delete	Uncomment #DELETE=true and run the deleteConfigProperties command.

Optionally, we can use interactive mode with the commands:

AdminTask.command_name('-interactive')

Tasks

• Create a mail session and its properties.

  1. Create a properties file for a MailSession object.

     Open an editor and create a mail session properties file. We can copy an example properties file in this step into an editor and modify the properties as needed for our situation.

     The following example defines a mail session with jndiName myJndiName under a mail provider named Built-in Mail Provider at cell scope:

     #
     # Header
     #
     ResourceType=MailSession
     ImplementingResourceType=MailSession
     ResourceId=Cell=!{cellName}:MailProvider=Built-in Mail Provider:MailSession=jndiName#myJndiName
     #DELETE=true
     #
     
     #
     #Properties
     #
     mailStorePort=0 #integer,default(0)
     mailFrom=null
     mailTransportPort=0 #integer,default(0)
     mailStoreHost=null
     providerType=null
     mailTransportHost=null
     mailStorePassword=null
     debug=false #boolean,default(false)
     mailStoreUser=null
     category=null
     description=myJndiName #required
     mailTransportUser=null
     ObjectName=null
     mailStoreProtocol=null
     provider=Built-in Mail Provider #ObjectName(MailProvider),readonly
     String=null
     mailTransportPassword=null
     strict=true #boolean,default(true)
     name=myName #required
     
     
     EnvironmentVariablesSection
     #
     #
     #Environment Variables
     cellName=WASCell06
     nodeName=WASNode04
     

  2. Run the applyConfigProperties command to create a mail session configuration.

     Running the applyConfigProperties command applies the properties file to the configuration. In this Jython example, the optional -reportFileName parameter produces a report named report.txt:

     AdminTask.applyConfigProperties(['-propertiesFileName myObjectType.props -reportFileName report.txt'])
     

• Modify an existing mail session.
  1. Obtain a properties file for the mail session to change.

     We can extract a properties file for a MailSession object using the extractConfigProperties command.

  2. Open the properties file in an editor and change the properties as needed.

     Ensure that the environment variables in the properties file match the system.

  3. Run the applyConfigProperties command to change a mail session configuration.

• If we no longer need a mail session, we can delete the entire mail session object.

  To delete the entire object, specify DELETE=true in the header section of the properties file and run the deleteConfigProperties command; for example:

  AdminTask.deleteConfigProperties('[-propertiesFileName myObjectType.props -reportFileName report.txt]') 
  

Use the properties file to configure and manage the mail session object.

What to do next

Save the changes to the configuration.

Extracting properties files

Create server, cluster, application, or authorization group objects using properties files and wsadmin scripting

Deleting server, cluster, application, or authorization group objects using properties files

PropertiesBasedConfiguration .