org.apache.camel.component.mail
Class MailConfiguration

java.lang.Object
  extended by org.apache.camel.component.mail.MailConfiguration
All Implemented Interfaces:
Cloneable

public class MailConfiguration
extends Object
implements Cloneable

Represents the configuration data for communicating over email

Version:
$Revision: 884755 $

Field Summary
static String DEFAULT_ALTERNATE_BODY_HEADER
           
static long DEFAULT_CONNECTION_TIMEOUT
           
static String DEFAULT_FOLDER_NAME
           
static String DEFAULT_FROM
           
 
Constructor Summary
MailConfiguration()
           
 
Method Summary
 void configure(URI uri)
           
 MailConfiguration copy()
          Returns a copy of this configuration
protected  JavaMailSenderImpl createJavaMailSender()
           
 String getAlternateBodyHeader()
           
 Authenticator getAuthenticator()
          Returns an authenticator object for use in sessions
 long getConnectionTimeout()
           
 String getContentType()
           
 String getDefaultEncoding()
           
 String getDestination()
          Deprecated. use getRecipients()
 int getFetchSize()
           
 String getFolderName()
           
 String getFrom()
           
 String getHost()
           
 Properties getJavaMailProperties()
           
 String getMailStoreLogInformation()
           
 String getPassword()
           
 int getPort()
           
 String getProtocol()
           
 Map<Message.RecipientType,String> getRecipients()
           
 Session getSession()
           
 String getUsername()
           
 boolean isDebugMode()
           
 boolean isDeleteProcessedMessages()
           
 boolean isDummyTrustManager()
           
 boolean isIgnoreUriScheme()
           
 boolean isProcessOnlyUnseenMessages()
           
 boolean isSecureProtocol()
          Is the used protocol to be secure or not
 boolean isUseInlineAttachments()
           
 void setAlternateBodyHeader(String alternateBodyHeader)
           
 void setBCC(String address)
          Sets the BCC email address.
 void setCC(String address)
          Sets the CC email address.
 void setConnectionTimeout(long connectionTimeout)
           
 void setContentType(String contentType)
           
 void setDebugMode(boolean debugMode)
           
 void setDefaultEncoding(String defaultEncoding)
           
 void setDeleteProcessedMessages(boolean deleteProcessedMessages)
           
 void setDestination(String destination)
          Deprecated. use setTo(String)
 void setDummyTrustManager(boolean dummyTrustManager)
           
 void setFetchSize(int fetchSize)
           
 void setFolderName(String folderName)
           
 void setFrom(String from)
           
 void setHost(String host)
           
 void setIgnoreUriScheme(boolean ignoreUriScheme)
           
 void setJavaMailProperties(Properties javaMailProperties)
           
 void setPassword(String password)
           
 void setPort(int port)
           
 void setProcessOnlyUnseenMessages(boolean processOnlyUnseenMessages)
           
 void setProtocol(String protocol)
           
 void setSession(Session session)
           
 void setTo(String address)
          Sets the To email address.
 void setUseInlineAttachments(boolean useInlineAttachments)
           
 void setUsername(String username)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DEFAULT_FOLDER_NAME

public static final String DEFAULT_FOLDER_NAME
See Also:
Constant Field Values

DEFAULT_FROM

public static final String DEFAULT_FROM
See Also:
Constant Field Values

DEFAULT_ALTERNATE_BODY_HEADER

public static final String DEFAULT_ALTERNATE_BODY_HEADER
See Also:
Constant Field Values

DEFAULT_CONNECTION_TIMEOUT

public static final long DEFAULT_CONNECTION_TIMEOUT
See Also:
Constant Field Values
Constructor Detail

MailConfiguration

public MailConfiguration()
Method Detail

copy

public MailConfiguration copy()
Returns a copy of this configuration


configure

public void configure(URI uri)

createJavaMailSender

protected JavaMailSenderImpl createJavaMailSender()

isSecureProtocol

public boolean isSecureProtocol()
Is the used protocol to be secure or not


getAuthenticator

public Authenticator getAuthenticator()
Returns an authenticator object for use in sessions


getMailStoreLogInformation

public String getMailStoreLogInformation()

getDefaultEncoding

public String getDefaultEncoding()

setDefaultEncoding

public void setDefaultEncoding(String defaultEncoding)

getHost

public String getHost()

setHost

public void setHost(String host)

getJavaMailProperties

public Properties getJavaMailProperties()

setJavaMailProperties

public void setJavaMailProperties(Properties javaMailProperties)

getPassword

public String getPassword()

setPassword

public void setPassword(String password)

getPort

public int getPort()

setPort

public void setPort(int port)

getProtocol

public String getProtocol()

setProtocol

public void setProtocol(String protocol)

getSession

public Session getSession()

setSession

public void setSession(Session session)

getUsername

public String getUsername()

setUsername

public void setUsername(String username)

getDestination

public String getDestination()
Deprecated. use getRecipients()

Gets the destination (recipient To email address).


setDestination

public void setDestination(String destination)
Deprecated. use setTo(String)

Sets the destination (recipient To email address).


getFrom

public String getFrom()

setFrom

public void setFrom(String from)

isDeleteProcessedMessages

public boolean isDeleteProcessedMessages()

setDeleteProcessedMessages

public void setDeleteProcessedMessages(boolean deleteProcessedMessages)

getFolderName

public String getFolderName()

setFolderName

public void setFolderName(String folderName)

isIgnoreUriScheme

public boolean isIgnoreUriScheme()

setIgnoreUriScheme

public void setIgnoreUriScheme(boolean ignoreUriScheme)

isProcessOnlyUnseenMessages

public boolean isProcessOnlyUnseenMessages()

setProcessOnlyUnseenMessages

public void setProcessOnlyUnseenMessages(boolean processOnlyUnseenMessages)

setTo

public void setTo(String address)
Sets the To email address. Separate multiple email addresses with comma.


setCC

public void setCC(String address)
Sets the CC email address. Separate multiple email addresses with comma.


setBCC

public void setBCC(String address)
Sets the BCC email address. Separate multiple email addresses with comma.


getRecipients

public Map<Message.RecipientType,String> getRecipients()

getFetchSize

public int getFetchSize()

setFetchSize

public void setFetchSize(int fetchSize)

isDebugMode

public boolean isDebugMode()

setDebugMode

public void setDebugMode(boolean debugMode)

getConnectionTimeout

public long getConnectionTimeout()

setConnectionTimeout

public void setConnectionTimeout(long connectionTimeout)

isDummyTrustManager

public boolean isDummyTrustManager()

setDummyTrustManager

public void setDummyTrustManager(boolean dummyTrustManager)

getContentType

public String getContentType()

setContentType

public void setContentType(String contentType)

getAlternateBodyHeader

public String getAlternateBodyHeader()

setAlternateBodyHeader

public void setAlternateBodyHeader(String alternateBodyHeader)

isUseInlineAttachments

public boolean isUseInlineAttachments()

setUseInlineAttachments

public void setUseInlineAttachments(boolean useInlineAttachments)


Apache CAMEL