Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

XWIKI-12123: Allow sending Mails with a custom Message-ID header #407

Closed
wants to merge 1 commit into from
Closed

XWIKI-12123: Allow sending Mails with a custom Message-ID header #407

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
48 changes: 41 additions & 7 deletions ...platform-mail-send-default/src/main/java/org/xwiki/mail/internal/ExtendedMimeMessage.java
View file
Open in desktop
Expand Up @@ -19,13 +19,19 @@
*/
package org.xwiki.mail.internal;

import java.io.InputStream;

import javax.mail.MessagingException;
import javax.mail.Session;
import javax.mail.internet.MimeMessage;

/**
* Since there's no easy way to verify if the content of a {@link javax.mail.internet.MimeMessage} has been set we
* need to extend it to allow for this.
* Since there's no easy way to verify if the content of a {@link MimeMessage} has been set we need to extend it to
* allow for this.
* <p/>
* Another useful thing we are able to do because of this subclass is allowing custom Message-ID headers, which would
* otherwise be overridden with an automatically generated ID by the default {@link MimeMessage#updateMessageID()}
* implementation.
*
* @version $Id$
* @since 6.2M1
Expand All @@ -34,22 +40,50 @@ public class ExtendedMimeMessage extends MimeMessage
{
/**
* Create a new extended MimeMessage.
*
* Note: We don't care about supporting Session here ATM since it's not required. MimeMessages will be
* given a valid Session when it's deserialized from the mail content store for sending.
* <p/>
* Note: We don't care about supporting Session here ATM since it's not required. MimeMessages will be given a valid
* Session when it's deserialized from the mail content store for sending.
*/
public ExtendedMimeMessage()
{
super((Session) null);
}

/**
* @param source see javadoc for {@link MimeMessage#MimeMessage(javax.mail.internet.MimeMessage)}
* @throws MessagingException see javadoc for {@link MimeMessage#MimeMessage(javax.mail.internet.MimeMessage)}
* @param source see javadoc for {@link MimeMessage#MimeMessage(MimeMessage)}
* @throws MessagingException see javadoc for {@link MimeMessage#MimeMessage(MimeMessage)}
* @since 7.1RC1
*/
public ExtendedMimeMessage(MimeMessage source) throws MessagingException
{
super(source);

// Mark this message as not yet saved, to make sure that updateMessageID() will get triggered when the message
// is saved. Otherwise, JavaMail overrides the MessageID in the default MimeMessage implementation.
saved = false;
}

/**
* @param session see javadoc for {@link MimeMessage#MimeMessage(Session, InputStream)}
* @param is see javadoc for {@link MimeMessage#MimeMessage(Session, InputStream)}
* @throws MessagingException see javadoc for {@link MimeMessage#MimeMessage(Session, InputStream)}
* @since 7.1RC1
*/
public ExtendedMimeMessage(Session session, InputStream is) throws MessagingException
{
super(session, is);
}

/**
* @since 7.1RC1
*/
@Override
protected void updateMessageID() throws MessagingException
{
// Only automatically generate a random Message-ID if a custom / manual one is not already set.
if (getHeader("Message-ID") == null) {
super.updateMessageID();
}
}

/**
Expand Down
2 changes: 1 addition & 1 deletion ...m-mail-send-default/src/main/java/org/xwiki/mail/internal/FileSystemMailContentStore.java
View file
Open in desktop
Expand Up @@ -84,7 +84,7 @@ public MimeMessage load(Session session, String batchId, String messageId) throw
batchDirectory = getBatchDirectory(batchId);
File file = new File(batchDirectory, messageId);
InputStream is = new FileInputStream(file);
MimeMessage message = new MimeMessage(session, is);
MimeMessage message = new ExtendedMimeMessage(session, is);
return message;
} catch (Exception e) {
throw new MailStoreException(String.format(
Expand Down