The polling MailTo transport supports sending messages (E-Mail) over SMTP and receiving messages over POP3 or IMAP. This transport implementation is available as a module of the WS-Commons Transports project. The receiver and sender classes that should be included in the Carbon configuration to enable the MailTo transport are org.apache.axis2.transport.mail.MailTransportListener and org.apache.axis2.transport.mail.MailTransportSender respectively. The JAR consisting of the transport implementation is named axis2-transport-mail.jar.
The mail transport receiver should be configured at service level. That is each service configuration should explicitly state the mail transport receiver configuration. This is required to enable different services to receive mails over different mail accounts and configurations. However, transport sender is generally configured globally so that all services can share the same transport sender configuration.
Service Level Transport Receiver Parameters
The MailTo transport listener implementation can be configured by setting the parameters described in JavaMail API documentation. For IMAP related properties, refer the documentation for com.sum.mail.imap package. For POP3 properties please refer the documentation for com.sun.mail.pop3 package. Apart from the parameters describes in JavaMail API documentation, the MailTo transport listener supports the following transport parameters.
Tip
In transport parameter tables, literals displayed in italic mode under the "Possible Values" column should be considered as fixed literal constant values. Those values can be directly put in transport configurations.
Parameter Name | Description | Requried | Possible Values | Default Value |
|---|---|---|---|---|
transport.mail.Address | The mail address from which this service should fetch incoming mails. | Yes | A valid e-mail address |
|
transport.mail.Folder | The mail folder in the server from which the listener should fetch incoming mails. | No | A valid mail folder name (eg: inbox) | inbox folder if that is available or else the root folder |
transport.mail.Protocol | The mail protocol to be used to receive messages. | No | pop3, imap | imap |
transport.mail.PreserveHeaders | A comma separated list of mail header names that this receiver should preserve in all incoming messages. | No | A comma separated list |
|
transport.mail.RemoveHeaders | A comma separated list of mail header names that this receiver should remove from incoming messages. | No | A comma separated list |
|
transport.mail.ActionAfterProcess | Action to perform on the mails after processing them. | No | MOVE, DELETE | DELETE |
transport.mail.ActionAfterFailure | Action to perform on the mails after a failure occurs while processing them. | No | MOVE, DELETE | DELETE |
transport.mail.MoveAfterProcess | Folder to move the mails after processing them. | Required if ActionAfterProcess is MOVE | A valid mail folder name |
|
transport.mail.MoveAfterFailure | Folder to move the mails after encountering a failure. | Required if ActionAfterFailure is MOVE | A valid mail folder name |
|
transport.mail.ProcessInParallel | Whether the receiver should process incoming mails in parallel or not (works only if the mail protocol supports that - for example, IMAP). | No | true, false | false |
transport.ConcurrentPollingAllowed | Whether the receiver should poll for multiple messages concurrently. | No | true, false | false |
transport.mail.MaxRetryCount | Maximum number of retry operations to be performed when fetching incoming mails. | Yes | A positive integer |
|
transport.mail.ReconnectTimeout | The reconnect timeout in milliseconds to be used when fetching incoming mails. | Yes | A positive integer |
|
Global Transport Sender Parameters
For a list of parameters supported by the MailTo transport sender, refer the API documentation for JavaMail com.sun.mail.smtp package. In addition to the parameters described there, the MailTo transport sender supports the following parameters.
Parameter Name | Description | Requried | Possible Values | Default Value |
|---|---|---|---|---|
transport.mail.SMTPBccAddresses | If one or more e-mail addresses need to be specified as BCC addresses for outgoing mails, this parameter can be used. | No | A comma separated list of e-mail addresses |
|
transport.mail.Format | Format of the outgoing mail. | No | Text, Multipart | Text |