Package org.fax4j.spi.email

Provides the email based fax client SPI implementation.

See: Description

Interface Summary

Interface	Description
MailConnectionFactory	This class defines the mail connection factory.

Class Summary

Class	Description
AbstractMailConnectionFactory	Provides partial implementation of the mail connection factory.
AbstractMailFaxClientSpi	This class implements the fax client service provider interface. This parial implementation will invoke the requests by sending emails to a mail server that supports conversion between email messages and fax messages. The mail SPI supports persistent connection to enable to reuse the same connection for all fax operation invocations or to create a new connection for each fax operation invocation. By default the SPI will create a new connection for each operation invocation however the org.fax4j.spi.mail.persistent.connection set to true will enable to reuse the connection. To set the user/password values of the mail connection the following 2 properties must be defined: org.fax4j.spi.mail.user.name and org.fax4j.spi.mail.password All properties defined in the fax4j configuration will be passed to the mail connection therefore it is possible to define mail specific properties (see java mail for more info) in the fax4j properties. Implementing SPI class will have to implement the createXXXFaxJobMessage methods. These methods will return the message to be sent for that fax job operation.
MailAuthenticator	This class implements the javax.mail.Authenticator
MailConnectionFactoryImpl	This class provides basic implementation of the mail connection factory.
MailFaxClientSpi	This class implements the fax client service provider interface. This implementation will invoke the requests by sending emails to a mail server that supports conversion between email messages and fax messages. The mail SPI supports persistent connection to enable to reuse the same connection for all fax operation invocations or to create a new connection for each fax operation invocation. By default the SPI will create a new connection for each operation invocation however the org.fax4j.spi.mail.persistent.connection set to true will enable to reuse the connection. To set the user/password values of the mail connection the following 2 properties must be defined: org.fax4j.spi.mail.user.name and org.fax4j.spi.mail.password All properties defined in the fax4j configuration will be passed to the mail connection therefore it is possible to define mail specific properties (see java mail for more info) in the fax4j properties. This SPI only supports to submit new fax jobs. The SPI supports embedding the target destination number into the TO address field and subject field by setting the org.fax4j.spi.mail.address.template and org.fax4j.spi.mail.subject.template properties. For example: org.fax4j.spi.mail.address.template={0}@myprovider.com For example: org.fax4j.spi.mail.subject.template=fax:{0} The {0} will be replaced with the destination number. The configuration of the fax4j framework is made up of 3 layers. The configuration is based on simple properties. Each layer overrides the lower layers by adding/changing the property values. The first layer is the internal fax4j.properties file located in the fax4j jar. This layer contains the preconfigured values for the fax4j framework and can be changed by updating these properties in the higher layers. The second layer is the external fax4j.properties file that is located on the classpath. This file is optional and provides the ability to override the internal configuration for the entire fax4j framework. The top most layer is the optional java.util.Properties object provided by the external classes when creating a new fax client. These properties enable to override the configuration of the lower 2 layers. SPI Status (Draft, Beta, Stable): Stable Below table describes the configuration values relevant for this class. Configuration: Name Description Preconfigured Value Default Value Mandatory org.fax4j.spi.mail.address.template The address template used when sending the mail message. In order to provide the target fax number as part of the email address you must specify {0} in the template. For example: org.fax4j.spi.mail.address.template={0}@myprovider.com none none true org.fax4j.spi.mail.subject.template The subject template used when sending the mail message. In order to provide the target fax number as part of the email subject line you must specify {0} in the template. For example: org.fax4j.spi.mail.subject.template=fax:{0} none none true org.fax4j.spi.mail.persistent.connection True to reuse the same mail connection for all fax activites, false to create a new mail connection for each fax activity. false false false org.fax4j.spi.mail.connection.factory.class.name The connection factory class name org.fax4j.spi.email.MailConnectionFactoryImpl org.fax4j.spi.email.MailConnectionFactoryImpl false org.fax4j.spi.mail.user.name The mail account user name. none none false org.fax4j.spi.mail.password The mail account password. none none false javax mail properties Any of the javax mail properties can be defined in the fax4j properties. These properties will be passed to the java mail framework. mail.transport.protocol=smtp mail.smtp.port=25 none false Limitations: This SPI is based on the java mail infrastructure, therefore this SPI cannot connect to mail servers through a proxy server. MailResourcesHolder This class holds the java mail objects. Enum Summary Enum Description AbstractMailFaxClientSpi.FaxClientSpiConfigurationConstants This class holds the SPI configuration constants. MailFaxClientSpi.FaxClientSpiConfigurationConstants This class holds the SPI configuration constants. Package org.fax4j.spi.email Description Provides the email based fax client SPI implementation. Skip navigation links Overview Package Class Use Tree Deprecated Index Help Prev Package Next Package Frames No Frames All Classes Copyright © 2009–2020 fax4j. All rights reserved.