org.apache.commons.mail.EmailUtils Maven / Gradle / Ivy
Show all versions of commons-email Show documentation
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.commons.mail;
import javax.mail.internet.MimeMessage;
import javax.mail.MessagingException;
import java.util.Random;
import java.io.FileOutputStream;
import java.io.File;
import java.io.IOException;
/**
* Utility methods used by commons-email.
*
*
* These methods are copied from other commons components (commons-lang) to avoid creating
* a dependency for such a small component.
*
*
*
* This is a package scoped class, and should not be used directly by users.
*
*
* @author jakarta-commons
* @version $Id: EmailUtils.java 782475 2009-06-07 22:02:58Z sgoeschl $
*
* @since 1.0
*/
final class EmailUtils
{
/**
*
* Random object used by random method. This has to be not local to the random method
* so as to not return the same value in the same millisecond.
*
*/
private static final Random RANDOM = new Random();
/**
* Constructs a new EmailException with no detail message.
*/
private EmailUtils()
{
super();
}
/**
*
* Checks if a String is empty ("") or null.
*
*
* @param str the String to check, may be null
*
* @return true if the String is empty or null
*
* @since Commons Lang v2.1, svn 240418
*/
static boolean isEmpty(String str)
{
return (str == null) || (str.length() == 0);
}
/**
*
* Checks if a String is not empty ("") and not null.
*
*
* @param str the String to check, may be null
*
* @return true if the String is not empty and not null
*
* @since Commons Lang v2.1, svn 240418
*/
static boolean isNotEmpty(String str)
{
return (str != null) && (str.length() > 0);
}
/**
*
* Validate an argument, throwing IllegalArgumentException if the argument is null.
*
*
* @param object the object to check is not null
* @param message the exception message you would like to see if the object is null
*
* @throws IllegalArgumentException if the object is null
*
* @since Commons Lang v2.1, svn 201930
*/
static void notNull(Object object, String message)
{
if (object == null)
{
throw new IllegalArgumentException(message);
}
}
/**
*
* Creates a random string whose length is the number of characters specified.
*
*
*
* Characters will be chosen from the set of alphabetic characters.
*
*
* @param count the length of random string to create
*
* @return the random string
*
* @since Commons Lang v2.1, svn 201930
*/
static String randomAlphabetic(int count)
{
return random(count, 0, 0, true, false, null, RANDOM);
}
/**
*
* Creates a random string based on a variety of options, using supplied source of randomness.
*
*
*
* If start and end are both 0, start and end are set to ' ' and 'z',
* the ASCII printable characters, will be used, unless letters and numbers are both false,
* in which case, start and end are set to 0 and Integer.MAX_VALUE.
*
*
*
* If set is not null, characters between start and end are chosen.
*
*
*
* This method accepts a user-supplied {@link Random} instance to use as a source of randomness. By seeding a
* single {@link Random} instance with a fixed seed and using it for each call, the same random sequence of strings
* can be generated repeatedly and predictably.
*
*
* @param count the length of random string to create
* @param start the position in set of chars to start at
* @param end the position in set of chars to end before
* @param letters only allow letters?
* @param numbers only allow numbers?
* @param chars the set of chars to choose randoms from. If null,
* then it will use the set of all chars.
* @param random a source of randomness.
*
* @return the random string
*
* @throws IllegalArgumentException if count < 0.
*
* @since Commons Lang v2.1, svn 201930
*/
private static String random(
int count,
int start,
int end,
boolean letters,
boolean numbers,
char [] chars,
Random random)
{
if (count == 0)
{
return "";
}
else if (count < 0)
{
throw new IllegalArgumentException("Requested random string length " + count + " is less than 0.");
}
if ((start == 0) && (end == 0))
{
end = 'z' + 1;
start = ' ';
if (!letters && !numbers)
{
start = 0;
end = Integer.MAX_VALUE;
}
}
StringBuffer buffer = new StringBuffer();
int gap = end - start;
while (count-- != 0)
{
char ch;
if (chars == null)
{
ch = (char) (random.nextInt(gap) + start);
}
else
{
ch = chars[random.nextInt(gap) + start];
}
if ((letters && numbers && Character.isLetterOrDigit(ch)) || (letters && Character.isLetter(ch))
|| (numbers && Character.isDigit(ch)) || (!letters && !numbers))
{
buffer.append(ch);
}
else
{
count++;
}
}
return buffer.toString();
}
/**
* Convinience method to write a MimeMessage into a file.
*
* @param resultFile the file containing the MimeMessgae
* @param mimeMessage the MimeMessage to write
* @throws IOException writing the MimeMessage failed
* @throws MessagingException writing the MimeMessage failed
*/
static void writeMimeMessage(File resultFile, MimeMessage mimeMessage) throws IOException, MessagingException
{
FileOutputStream fos = null;
if (mimeMessage == null)
{
throw new IllegalArgumentException("mimeMessage is null");
}
if (resultFile == null)
{
throw new IllegalArgumentException("resulFile is null");
}
if (resultFile.getParentFile() != null)
{
resultFile.getParentFile().mkdirs();
}
try
{
fos = new FileOutputStream(resultFile);
mimeMessage.writeTo(fos);
fos.flush();
fos.close();
fos = null;
}
finally
{
if (fos != null)
{
try
{
fos.close();
fos = null;
}
catch (Exception e)
{
// ignore
}
}
}
}
}