public class MimeMessageFiller
extends java.lang.Object
MimeMessageFiller
- Provides basic methods to fills an instance of MimeMessage
with headers/contents given through an
instance of ComposedMailMessage
Constructor and Description |
---|
MimeMessageFiller(com.openexchange.session.Session session,
com.openexchange.groupware.contexts.Context ctx)
Initializes a new
MimeMessageFiller |
MimeMessageFiller(com.openexchange.session.Session session,
com.openexchange.groupware.contexts.Context ctx,
UserSettingMail usm)
Initializes a new
MimeMessageFiller |
Modifier and Type | Method and Description |
---|---|
static void |
addClientIPAddress(javax.mail.internet.MimeMessage mimeMessage,
com.openexchange.session.Session session)
Add "X-Originating-IP" header.
|
void |
deleteReferencedUploadFiles()
Deletes referenced local uploaded files from session and disk after filled instance of
is dispatched |
void |
fillMailBody(ComposedMailMessage mail,
javax.mail.internet.MimeMessage mimeMessage,
ComposeType type)
Fills the body of given instance of
MimeMessage with the contents specified through given instance of
ComposedMailMessage . |
int |
getAccountId()
Gets the account identifier
|
static boolean |
isCustomOrReplyHeader(java.lang.String headerName)
Checks if specified header name is a custom header (starts ignore-case with
"X-" ) or refers to a reply-relevant header. |
MimeMessageFiller |
setAccountId(int accountId)
Sets the account identifier
|
void |
setCommonHeaders(javax.mail.internet.MimeMessage mimeMessage)
Sets common headers in given MIME message:
X-Mailer and Organization . |
MimeMessageFiller |
setDiscardReferencedInlinedImages(boolean discardReferencedInlinedImages)
Sets whether to discard referenced inlined images.
|
void |
setMessageHeaders(ComposedMailMessage mail,
javax.mail.internet.MimeMessage mimeMessage)
Sets necessary headers in specified MIME message:
From / Sender , To , Cc ,
Bcc , Reply-To , Subject , etc. |
static void |
setReplyHeaders(MailMessage referencedMail,
javax.mail.internet.MimeMessage mimeMessage)
Sets the appropriate headers
In-Reply-To and References in specified MIME message. |
void |
setSendHeaders(ComposedMailMessage mail,
javax.mail.internet.MimeMessage mimeMessage)
Sets the appropriate headers before message's transport:
Reply-To , Date , and Subject |
public MimeMessageFiller(com.openexchange.session.Session session, com.openexchange.groupware.contexts.Context ctx)
MimeMessageFiller
session
- The session providing user datactx
- The contextpublic MimeMessageFiller(com.openexchange.session.Session session, com.openexchange.groupware.contexts.Context ctx, UserSettingMail usm)
MimeMessageFiller
session
- The session providing user datactx
- The contextusm
- The user's mail settingspublic MimeMessageFiller setDiscardReferencedInlinedImages(boolean discardReferencedInlinedImages)
discardReferencedInlinedImages
- The flag to setpublic MimeMessageFiller setAccountId(int accountId)
accountId
- The account identifier to setpublic int getAccountId()
public void deleteReferencedUploadFiles()
MimeMessage
is dispatchedpublic void setCommonHeaders(javax.mail.internet.MimeMessage mimeMessage) throws javax.mail.MessagingException, com.openexchange.exception.OXException
X-Mailer
and Organization
.mimeMessage
- The MIME messagejavax.mail.MessagingException
- If headers cannot be setcom.openexchange.exception.OXException
public static void addClientIPAddress(javax.mail.internet.MimeMessage mimeMessage, com.openexchange.session.Session session) throws javax.mail.MessagingException
mimeMessage
- The MIME messagesession
- The sessionjavax.mail.MessagingException
- If an error occurspublic void setMessageHeaders(ComposedMailMessage mail, javax.mail.internet.MimeMessage mimeMessage) throws javax.mail.MessagingException, com.openexchange.exception.OXException
From
/ Sender
, To
, Cc
,
Bcc
, Reply-To
, Subject
, etc.mail
- The composed mailmimeMessage
- The MIME messagejavax.mail.MessagingException
- If headers cannot be setcom.openexchange.exception.OXException
- If a mail error occurspublic static boolean isCustomOrReplyHeader(java.lang.String headerName)
"X-"
) or refers to a reply-relevant header.headerName
- The header name to checktrue
if specified header name is a custom OR reply-relevant header; otherwise false
public static void setReplyHeaders(MailMessage referencedMail, javax.mail.internet.MimeMessage mimeMessage) throws javax.mail.MessagingException
In-Reply-To
and References
in specified MIME message.
Moreover the Reply-To
header is set.
referencedMail
- The referenced mailmimeMessage
- The MIME messagejavax.mail.MessagingException
- If setting the reply headers failspublic void setSendHeaders(ComposedMailMessage mail, javax.mail.internet.MimeMessage mimeMessage) throws com.openexchange.exception.OXException
Reply-To
, Date
, and Subject
mail
- The source mailmimeMessage
- The MIME messagecom.openexchange.exception.OXException
- If a mail error occurspublic void fillMailBody(ComposedMailMessage mail, javax.mail.internet.MimeMessage mimeMessage, ComposeType type) throws javax.mail.MessagingException, com.openexchange.exception.OXException, java.io.IOException
MimeMessage
with the contents specified through given instance of
ComposedMailMessage
.mail
- The source composed mailmimeMessage
- The MIME message to filltype
- The compose typejavax.mail.MessagingException
- If a messaging error occurscom.openexchange.exception.OXException
- If a mail error occursjava.io.IOException
- If an I/O error occurs