public interface MailService
MailService - The mail service to obtain both an appropriate instance of MailAccess for accessing mail system and an
appropriate instance of MailTransport for sending mails.| Modifier and Type | Method and Description |
|---|---|
MailAccess<? extends IMailFolderStorage,? extends IMailMessageStorage> |
getMailAccess(int userId,
int contextId,
int accountId)
Gets an appropriate instance of
mail access parameterized with given session. |
MailAccess<? extends IMailFolderStorage,? extends IMailMessageStorage> |
getMailAccess(com.openexchange.session.Session session,
int accountId)
Gets an appropriate instance of
mail access parameterized with given session. |
MailTransport |
getMailTransport(com.openexchange.session.Session session,
int accountId)
Gets an appropriate instance of
mail transport parameterized with given session. |
MailAccess<? extends IMailFolderStorage,? extends IMailMessageStorage> getMailAccess(com.openexchange.session.Session session, int accountId) throws com.openexchange.exception.OXException
mail access parameterized with given session.
When starting to work with obtained mail access at first its MailAccess.connect() method is supposed to be invoked.
On finished work the final MailAccess.close(boolean) must be called in order to release resources:
MailAccess mailAccess = null;
try {
mailAccess = mailService.getMailAccess(session);
mailAccess.connect();
// Do something
} finally {
if (mailAccess != null) {
mailAccess.close(putToCache);
}
}
session - The sessionaccountId - The account IDMailAccesscom.openexchange.exception.OXException - If an appropriate instance of mail access cannot be initializedMailAccess<? extends IMailFolderStorage,? extends IMailMessageStorage> getMailAccess(int userId, int contextId, int accountId) throws com.openexchange.exception.OXException
mail access parameterized with given session.
When starting to work with obtained mail access at first its MailAccess.connect() method is supposed to be invoked.
On finished work the final MailAccess.close(boolean) must be called in order to release resources:
MailAccess mailAccess = null;
try {
mailAccess = mailService.getMailAccess(...);
mailAccess.connect();
// Do something
} finally {
if (mailAccess != null) {
mailAccess.close(putToCache);
}
}
userId - The user IDcontextId - The context IDaccountId - The account IDMailAccesscom.openexchange.exception.OXException - If an appropriate instance of mail access cannot be initializedMailTransport getMailTransport(com.openexchange.session.Session session, int accountId) throws com.openexchange.exception.OXException
mail transport parameterized with given session.
Note: Don't forget to call final MailTransport.close() on obtained mail transport:
final MailTransport mailTransport = mailService.getMailTransport(session);
try {
// Do something
} finally {
mailTransport.close();
}
session - The session providing needed user dataaccountId - The account IDMailTransportcom.openexchange.exception.OXException - If an appropriate instance of mail transport cannot be initialized