com.icegreen.greenmail.util

Class GreenMailUtil

java.lang.Object

com.icegreen.greenmail.util.GreenMailUtil

public class GreenMailUtil
extends Object

Since:

Jan 29, 2006

Version:

$Id: $

Author:

Wael Chatila

Method Summary

Modifier and Type	Method and Description
static void	copyStream(InputStream src, OutputStream dest) Writes the content of an input stream to an output stream
static MimeMultipart	createMultipartWithAttachment(String msg, byte[] attachment, String contentType, String filename, String description) Create new multipart with a text part and an attachment
static MimeMessage	createTextEmail(String to, String from, String subject, String msg, ServerSetup setup)
static String	getAddressList(Address[] addresses)
static String	getBody(Part msg)
static byte[]	getBodyAsBytes(Part msg)
static byte[]	getHeaderAsBytes(Part part)
static String	getHeaders(Part msg)
static int	getLineCount(String str) Counts the number of lines.
static Quota[]	getQuota(GreenMailUser user, String quotaRoot) Gets the quotas for the user.
static Session	getSession(ServerSetup setup) Gets a JavaMail Session for given server type such as IMAP and additional props for JavaMail.
static Session	getSession(ServerSetup setup, Properties mailProps) Gets a JavaMail Session for given server type such as IMAP and additional props for JavaMail.
static Session	getSession(ServerSetup setup, Properties mailProps, boolean debug) Gets a JavaMail Session for given server type such as IMAP and additional props for JavaMail.
static String	getWholeMessage(Part msg)
static boolean	hasNonTextAttachments(Part m)
static GreenMailUtil	instance() Deprecated. As of 1.5 and to be removed in 1.6. No need to instantiate static helper class
static MimeMessage	newMimeMessage(InputStream inputStream) Convenience method which creates a new MimeMessage from an input stream.
static MimeMessage	newMimeMessage(String mailString) Convenience method which creates a new MimeMessage from a string
static String	random() Generates a random generated password consisting of letters and digits with a length variable between 5 and 8 characters long.
static String	random(int nbrOfLetters)
static void	sendAttachmentEmail(String to, String from, String subject, String msg, byte[] attachment, String contentType, String filename, String description, ServerSetup setup)
static void	sendMessageBody(String to, String from, String subject, Object body, String contentType, ServerSetup serverSetup) Send the message with the given attributes and the given body using the specified SMTP settings
static void	sendMimeMessage(MimeMessage mimeMessage) Send the message using the JavaMail session defined in the message
static void	sendTextEmail(String to, String from, String subject, String msg, ServerSetup setup) Sends a text message using given server setup for SMTP.
static void	sendTextEmailSecureTest(String to, String from, String subject, String msg) Sends a text message using the default test setup for SMTPS.
static void	sendTextEmailTest(String to, String from, String subject, String msg) Sends a text message using the default test setup for SMTP.
static void	setQuota(GreenMailUser user, Quota quota) Sets a quota for a users.
static String	toString(Part msg)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

instance

@Deprecated
public static GreenMailUtil instance()

Deprecated. As of 1.5 and to be removed in 1.6. No need to instantiate static helper class

copyStream

public static void copyStream(InputStream src,
                              OutputStream dest)
                       throws IOException

Writes the content of an input stream to an output stream

Throws:

IOException - on io error.

newMimeMessage

public static MimeMessage newMimeMessage(InputStream inputStream)

Convenience method which creates a new MimeMessage from an input stream.

Returns:

the created mime message.

newMimeMessage

public static MimeMessage newMimeMessage(String mailString)
                                  throws MessagingException

Convenience method which creates a new MimeMessage from a string

Throws:

MessagingException

hasNonTextAttachments

public static boolean hasNonTextAttachments(Part m)

getLineCount

public static int getLineCount(String str)

Counts the number of lines.

Parameters:

str - the input string

Returns:

Returns the number of lines terminated by '\n' in string

getBody

public static String getBody(Part msg)

Returns:

The content of an email (or a Part)

getHeaders

public static String getHeaders(Part msg)

Returns:

The headers of an email (or a Part)

getWholeMessage

public static String getWholeMessage(Part msg)

Returns:

The both header and body for an email (or a Part)

getBodyAsBytes

public static byte[] getBodyAsBytes(Part msg)

getHeaderAsBytes

