Package org.apache.camel.component.mail

Class MailComponent

java.lang.Object
org.apache.camel.support.service.BaseService
org.apache.camel.support.service.ServiceSupport
org.apache.camel.support.DefaultComponent
org.apache.camel.support.HealthCheckComponent
org.apache.camel.component.mail.MailComponent
All Implemented Interfaces:
AutoCloseable, org.apache.camel.CamelContextAware, org.apache.camel.Component, org.apache.camel.Service, org.apache.camel.ShutdownableService, org.apache.camel.spi.HasCamelContext, org.apache.camel.spi.HeaderFilterStrategyAware, org.apache.camel.SSLContextParametersAware, org.apache.camel.StatefulService, org.apache.camel.SuspendableService
@Component("imap,imaps,pop3,pop3s,smtp,smtps") public class MailComponent extends org.apache.camel.support.HealthCheckComponent implements org.apache.camel.spi.HeaderFilterStrategyAware, org.apache.camel.SSLContextParametersAware
Component for JavaMail.

  • Field Summary

    Fields inherited from class org.apache.camel.support.service.BaseService

    BUILT, FAILED, INITIALIZED, INITIALIZING, lock, NEW, SHUTDOWN, SHUTTING_DOWN, STARTED, STARTING, status, STOPPED, STOPPING, SUSPENDED, SUSPENDING

  • Constructor Summary

    Constructors
    Constructor
    Description
    MailComponent()
     
    MailComponent(org.apache.camel.CamelContext context)
     
    MailComponent(MailConfiguration configuration)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected org.apache.camel.Endpoint
    createEndpoint(String uri, String remaining, Map<String,Object> parameters)
     
    MailConfiguration
    getConfiguration()
     
    ContentTypeResolver
    getContentTypeResolver()
     
    org.apache.camel.spi.HeaderFilterStrategy
    getHeaderFilterStrategy()
     
    boolean
    isUseGlobalSslContextParameters()
     
    void
    setConfiguration(MailConfiguration configuration)
    Sets the Mail configuration
    void
    setContentTypeResolver(ContentTypeResolver contentTypeResolver)
    Resolver to determine Content-Type for file attachments.
    void
    setEndpointHeaderFilterStrategy(org.apache.camel.Endpoint endpoint)
    Sets the header filter strategy to use from the given endpoint if the endpoint is a HeaderFilterStrategyAware type.
    void
    setHeaderFilterStrategy(org.apache.camel.spi.HeaderFilterStrategy strategy)
    To use a custom HeaderFilterStrategy to filter header to and from Camel message.
    void
    setUseGlobalSslContextParameters(boolean useGlobalSslContextParameters)
    Enable usage of global SSL context parameters.

    Methods inherited from class org.apache.camel.support.HealthCheckComponent

    isHealthCheckConsumerEnabled, isHealthCheckProducerEnabled, setHealthCheckConsumerEnabled, setHealthCheckProducerEnabled

    Methods inherited from class org.apache.camel.support.DefaultComponent

    afterConfiguration, createEndpoint, createEndpoint, doBuild, doInit, getAndRemoveOrResolveReferenceParameter, getAndRemoveOrResolveReferenceParameter, getAndRemoveParameter, getAndRemoveParameter, getCamelContext, getComponentPropertyConfigurer, getDefaultName, getEndpointPropertyConfigurer, getExtension, getSupportedExtensions, ifStartsWithReturnRemainder, isAutowiredEnabled, isBridgeErrorHandler, isLazyStartProducer, registerExtension, registerExtension, resolveAndRemoveReferenceListParameter, resolveAndRemoveReferenceListParameter, resolveAndRemoveReferenceParameter, resolveAndRemoveReferenceParameter, resolveRawParameterValues, setAutowiredEnabled, setBridgeErrorHandler, setCamelContext, setLazyStartProducer, setProperties, setProperties, setProperties, useIntrospectionOnEndpoint, useRawUri, validateParameters, validateURI

    Methods inherited from class org.apache.camel.support.service.BaseService

    build, doFail, doLifecycleChange, doResume, doShutdown, doStart, doStop, doSuspend, fail, getStatus, init, isBuild, isInit, isNew, isRunAllowed, isShutdown, isStarted, isStarting, isStartingOrStarted, isStopped, isStopping, isStoppingOrStopped, isSuspended, isSuspending, isSuspendingOrSuspended, resume, shutdown, start, stop, suspend

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.apache.camel.CamelContextAware

    setCamelContext

    Methods inherited from interface org.apache.camel.spi.HasCamelContext

    getCamelContext

    Methods inherited from interface org.apache.camel.Service

    build, close, init, start, stop

    Methods inherited from interface org.apache.camel.ShutdownableService

    shutdown

    Methods inherited from interface org.apache.camel.SSLContextParametersAware

    retrieveGlobalSslContextParameters

    Methods inherited from interface org.apache.camel.StatefulService

    getStatus, isRunAllowed, isStarted, isStarting, isStopped, isStopping, isSuspending

    Methods inherited from interface org.apache.camel.SuspendableService

    isSuspended, resume, suspend

  • Constructor Details

    • MailComponent

      public MailComponent()

    • MailComponent

      public MailComponent(MailConfiguration configuration)

    • MailComponent

      public MailComponent(org.apache.camel.CamelContext context)

  • Method Details

    • createEndpoint

      protected org.apache.camel.Endpoint createEndpoint(String uri, String remaining, Map<String,Object> parameters) throws Exception
      Specified by:
      createEndpoint in class org.apache.camel.support.DefaultComponent
      Throws:
      Exception

    • getConfiguration

      public MailConfiguration getConfiguration()

    • setConfiguration

      public void setConfiguration(MailConfiguration configuration)
      Sets the Mail configuration
      Parameters:
      configuration - the configuration to use by default for endpoints

    • getContentTypeResolver

      public ContentTypeResolver getContentTypeResolver()

    • setContentTypeResolver

      public void setContentTypeResolver(ContentTypeResolver contentTypeResolver)
      Resolver to determine Content-Type for file attachments.

    • isUseGlobalSslContextParameters

      public boolean isUseGlobalSslContextParameters()
      Specified by:
      isUseGlobalSslContextParameters in interface org.apache.camel.SSLContextParametersAware

    • setUseGlobalSslContextParameters

      public void setUseGlobalSslContextParameters(boolean useGlobalSslContextParameters)
      Enable usage of global SSL context parameters.
      Specified by:
      setUseGlobalSslContextParameters in interface org.apache.camel.SSLContextParametersAware

    • getHeaderFilterStrategy

      public org.apache.camel.spi.HeaderFilterStrategy getHeaderFilterStrategy()
      Specified by:
      getHeaderFilterStrategy in interface org.apache.camel.spi.HeaderFilterStrategyAware

    • setHeaderFilterStrategy

      public void setHeaderFilterStrategy(org.apache.camel.spi.HeaderFilterStrategy strategy)
      To use a custom HeaderFilterStrategy to filter header to and from Camel message.
      Specified by:
      setHeaderFilterStrategy in interface org.apache.camel.spi.HeaderFilterStrategyAware

    • setEndpointHeaderFilterStrategy

      public void setEndpointHeaderFilterStrategy(org.apache.camel.Endpoint endpoint)
      Sets the header filter strategy to use from the given endpoint if the endpoint is a HeaderFilterStrategyAware type.