public abstract class ComposedMailMessage extends MailMessage
ComposedMailMessage
- Subclass of MailMessage
designed for composing a mail.COLOR_LABEL_NONE, COLOR_LABEL_PREFIX, COLOR_LABEL_PREFIX_OLD, FLAG_ANSWERED, FLAG_DELETED, FLAG_DRAFT, FLAG_FLAGGED, FLAG_FORWARDED, FLAG_READ_ACK, FLAG_RECENT, FLAG_SEEN, FLAG_SPAM, FLAG_USER, PRIORITY_HIGH, PRIORITY_HIGHEST, PRIORITY_LOW, PRIORITY_LOWEST, PRIORITY_NORMAL, USER_FORWARDED, USER_READ_ACK
NO_ENCLOSED_PARTS
Modifier and Type | Method and Description |
---|---|
abstract void |
addEnclosedPart(MailPart part)
Adds an instance of
MailPart to enclosed parts |
void |
addRecipient(javax.mail.internet.InternetAddress recipient)
Adds a dedicated recipient to this composed mail.
|
void |
addRecipients(javax.mail.internet.InternetAddress[] recipients)
Adds dedicated recipients to this composed mail.
|
void |
cleanUp()
Cleans-up this composed mail's referenced uploaded files and frees temporary stored files.
|
abstract TextBodyMailPart |
getBodyPart()
Gets this composed message's body part.
|
com.openexchange.groupware.contexts.Context |
getContext()
Gets the context
|
abstract int |
getEnclosedCount()
Gets the number of enclosed mail parts.
|
abstract MailPart |
getEnclosedMailPart(int index)
Gets this composed mail's part located at given index.
|
javax.mail.internet.InternetAddress[] |
getRecipients()
Gets the composed mail's dedicated recipients.
|
ComposeType |
getSendType()
Gets the send type.
|
com.openexchange.session.Session |
getSession()
Gets the session
|
int |
getUnreadMessages()
Gets the number of unread messages
|
boolean |
hasRecipients()
Checks if this composed mail has dedicated recipients.
|
abstract MailPart |
removeEnclosedPart(int index)
Removes the enclosed part at the specified position.
|
abstract void |
setBodyPart(TextBodyMailPart mailPart)
Sets this composed message's body part.
|
void |
setFiller(MimeMessageFiller filler)
Sets the mail filler
|
void |
setSendType(ComposeType sendType)
Sets the send type.
|
void |
setUnreadMessages(int unreadMessages)
Sets the number of unread messages
|
addBcc, addBcc, addCc, addCc, addFrom, addFrom, addTo, addTo, addUserFlag, addUserFlags, clone, containsAccountId, containsAccountName, containsAppendVCard, containsBcc, containsCc, containsColorLabel, containsDispositionNotification, containsFlags, containsFolder, containsFrom, containsHasAttachment, containsMessageId, containsPrevSeen, containsPriority, containsReceivedDate, containsRecentCount, containsReferences, containsSentDate, containsSubject, containsThreadLevel, containsTo, containsUserFlags, getAccountId, getAccountName, getBcc, getCc, getColorLabel, getColorLabelIntValue, getColorLabelStringValue, getDispositionNotification, getFlags, getFolder, getFrom, getInReplyTo, getMailId, getMailPath, getMessageId, getPriority, getReceivedDate, getReceivedDateDirect, getRecentCount, getReferences, getSentDate, getSubject, getThreadLevel, getTo, getUserFlags, hasAttachment, isAnswered, isAppendVCard, isColorLabel, isDeleted, isDraft, isFlagged, isForwarded, isPrevSeen, isReadAcknowledgment, isRecent, isSeen, isSpam, isUser, parseColorLabel, removeAccountId, removeAccountName, removeAppendVCard, removeBcc, removeCc, removeColorLabel, removeDispositionNotification, removeFlags, removeFolder, removeFrom, removeHasAttachment, removeMessageId, removePrevSeen, removePriority, removeReceivedDate, removeRecentCount, removeReferences, removeSentDate, removeSubject, removeThreadLevel, removeTo, removeUserFlags, setAccountId, setAccountName, setAppendVCard, setColorLabel, setDispositionNotification, setFlag, setFlags, setFolder, setHasAttachment, setMailId, setMessageId, setPrevSeen, setPriority, setReceivedDate, setRecentCount, setReferences, setReferences, setSentDate, setSubject, setThreadLevel
addHeader, addHeaders, containsContentDisposition, containsContentId, containsContentType, containsFileName, containsHeader, containsHeaders, containsMsgref, containsSequenceId, containsSize, getContent, getContentDisposition, getContentId, getContentType, getDataHandler, getFileName, getFirstHeader, getHeader, getHeader, getHeader, getHeaders, getHeadersIterator, getHeadersSize, getInputStream, getMatchingHeaders, getMsgref, getNonMatchingHeaders, getSequenceId, getSize, getSource, getSourceBytes, hasEnclosedParts, hasHeaders, loadContent, prepareForCaching, removeContentDisposition, removeContentId, removeContentType, removeFileName, removeHeader, removeHeaders, removeMsgref, removeSequenceId, removeSize, setContentDisposition, setContentDisposition, setContentId, setContentType, setContentType, setFileName, setHeader, setMsgref, setSequenceId, setSize, writeTo
public void setSendType(ComposeType sendType)
sendType
- The send typepublic ComposeType getSendType()
public boolean hasRecipients()
true
if this composed mail has dedicated recipients; otherwise false
public javax.mail.internet.InternetAddress[] getRecipients()
public void addRecipient(javax.mail.internet.InternetAddress recipient)
recipient
- The recipient to addpublic void addRecipients(javax.mail.internet.InternetAddress[] recipients)
recipients
- The recipients to addpublic com.openexchange.session.Session getSession()
public com.openexchange.groupware.contexts.Context getContext()
public void setFiller(MimeMessageFiller filler)
filler
- The mail fillerpublic void cleanUp()
public int getUnreadMessages()
MailMessage
getUnreadMessages
in class MailMessage
public void setUnreadMessages(int unreadMessages)
MailMessage
setUnreadMessages
in class MailMessage
unreadMessages
- The number of unread messagespublic abstract int getEnclosedCount() throws com.openexchange.exception.OXException
Note: The returned number does not include the text body part applied with setBodyPart(TextBodyMailPart)
. To check
for contained parts:
composedMail.getEnclosedCount() > 0
getEnclosedCount
in class MailPart
MailPart.NO_ENCLOSED_PARTS
if not applicablecom.openexchange.exception.OXException
MailPart.NO_ENCLOSED_PARTS
public abstract MailPart getEnclosedMailPart(int index) throws com.openexchange.exception.OXException
Note: This method does not include the text body part applied with setBodyPart(TextBodyMailPart)
.
getEnclosedMailPart
in class MailPart
index
- The index of desired mail part or null
if not applicablecom.openexchange.exception.OXException
public abstract void setBodyPart(TextBodyMailPart mailPart)
The body part's content is supposed to be HTML content which is ought to be converted to appropriate MIME type on transport.
mailPart
- The body partpublic abstract TextBodyMailPart getBodyPart()
The body part's content is supposed to be HTML content which is ought to be converted to appropriate MIME type on transport.
public abstract MailPart removeEnclosedPart(int index)
index
- The index position