public static byte[] getHeaderAsBytes(Part part)

toString

public static String toString(Part msg)

Returns:

same as getWholeMessage(javax.mail.Part) }

random

public static String random()

Generates a random generated password consisting of letters and digits with a length variable between 5 and 8 characters long. Passwords are further optimized for displays that could potentially display the characters 1,l,I,0,O,Q in a way that a human could easily mix them up.

Returns:

the random string.

random

public static String random(int nbrOfLetters)

sendTextEmailTest

public static void sendTextEmailTest(String to,
                                     String from,
                                     String subject,
                                     String msg)

Sends a text message using the default test setup for SMTP.

Parameters:

to - the to address.

from - the from address.

subject - the subject.

msg - the text message.

See Also:

ServerSetupTest.SMTP

sendTextEmailSecureTest

public static void sendTextEmailSecureTest(String to,
                                           String from,
                                           String subject,
                                           String msg)

Sends a text message using the default test setup for SMTPS.

Parameters:

to - the to address.

from - the from address.

subject - the subject.

msg - the text message.

See Also:

ServerSetupTest.SMTPS

getAddressList

public static String getAddressList(Address[] addresses)

createTextEmail

public static MimeMessage createTextEmail(String to,
                                          String from,
                                          String subject,
                                          String msg,
                                          ServerSetup setup)

sendTextEmail

public static void sendTextEmail(String to,
                                 String from,
                                 String subject,
                                 String msg,
                                 ServerSetup setup)

Sends a text message using given server setup for SMTP.

Parameters:

to - the to address.

from - the from address.

subject - the subject.

msg - the test message.

setup - the SMTP setup.

sendMimeMessage

public static void sendMimeMessage(MimeMessage mimeMessage)

Send the message using the JavaMail session defined in the message

Parameters:

mimeMessage - Message to send

sendMessageBody

public static void sendMessageBody(String to,
                                   String from,
                                   String subject,
                                   Object body,
                                   String contentType,
                                   ServerSetup serverSetup)

Send the message with the given attributes and the given body using the specified SMTP settings

Parameters:

to - Destination address(es)

from - Sender address

subject - Message subject

body - Message content. May either be a MimeMultipart or another body that java mail recognizes

contentType - MIME content type of body

serverSetup - Server settings to use for connecting to the SMTP server

sendAttachmentEmail

public static void sendAttachmentEmail(String to,
                                       String from,
                                       String subject,
                                       String msg,
                                       byte[] attachment,
                                       String contentType,
                                       String filename,
                                       String description,
                                       ServerSetup setup)

createMultipartWithAttachment

public static MimeMultipart createMultipartWithAttachment(String msg,
                                                          byte[] attachment,
                                                          String contentType,
                                                          String filename,
                                                          String description)

Create new multipart with a text part and an attachment

Parameters:

msg - Message text

attachment - Attachment data

contentType - MIME content type of body

filename - File name of the attachment

description - Description of the attachment

Returns:

New multipart

getSession

public static Session getSession(ServerSetup setup)

Gets a JavaMail Session for given server type such as IMAP and additional props for JavaMail.

Parameters:

setup - the setup type, such as ServerSetup.IMAP

Returns:

the JavaMail session.

getSession

public static Session getSession(ServerSetup setup,
                                 Properties mailProps)

Gets a JavaMail Session for given server type such as IMAP and additional props for JavaMail.

Parameters:

setup - the setup type, such as ServerSetup.IMAP

mailProps - additional mail properties.

Returns:

the JavaMail session.

getSession

public static Session getSession(ServerSetup setup,
                                 Properties mailProps,
                                 boolean debug)

Gets a JavaMail Session for given server type such as IMAP and additional props for JavaMail.

Parameters:

setup - the setup type, such as ServerSetup.IMAP

mailProps - additional mail properties.

debug - sets JavaMail debug properties.

Returns:

the JavaMail session.

setQuota

public static void setQuota(GreenMailUser user,
                            Quota quota)

Sets a quota for a users.

Parameters:

user - the user.

quota - the quota.

getQuota

public static Quota[] getQuota(GreenMailUser user,
                               String quotaRoot)

Gets the quotas for the user.

Parameters:

user - the user.

quotaRoot - the quota root, eg 'INBOX.

Returns:

array of current quotas, or an empty array if not set.