Work with mail provider properties files

We can use properties files to create or change mail provider properties.

Determine the changes to make to the mail provider configuration or its configuration objects.

From the server profile bin directory, run wsadmin -lang jython

Using a properties file create, modify, or delete a mail provider object and its configuration properties.

Run administrative commands using wsadmin to create or change a properties file for a mail provider, 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')

• Create a mail provider and its properties.

  1. Create a properties file for a MailProvider object.

     Open an editor and create a mail provider properties file. We can copy the example properties file in this step into an editor and modify the properties as needed for the situation. The example defines a mail provider named myProvider at cell scope:

     #
     # Header
     #
     ResourceType=MailProvider
     ImplementingResourceType=MailProvider
     ResourceId=Cell=!{cellName}:MailProvider=myProvider
     #DELETE=true
     #
      #
     #Properties
     #
     classpath={}
     name=myProvider
     isolatedClassLoader=false #boolean
     nativepath={}
     description=new mail provider providerType=null #readonly
      
     EnvironmentVariablesSection
     #
     #
     #Environment Variables
     cellName=WASCell06

  2. Run the applyConfigProperties command to create a mail provider 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 provider.

  1. Obtain a properties file for the mail provider to change.

     We can extract a properties file for a MailProvider 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 provider configuration.

• If we no longer need a mail provider, we can delete the entire mail provider 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]')

Results

We can use the properties file to configure and manage the mail provider object.

What to do next

Save the changes to the configuration.

Subtopics

• Work with mail session properties files
  We can use properties files to create or change mail session properties.

Related tasks

Extracting properties files

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

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

PropertiesBasedConfiguration (AdminTask)