public abstract class TransportProvider
extends java.lang.Object
TransportProvider
- Provider for mail transportModifier and Type | Method and Description |
---|---|
abstract MailTransport |
createNewMailTransport(com.openexchange.session.Session session)
Gets a newly created
mail transport |
abstract MailTransport |
createNewMailTransport(com.openexchange.session.Session session,
int accountId)
Gets a newly created
mail transport |
boolean |
equals(java.lang.Object obj) |
abstract ComposedMailMessage |
getNewComposedMailMessage(com.openexchange.session.Session session,
com.openexchange.groupware.contexts.Context ctx)
Gets a new instance of
ComposedMailMessage |
abstract DataMailPart |
getNewDataPart(java.lang.Object data,
java.util.Map<java.lang.String,java.lang.String> dataProperties,
com.openexchange.session.Session session)
Gets a new instance of
DataMailPart |
abstract InfostoreDocumentMailPart |
getNewDocumentPart(java.lang.String documentId,
com.openexchange.session.Session session)
Gets a new instance of
InfostoreDocumentMailPart |
abstract UploadFileMailPart |
getNewFilePart(com.openexchange.groupware.upload.UploadFile uploadFile)
Gets a new instance of
UploadFileMailPart |
abstract ReferencedMailPart |
getNewReferencedMail(MailMessage referencedMail,
com.openexchange.session.Session session)
Gets a new instance of
ReferencedMailPart |
abstract ReferencedMailPart |
getNewReferencedPart(MailPart referencedPart,
com.openexchange.session.Session session)
Gets a new instance of
ReferencedMailPart |
abstract TextBodyMailPart |
getNewTextBodyPart(java.lang.String textBody)
Gets a new instance of
TextBodyMailPart |
abstract Protocol |
getProtocol()
Gets this transport provider's protocol
|
int |
hashCode() |
boolean |
isDeprecated()
Checks if this provider is deprecated; any cached references should be discarded
|
boolean |
supportsProtocol(java.lang.String protocol)
Checks if this transport provider supports the given protocol (which is either in secure or non-secure notation).
|
public final boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public final int hashCode()
hashCode
in class java.lang.Object
public boolean isDeprecated()
true
if deprecated; otherwise false
public abstract Protocol getProtocol()
public final boolean supportsProtocol(java.lang.String protocol)
This is a convenience method that invokes Protocol.isSupported(String)
protocol
- The protocoltrue
if supported; otherwise false
public abstract MailTransport createNewMailTransport(com.openexchange.session.Session session) throws com.openexchange.exception.OXException
mail transport
session
- The session providing needed user datamail transport
com.openexchange.exception.OXException
- If instantiation failspublic abstract MailTransport createNewMailTransport(com.openexchange.session.Session session, int accountId) throws com.openexchange.exception.OXException
mail transport
session
- The session providing needed user dataaccountId
- The account IDmail transport
com.openexchange.exception.OXException
- If instantiation failspublic abstract ComposedMailMessage getNewComposedMailMessage(com.openexchange.session.Session session, com.openexchange.groupware.contexts.Context ctx) throws com.openexchange.exception.OXException
ComposedMailMessage
session
- The session for handling temporary uploaded files which shall be added to composed mailctx
- The context to load session-related dataComposedMailMessage
com.openexchange.exception.OXException
- If a new instance of ComposedMailMessage
cannot be createdpublic abstract UploadFileMailPart getNewFilePart(com.openexchange.groupware.upload.UploadFile uploadFile) throws com.openexchange.exception.OXException
UploadFileMailPart
uploadFile
- The upload fileUploadFileMailPart
com.openexchange.exception.OXException
- If a new instance of UploadFileMailPart
cannot be createdpublic abstract InfostoreDocumentMailPart getNewDocumentPart(java.lang.String documentId, com.openexchange.session.Session session) throws com.openexchange.exception.OXException
InfostoreDocumentMailPart
documentId
- The infostore document's unique IDsession
- The session providing needed user dataInfostoreDocumentMailPart
com.openexchange.exception.OXException
- If a new instance of InfostoreDocumentMailPart
cannot be createdpublic abstract DataMailPart getNewDataPart(java.lang.Object data, java.util.Map<java.lang.String,java.lang.String> dataProperties, com.openexchange.session.Session session) throws com.openexchange.exception.OXException
DataMailPart
data
- The data obtained by a data sourcedataProperties
- The data propertiessession
- The session providing needed user dataDataMailPart
com.openexchange.exception.OXException
- If a new instance of DataMailPart
cannot be createdpublic abstract TextBodyMailPart getNewTextBodyPart(java.lang.String textBody) throws com.openexchange.exception.OXException
TextBodyMailPart
textBody
- The text bodyTextBodyMailPart
com.openexchange.exception.OXException
- If a new instance of TextBodyMailPart
cannot be createdpublic abstract ReferencedMailPart getNewReferencedPart(MailPart referencedPart, com.openexchange.session.Session session) throws com.openexchange.exception.OXException
ReferencedMailPart
referencedPart
- The referenced partsession
- The session providing user dataReferencedMailPart
com.openexchange.exception.OXException
- If a new instance of ReferencedMailPart
cannot be createdpublic abstract ReferencedMailPart getNewReferencedMail(MailMessage referencedMail, com.openexchange.session.Session session) throws com.openexchange.exception.OXException
ReferencedMailPart
referencedMail
- The referenced mailsession
- The session providing user dataReferencedMailPart
com.openexchange.exception.OXException
- If a new instance of ReferencedMailPart
cannot be created