BaseEmailTestCase (Commons Email 1.3.1 Test API)

java.lang.Object
- junit.framework.Assert
- - junit.framework.TestCase
  - - org.apache.commons.mail.BaseEmailTestCase

All Implemented Interfaces:

junit.framework.Test

Direct Known Subclasses:

EmailAttachmentTest, EmailLiveTest, EmailTest, HtmlEmailTest, InvalidAddressTest, InvalidInternetAddressTest, MultiPartEmailTest, SendWithAttachmentsTest, SimpleEmailTest
```
public abstract class BaseEmailTestCase
extends junit.framework.TestCase
```
Base test case for Email test classes

Since:

1.0

Version:

$Id: BaseEmailTestCase.java 1429506 2013-01-06 12:33:56Z tn $

Author:

Corey Scott, Eric Pugh

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`BODY_END_PAD` Padding at end of body added by wiser/send
`static int`	`BODY_START_PAD` Padding at start of body added by wiser/send
`protected org.subethamail.wiser.Wiser`	`fakeMailServer` The fake Wiser email server
`protected String`	`strTestMailFrom` From address for the test email
`protected String`	`strTestMailServer` Mail server used for testing
`protected String`	`strTestMailTo` Destination address for the test email
`protected String`	`strTestPasswd` Mailserver strTestPasswd (set if needed)
`protected String`	`strTestURL` URL to used to test URL attachmetns (Must be valid)
`protected String`	`strTestUser` Mailserver username (set if needed)
`protected String[]`	`testCharsNotValid` Array of test strings
`protected String[]`	`testCharsValid` Test characters acceptable to email

Constructor Summary

Constructors
Constructor and Description

BaseEmailTestCase(String name)

Constructors
Constructor and Description
`BaseEmailTestCase(String name)`

Method Summary

Methods
Modifier and Type	Method and Description
`protected URL`	`createInvalidURL()` Create a mocked URL object which always throws an IOException when the openStream() method is called.
`void`	`getMailServer()` Initializes the stub mail server.
`protected int`	`getMailServerPort()` Gets the mail server port.
`String`	`getMessageAsString(int intMsgNo)`
`protected boolean`	`isMailServerStopped(org.subethamail.wiser.Wiser fakeMailServer)` Checks if an email server is running at the address stored in the `fakeMailServer`.
`protected void`	`saveEmailToFile(org.subethamail.wiser.WiserMessage email)` Safe a mail to a file using a more or less unique file name.
`protected void`	`tearDown()`
`protected org.subethamail.wiser.WiserMessage`	`validateSend(org.subethamail.wiser.Wiser mailServer, String strSubject, InternetAddress fromAdd, List<InternetAddress> toAdd, List<InternetAddress> ccAdd, List<InternetAddress> bccAdd, boolean boolSaveToFile)` Validate the message was sent properly
`protected void`	`validateSend(org.subethamail.wiser.Wiser mailServer, String strSubject, Multipart content, InternetAddress fromAdd, List<InternetAddress> toAdd, List<InternetAddress> ccAdd, List<InternetAddress> bccAdd, boolean boolSaveToFile)` Validate the message was sent properly
`protected void`	`validateSend(org.subethamail.wiser.Wiser mailServer, String strSubject, String strMessage, InternetAddress fromAdd, List<InternetAddress> toAdd, List<InternetAddress> ccAdd, List<InternetAddress> bccAdd, boolean boolSaveToFile)` Validate the message was sent properly

Methods inherited from class junit.framework.TestCase
assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertFalse, assertFalse, assertNotNull, assertNotNull, assertNotSame, assertNotSame, assertNull, assertNull, assertSame, assertSame, assertTrue, assertTrue, countTestCases, createResult, fail, fail, failNotEquals, failNotSame, failSame, format, getName, run, run, runBare, runTest, setName, setUp, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - BODY_END_PAD
```
public static final int BODY_END_PAD
```
    Padding at end of body added by wiser/send
    
    See Also:
    Constant Field Values
  - BODY_START_PAD
```
public static final int BODY_START_PAD
```
    Padding at start of body added by wiser/send
    
    See Also:
    Constant Field Values
  - fakeMailServer
```
protected org.subethamail.wiser.Wiser fakeMailServer
```
    The fake Wiser email server
  - strTestMailServer
```
protected String strTestMailServer
```
    Mail server used for testing
  - strTestMailFrom
```
protected String strTestMailFrom
```
    From address for the test email
  - strTestMailTo
```
protected String strTestMailTo
```
    Destination address for the test email
  - strTestUser
```
protected String strTestUser
```
    Mailserver username (set if needed)
  - strTestPasswd
```
protected String strTestPasswd
```
    Mailserver strTestPasswd (set if needed)
  - strTestURL
```
protected String strTestURL
```
    URL to used to test URL attachmetns (Must be valid)
  - testCharsValid
```
protected String[] testCharsValid
```
    Test characters acceptable to email
  - testCharsNotValid
```
protected String[] testCharsNotValid
```
    Array of test strings
- Constructor Detail
  - BaseEmailTestCase
```
public BaseEmailTestCase(String name)
```
    Parameters:
    name - name
- Method Detail
  - tearDown
```
protected void tearDown()
```
    Overrides:
    
    tearDown in class junit.framework.TestCase
  - getMailServerPort
```
protected int getMailServerPort()
```
    Gets the mail server port.
    
    Returns:
    the port the server is running on.
  - saveEmailToFile
```
protected void saveEmailToFile(org.subethamail.wiser.WiserMessage email)
                        throws IOException,
                               MessagingException
```
    Safe a mail to a file using a more or less unique file name.
    
    Parameters:
    email - email
    
    Throws:
    
    IOException - writing the email failed
    
    MessagingException - writing the email failed
  - getMessageAsString
```
public String getMessageAsString(int intMsgNo)
```
    Parameters:
    intMsgNo - the message to retrieve
    
    Returns:
    message as string
  - getMailServer
```
public void getMailServer()
```
    Initializes the stub mail server. Fails if the server cannot be proven to have started. If the server is already started, this method returns without changing the state of the server.
  - validateSend
```
protected org.subethamail.wiser.WiserMessage validateSend(org.subethamail.wiser.Wiser mailServer,
                                              String strSubject,
                                              InternetAddress fromAdd,
                                              List<InternetAddress> toAdd,
                                              List<InternetAddress> ccAdd,
                                              List<InternetAddress> bccAdd,
                                              boolean boolSaveToFile)
                                                   throws IOException
```
    Validate the message was sent properly
    
    Parameters:
    mailServer - reference to the fake mail server
    strSubject - expected subject
    fromAdd - expected from address
    toAdd - list of expected to addresses
    ccAdd - list of expected cc addresses
    bccAdd - list of expected bcc addresses
    boolSaveToFile - true will output to file, false doesnt
    
    Returns:
    WiserMessage email to check
    
    Throws:
    
    IOException - Exception
  - validateSend
```
protected void validateSend(org.subethamail.wiser.Wiser mailServer,
                String strSubject,
                Multipart content,
                InternetAddress fromAdd,
                List<InternetAddress> toAdd,
                List<InternetAddress> ccAdd,
                List<InternetAddress> bccAdd,
                boolean boolSaveToFile)
                     throws IOException
```
    Validate the message was sent properly
    
    Parameters:
    mailServer - reference to the fake mail server
    strSubject - expected subject
    content - the expected message content
    fromAdd - expected from address
    toAdd - list of expected to addresses
    ccAdd - list of expected cc addresses
    bccAdd - list of expected bcc addresses
    boolSaveToFile - true will output to file, false doesnt
    
    Throws:
    
    IOException - Exception
  - validateSend
```
protected void validateSend(org.subethamail.wiser.Wiser mailServer,
                String strSubject,
                String strMessage,
                InternetAddress fromAdd,
                List<InternetAddress> toAdd,
                List<InternetAddress> ccAdd,
                List<InternetAddress> bccAdd,
                boolean boolSaveToFile)
                     throws IOException
```
    Validate the message was sent properly
    
    Parameters:
    mailServer - reference to the fake mail server
    strSubject - expected subject
    strMessage - the expected message as a string
    fromAdd - expected from address
    toAdd - list of expected to addresses
    ccAdd - list of expected cc addresses
    bccAdd - list of expected bcc addresses
    boolSaveToFile - true will output to file, false doesnt
    
    Throws:
    
    IOException - Exception
  - isMailServerStopped
```
protected boolean isMailServerStopped(org.subethamail.wiser.Wiser fakeMailServer)
```
    Checks if an email server is running at the address stored in the fakeMailServer.
    
    Parameters:
    fakeMailServer - The server from which the address is picked up.
    
    Returns:
    true if the server claims to be running
    Since:
    
    1.1
  - createInvalidURL
```
protected URL createInvalidURL()
                        throws Exception
```
    Create a mocked URL object which always throws an IOException when the openStream() method is called.
    Several ISPs do resolve invalid URLs like http://example.invalid to some error page causing tests to fail otherwise.
    
    Returns:
    an invalid URL
    
    Throws:
    
    Exception

Class BaseEmailTestCase

Field Summary

Constructor Summary

Method Summary

Methods inherited from class junit.framework.TestCase

Methods inherited from class java.lang.Object

Field Detail

BODY_END_PAD

BODY_START_PAD

fakeMailServer

strTestMailServer

strTestMailFrom

strTestMailTo

strTestUser

strTestPasswd

strTestURL

testCharsValid

testCharsNotValid

Constructor Detail

BaseEmailTestCase

Method Detail

tearDown

getMailServerPort

saveEmailToFile

getMessageAsString

getMailServer

validateSend

validateSend

validateSend

isMailServerStopped

createInvalidURL