public class InterfaxMailFaxClientSpi extends MailFaxClientSpi
Name | Description | Preconfigured Value | Default Value | Mandatory |
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.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 |
Modifier and Type | Class and Description |
---|---|
static class |
InterfaxMailFaxClientSpi.FaxClientSpiConfigurationConstants
This class holds the SPI configuration constants.
|
AbstractFaxClientSpi.FaxJobExtendedPropertyConstants
mailAddressTemplate, mailSubjectTemplate
Constructor and Description |
---|
InterfaxMailFaxClientSpi()
This is the default constructor.
|
Modifier and Type | Method and Description |
---|---|
protected javax.mail.Message |
createSubmitFaxJobMessage(FaxJob faxJob,
MailResourcesHolder mailResourcesHolder)
This function will create the message used to invoke the fax job action.
If this method returns null, the SPI will throw an UnsupportedOperationException. |
protected void |
initializeMailTemplates()
This function initializes the mail templates.
|
createCancelFaxJobMessage, createResumeFaxJobMessage, createSuspendFaxJobMessage, getMailAddressTemplate, getMailSubjectTemplate, initializeImpl
cancelFaxJobImpl, closeMailConnection, createMailConnection, createMailConnectionFactoryImpl, finalize, getMailConnection, resumeFaxJobImpl, sendMail, submitFaxJobImpl, suspendFaxJobImpl
getFaxJobStatusImpl, getProvider, isFaxMonitorEventsSupported, pollForFaxJobStatues, pollForFaxJobStatuesImpl
addFaxClientActionEventListener, addFaxMonitorEventListener, cancelFaxJob, createFaxJob, createFaxJobImpl, fireFaxEvent, fireFaxEvent, fireFaxMonitorEvent, getConfiguration, getConfigurationValue, getConfigurationValue, getFaxJobMonitor, getFaxJobStatus, getLogger, getPropertyPart, initialize, invokeFaxJobIDValidation, invokeFaxJobNullValidation, removeAllFaxClientActionEventListeners, removeAllFaxMonitorEventListeners, removeFaxClientActionEventListener, removeFaxMonitorEventListener, resumeFaxJob, submitFaxJob, suspendFaxJob, throwUnsupportedException
public InterfaxMailFaxClientSpi()
protected void initializeMailTemplates()
initializeMailTemplates
in class MailFaxClientSpi
protected javax.mail.Message createSubmitFaxJobMessage(FaxJob faxJob, MailResourcesHolder mailResourcesHolder)
createSubmitFaxJobMessage
in class MailFaxClientSpi
faxJob
- The fax job object containing the needed informationmailResourcesHolder
- The mail resources holderCopyright © 2009–2020 fax4j. All rights reserved.