|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@StableMinor(version="5.5", sinceVersion="4.0") public interface ISendMailManager
Manager that offers send mail service. It also offers capability of sending e-mails asynchronously, by queueing them.
Method Summary | |
---|---|
void |
addMailToSendQueue(SessionConfig sessionConfig,
IMultipleMail mail,
String queueId,
ITransaction transaction)
Adds an e-mail to the send queue. |
void |
addMailToSendQueue(SessionConfig sessionConfig,
ISingleMail mail,
String queueId,
ITransaction transaction)
Adds an e-mail to the send queue. |
IMailAttachment |
createMailAttachment()
Factory method for creating a new mail attachment instance. |
IMailDestination |
createMailDestination()
Factory method for creating a new mail destination instance. |
IMultipleMail |
createMultipleMail()
Factory method for creating a new blank mail instance. |
ISingleMail |
createSingleMail()
Factory method for creating a new blank mail instance. |
void |
deleteMail(SessionConfig sessionConfig,
String mailId,
ITransaction transaction)
Deletes a mail and all its internal components (body, attachments, destinations). |
String |
generateNewQueueId()
Returns a new generated queue id. |
IMailConfig |
getMailConfig(SessionConfig sessionConfig,
ITransaction transaction)
Returns the IMailConfig containing the configurations for sending e-mails. |
void |
pollMailQueueProcessing()
Verifies the need to create another mail queue process thread, and create it if necessary. |
void |
sendMail(SessionConfig sessionConfig,
ISingleMail mail,
ITransaction transaction)
Sends an e-mail immediately. |
void |
setMailConfig(SessionConfig sessionConfig,
IMailConfig mailConfig,
ITransaction transaction)
Sets the IMailConfig containing the configurations for sending e-mails. |
Method Detail |
---|
ISingleMail createSingleMail() throws PortalException
ISingleMail
, to fill it with the required
data and use it in the other methods in this manager.
PortalException
createMultipleMail()
,
createMailAttachment()
IMultipleMail createMultipleMail() throws PortalException
IMultipleMail
, to fill it with the
required data and use it in the other methods in this manager.
PortalException
createSingleMail()
,
createMailAttachment()
,
createMailDestination()
IMailDestination createMailDestination() throws PortalException
IMailDestination
, to fill it
with the required data and use it in the other methods in this manager.
PortalException
createMultipleMail()
,
IMultipleMail.getDestinations()
IMailAttachment createMailAttachment() throws PortalException
IMailAttachment
, to fill it with
the required data and use it in the other methods in this manager.
PortalException
createSingleMail()
,
createMultipleMail()
,
IMailBody.getAttachments()
IMailConfig getMailConfig(SessionConfig sessionConfig, ITransaction transaction) throws PortalException
sessionConfig
- the user session information.transaction
- the transaction for persistence access.
PortalException
- if it was not possible to obtain the IMailConfig.void setMailConfig(SessionConfig sessionConfig, IMailConfig mailConfig, ITransaction transaction) throws PortalException
sessionConfig
- the user session information.mailConfig
- the IMailConfig.transaction
- the transaction for persistence access.
PortalException
- if it was not possible to set the IMailConfig.#getMailConfig(ITransaction)
void sendMail(SessionConfig sessionConfig, ISingleMail mail, ITransaction transaction) throws PortalException
sessionConfig
- the user session information.mail
- information about the e-mail to be sent.transaction
- the transaction for persistence access.
PortalException
- if it was not possible to send the e-mail.createSingleMail()
void addMailToSendQueue(SessionConfig sessionConfig, ISingleMail mail, String queueId, ITransaction transaction) throws PortalException
sessionConfig
- the user session information.mail
- information about the e-mail to be sent.queueId
- the id of the queue where the mail will be added to. If null a
new queue will be generated. To generate a new queueId use
generateNewQueueId()
.transaction
- the transaction for persistence access. If the transaction
rollbacks the e-mail will not be added to the queue and not
sent.
PortalException
- if it was not possible to queue the the e-mail.createSingleMail()
void addMailToSendQueue(SessionConfig sessionConfig, IMultipleMail mail, String queueId, ITransaction transaction) throws PortalException
sessionConfig
- the user session information.mail
- information about the e-mail to be sent.queueId
- the id of the queue where the mail will be added to. If null a
new queue will be generated. To generate a new queueId use
generateNewQueueId()
.transaction
- the transaction for persistence access. If the transaction
rollbacks the e-mail will not be added to the queue and not
sent.
PortalException
- if it was not possible to queue the e-mail.createMultipleMail()
void pollMailQueueProcessing() throws PortalException
PortalException
- if it was not possible to complete the operation.String generateNewQueueId() throws PortalException
PortalException
- if the queue id could not be generated.void deleteMail(SessionConfig sessionConfig, String mailId, ITransaction transaction) throws PortalException
sessionConfig
- the user session information.mailId
- the mail's id.transaction
- the transaction for persistence access.
PortalException
- if it was not possible to delete the mail.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |