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: 951265 $

Constructor Summary
MailConfiguration()
           
 
Method Summary
 void configure(URI uri)
           
 MailConfiguration copy()
          Returns a copy of this configuration
protected  JavaMailSenderImpl createJavaMailSender()
           
 Properties getAdditionalJavaMailProperties()
           
 String getAlternativeBodyHeader()
           
 Authenticator getAuthenticator()
          Returns an authenticator object for use in sessions
 long getConnectionTimeout()
           
 String getContentType()
           
 String getDefaultEncoding()
           
 int getFetchSize()
           
 String getFolderName()
           
 String getFrom()
           
 String getHost()
           
 Properties getJavaMailProperties()
           
 JavaMailSender getJavaMailSender()
           
 String getMailStoreLogInformation()
           
 String getPassword()
           
 int getPort()
           
 String getProtocol()
           
 Map<Message.RecipientType,String> getRecipients()
           
 Session getSession()
           
 String getSubject()
           
 String getUsername()
           
 boolean isDebugMode()
           
 boolean isDelete()
           
 boolean isDummyTrustManager()
           
 boolean isIgnoreUnsupportedCharset()
           
 boolean isIgnoreUriScheme()
           
 boolean isSecureProtocol()
          Is the used protocol to be secure or not
 boolean isUnseen()
           
 boolean isUseInlineAttachments()
           
 void setAdditionalJavaMailProperties(Properties additionalJavaMailProperties)
          Sets additional java mail properties, that will append/override any default properties that is set based on all the other options.
 void setAlternativeBodyHeader(String alternativeBodyHeader)
           
 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 setDelete(boolean delete)
           
 void setDummyTrustManager(boolean dummyTrustManager)
           
 void setFetchSize(int fetchSize)
           
 void setFolderName(String folderName)
           
 void setFrom(String from)
           
 void setHost(String host)
           
 void setIgnoreUnsupportedCharset(boolean ignoreUnsupportedCharset)
           
 void setIgnoreUriScheme(boolean ignoreUriScheme)
           
 void setJavaMailProperties(Properties javaMailProperties)
          Sets the java mail options.
 void setJavaMailSender(JavaMailSender javaMailSender)
           
 void setPassword(String password)
           
 void setPort(int port)
           
 void setProtocol(String protocol)
           
 void setSession(Session session)
           
 void setSubject(String subject)
           
 void setTo(String address)
          Sets the To email address.
 void setUnseen(boolean unseen)
           
 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
 

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()

getJavaMailSender

public JavaMailSender getJavaMailSender()

setJavaMailSender

public void setJavaMailSender(JavaMailSender javaMailSender)

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)
Sets the java mail options. Will clear any default properties and only use the properties provided for this method.


getAdditionalJavaMailProperties

public Properties getAdditionalJavaMailProperties()

setAdditionalJavaMailProperties

public void setAdditionalJavaMailProperties(Properties additionalJavaMailProperties)
Sets additional java mail properties, that will append/override any default properties that is set based on all the other options. This is useful if you need to add some special options but want to keep the others as is.


getPassword

public String getPassword()

setPassword

public void setPassword(String password)

getSubject

public String getSubject()

setSubject

public void setSubject(String subject)

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)

getFrom

public String getFrom()

setFrom

public void setFrom(String from)

isDelete

public boolean isDelete()

setDelete

public void setDelete(boolean delete)

getFolderName

public String getFolderName()

setFolderName

public void setFolderName(String folderName)

isIgnoreUriScheme

public boolean isIgnoreUriScheme()

setIgnoreUriScheme

public void setIgnoreUriScheme(boolean ignoreUriScheme)

isUnseen

public boolean isUnseen()

setUnseen

public void setUnseen(boolean unseen)

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)

getAlternativeBodyHeader

public String getAlternativeBodyHeader()

setAlternativeBodyHeader

public void setAlternativeBodyHeader(String alternativeBodyHeader)

isUseInlineAttachments

public boolean isUseInlineAttachments()

setUseInlineAttachments

public void setUseInlineAttachments(boolean useInlineAttachments)

isIgnoreUnsupportedCharset

public boolean isIgnoreUnsupportedCharset()

setIgnoreUnsupportedCharset

public void setIgnoreUnsupportedCharset(boolean ignoreUnsupportedCharset)


Apache CAMEL