Package org.apache.camel.builder.endpoint.dsl

Interface MailEndpointBuilderFactory.AdvancedMailEndpointConsumerBuilder

  • All Superinterfaces:
    org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver
    All Known Subinterfaces:
    MailEndpointBuilderFactory.AdvancedMailEndpointBuilder
    Enclosing interface:
    MailEndpointBuilderFactory
    public static interface MailEndpointBuilderFactory.AdvancedMailEndpointConsumerBuilder
extends org.apache.camel.builder.EndpointConsumerBuilder
    Advanced builder for endpoint consumers for the IMAP component.

    • Method Detail

      • bridgeErrorHandler

        default MailEndpointBuilderFactory.AdvancedMailEndpointConsumerBuilder bridgeErrorHandler​(boolean bridgeErrorHandler)
        Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option is a: <code>boolean</code> type. Default: false Group: consumer (advanced)
        Parameters:
        bridgeErrorHandler - the value to set
        Returns:
        the dsl builder

      • bridgeErrorHandler

        default MailEndpointBuilderFactory.AdvancedMailEndpointConsumerBuilder bridgeErrorHandler​(String bridgeErrorHandler)
        Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer (advanced)
        Parameters:
        bridgeErrorHandler - the value to set
        Returns:
        the dsl builder

      • exceptionHandler

        default MailEndpointBuilderFactory.AdvancedMailEndpointConsumerBuilder exceptionHandler​(org.apache.camel.spi.ExceptionHandler exceptionHandler)
        To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option is a: <code>org.apache.camel.spi.ExceptionHandler</code> type. Group: consumer (advanced)
        Parameters:
        exceptionHandler - the value to set
        Returns:
        the dsl builder

      • exceptionHandler

        default MailEndpointBuilderFactory.AdvancedMailEndpointConsumerBuilder exceptionHandler​(String exceptionHandler)
        To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option will be converted to a <code>org.apache.camel.spi.ExceptionHandler</code> type. Group: consumer (advanced)
        Parameters:
        exceptionHandler - the value to set
        Returns:
        the dsl builder

      • exchangePattern

        default MailEndpointBuilderFactory.AdvancedMailEndpointConsumerBuilder exchangePattern​(org.apache.camel.ExchangePattern exchangePattern)
        Sets the exchange pattern when the consumer creates an exchange. The option is a: <code>org.apache.camel.ExchangePattern</code> type. Group: consumer (advanced)
        Parameters:
        exchangePattern - the value to set
        Returns:
        the dsl builder

      • exchangePattern

        default MailEndpointBuilderFactory.AdvancedMailEndpointConsumerBuilder exchangePattern​(String exchangePattern)
        Sets the exchange pattern when the consumer creates an exchange. The option will be converted to a <code>org.apache.camel.ExchangePattern</code> type. Group: consumer (advanced)
        Parameters:
        exchangePattern - the value to set
        Returns:
        the dsl builder

      • fetchSize

        default MailEndpointBuilderFactory.AdvancedMailEndpointConsumerBuilder fetchSize​(int fetchSize)
        Sets the maximum number of messages to consume during a poll. This can be used to avoid overloading a mail server, if a mailbox folder contains a lot of messages. Default value of -1 means no fetch size and all messages will be consumed. Setting the value to 0 is a special corner case, where Camel will not consume any messages at all. The option is a: <code>int</code> type. Default: -1 Group: consumer (advanced)
        Parameters:
        fetchSize - the value to set
        Returns:
        the dsl builder

      • fetchSize

        default MailEndpointBuilderFactory.AdvancedMailEndpointConsumerBuilder fetchSize​(String fetchSize)
        Sets the maximum number of messages to consume during a poll. This can be used to avoid overloading a mail server, if a mailbox folder contains a lot of messages. Default value of -1 means no fetch size and all messages will be consumed. Setting the value to 0 is a special corner case, where Camel will not consume any messages at all. The option will be converted to a <code>int</code> type. Default: -1 Group: consumer (advanced)
        Parameters:
        fetchSize - the value to set
        Returns:
        the dsl builder

      • mailUidGenerator

        default MailEndpointBuilderFactory.AdvancedMailEndpointConsumerBuilder mailUidGenerator​(org.apache.camel.component.mail.MailUidGenerator mailUidGenerator)
        A pluggable MailUidGenerator that allows to use custom logic to generate UUID of the mail message. The option is a: <code>org.apache.camel.component.mail.MailUidGenerator</code> type. Group: consumer (advanced)
        Parameters:
        mailUidGenerator - the value to set
        Returns:
        the dsl builder

      • mailUidGenerator

        default MailEndpointBuilderFactory.AdvancedMailEndpointConsumerBuilder mailUidGenerator​(String mailUidGenerator)
        A pluggable MailUidGenerator that allows to use custom logic to generate UUID of the mail message. The option will be converted to a <code>org.apache.camel.component.mail.MailUidGenerator</code> type. Group: consumer (advanced)
        Parameters:
        mailUidGenerator - the value to set
        Returns:
        the dsl builder

      • mapMailMessage

        default MailEndpointBuilderFactory.AdvancedMailEndpointConsumerBuilder mapMailMessage​(boolean mapMailMessage)
        Specifies whether Camel should map the received mail message to Camel body/headers/attachments. If set to true, the body of the mail message is mapped to the body of the Camel IN message, the mail headers are mapped to IN headers, and the attachments to Camel IN attachment message. If this option is set to false then the IN message contains a raw javax.mail.Message. You can retrieve this raw message by calling exchange.getIn().getBody(javax.mail.Message.class). The option is a: <code>boolean</code> type. Default: true Group: consumer (advanced)
        Parameters:
        mapMailMessage - the value to set
        Returns:
        the dsl builder

      • mapMailMessage

        default MailEndpointBuilderFactory.AdvancedMailEndpointConsumerBuilder mapMailMessage​(String mapMailMessage)
        Specifies whether Camel should map the received mail message to Camel body/headers/attachments. If set to true, the body of the mail message is mapped to the body of the Camel IN message, the mail headers are mapped to IN headers, and the attachments to Camel IN attachment message. If this option is set to false then the IN message contains a raw javax.mail.Message. You can retrieve this raw message by calling exchange.getIn().getBody(javax.mail.Message.class). The option will be converted to a <code>boolean</code> type. Default: true Group: consumer (advanced)
        Parameters:
        mapMailMessage - the value to set
        Returns:
        the dsl builder

      • pollStrategy

        default MailEndpointBuilderFactory.AdvancedMailEndpointConsumerBuilder pollStrategy​(org.apache.camel.spi.PollingConsumerPollStrategy pollStrategy)
        A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. The option is a: <code>org.apache.camel.spi.PollingConsumerPollStrategy</code> type. Group: consumer (advanced)
        Parameters:
        pollStrategy - the value to set
        Returns:
        the dsl builder

      • pollStrategy

        default MailEndpointBuilderFactory.AdvancedMailEndpointConsumerBuilder pollStrategy​(String pollStrategy)
        A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. The option will be converted to a <code>org.apache.camel.spi.PollingConsumerPollStrategy</code> type. Group: consumer (advanced)
        Parameters:
        pollStrategy - the value to set
        Returns:
        the dsl builder

      • postProcessAction

        default MailEndpointBuilderFactory.AdvancedMailEndpointConsumerBuilder postProcessAction​(org.apache.camel.component.mail.MailBoxPostProcessAction postProcessAction)
        Refers to an MailBoxPostProcessAction for doing post processing tasks on the mailbox once the normal processing ended. The option is a: <code>org.apache.camel.component.mail.MailBoxPostProcessAction</code> type. Group: consumer (advanced)
        Parameters:
        postProcessAction - the value to set
        Returns:
        the dsl builder

      • postProcessAction

        default MailEndpointBuilderFactory.AdvancedMailEndpointConsumerBuilder postProcessAction​(String postProcessAction)
        Refers to an MailBoxPostProcessAction for doing post processing tasks on the mailbox once the normal processing ended. The option will be converted to a <code>org.apache.camel.component.mail.MailBoxPostProcessAction</code> type. Group: consumer (advanced)
        Parameters:
        postProcessAction - the value to set
        Returns:
        the dsl builder

      • additionalJavaMailProperties

        default MailEndpointBuilderFactory.AdvancedMailEndpointConsumerBuilder additionalJavaMailProperties​(String key,
                                                                                                    Object value)
        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. The option is a: <code>java.util.Properties</code> type. The option is multivalued, and you can use the additionalJavaMailProperties(String, Object) method to add a value (call the method multiple times to set more values). Group: advanced
        Parameters:
        key - the option key
        value - the option value
        Returns:
        the dsl builder

      • additionalJavaMailProperties

        default MailEndpointBuilderFactory.AdvancedMailEndpointConsumerBuilder additionalJavaMailProperties​(Map values)
        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. The option is a: <code>java.util.Properties</code> type. The option is multivalued, and you can use the additionalJavaMailProperties(String, Object) method to add a value (call the method multiple times to set more values). Group: advanced
        Parameters:
        values - the values
        Returns:
        the dsl builder

      • alternativeBodyHeader

        default MailEndpointBuilderFactory.AdvancedMailEndpointConsumerBuilder alternativeBodyHeader​(String alternativeBodyHeader)
        Specifies the key to an IN message header that contains an alternative email body. For example, if you send emails in text/html format and want to provide an alternative mail body for non-HTML email clients, set the alternative mail body with this key as a header. The option is a: <code>java.lang.String</code> type. Default: CamelMailAlternativeBody Group: advanced
        Parameters:
        alternativeBodyHeader - the value to set
        Returns:
        the dsl builder

      • attachmentsContentTransferEncodingResolver

        default MailEndpointBuilderFactory.AdvancedMailEndpointConsumerBuilder attachmentsContentTransferEncodingResolver​(org.apache.camel.component.mail.AttachmentsContentTransferEncodingResolver attachmentsContentTransferEncodingResolver)
        To use a custom AttachmentsContentTransferEncodingResolver to resolve what content-type-encoding to use for attachments. The option is a: <code>org.apache.camel.component.mail.AttachmentsContentTransferEncodingResolver</code> type. Group: advanced
        Parameters:
        attachmentsContentTransferEncodingResolver - the value to set
        Returns:
        the dsl builder

      • attachmentsContentTransferEncodingResolver

        default MailEndpointBuilderFactory.AdvancedMailEndpointConsumerBuilder attachmentsContentTransferEncodingResolver​(String attachmentsContentTransferEncodingResolver)
        To use a custom AttachmentsContentTransferEncodingResolver to resolve what content-type-encoding to use for attachments. The option will be converted to a <code>org.apache.camel.component.mail.AttachmentsContentTransferEncodingResolver</code> type. Group: advanced
        Parameters:
        attachmentsContentTransferEncodingResolver - the value to set
        Returns:
        the dsl builder

      • authenticator

        default MailEndpointBuilderFactory.AdvancedMailEndpointConsumerBuilder authenticator​(org.apache.camel.component.mail.MailAuthenticator authenticator)
        The authenticator for login. If set then the password and username are ignored. Can be used for tokens which can expire and therefore must be read dynamically. The option is a: <code>org.apache.camel.component.mail.MailAuthenticator</code> type. Group: advanced
        Parameters:
        authenticator - the value to set
        Returns:
        the dsl builder

      • authenticator

        default MailEndpointBuilderFactory.AdvancedMailEndpointConsumerBuilder authenticator​(String authenticator)
        The authenticator for login. If set then the password and username are ignored. Can be used for tokens which can expire and therefore must be read dynamically. The option will be converted to a <code>org.apache.camel.component.mail.MailAuthenticator</code> type. Group: advanced
        Parameters:
        authenticator - the value to set
        Returns:
        the dsl builder

      • binding

        default MailEndpointBuilderFactory.AdvancedMailEndpointConsumerBuilder binding​(org.apache.camel.component.mail.MailBinding binding)
        Sets the binding used to convert from a Camel message to and from a Mail message. The option is a: <code>org.apache.camel.component.mail.MailBinding</code> type. Group: advanced
        Parameters:
        binding - the value to set
        Returns:
        the dsl builder

      • binding

        default MailEndpointBuilderFactory.AdvancedMailEndpointConsumerBuilder binding​(String binding)
        Sets the binding used to convert from a Camel message to and from a Mail message. The option will be converted to a <code>org.apache.camel.component.mail.MailBinding</code> type. Group: advanced
        Parameters:
        binding - the value to set
        Returns:
        the dsl builder

      • connectionTimeout

        default MailEndpointBuilderFactory.AdvancedMailEndpointConsumerBuilder connectionTimeout​(int connectionTimeout)
        The connection timeout in milliseconds. The option is a: <code>int</code> type. Default: 30000 Group: advanced
        Parameters:
        connectionTimeout - the value to set
        Returns:
        the dsl builder

      • connectionTimeout

        default MailEndpointBuilderFactory.AdvancedMailEndpointConsumerBuilder connectionTimeout​(String connectionTimeout)
        The connection timeout in milliseconds. The option will be converted to a <code>int</code> type. Default: 30000 Group: advanced
        Parameters:
        connectionTimeout - the value to set
        Returns:
        the dsl builder

      • contentType

        default MailEndpointBuilderFactory.AdvancedMailEndpointConsumerBuilder contentType​(String contentType)
        The mail message content type. Use text/html for HTML mails. The option is a: <code>java.lang.String</code> type. Default: text/plain Group: advanced
        Parameters:
        contentType - the value to set
        Returns:
        the dsl builder

      • contentTypeResolver

        default MailEndpointBuilderFactory.AdvancedMailEndpointConsumerBuilder contentTypeResolver​(org.apache.camel.component.mail.ContentTypeResolver contentTypeResolver)
        Resolver to determine Content-Type for file attachments. The option is a: <code>org.apache.camel.component.mail.ContentTypeResolver</code> type. Group: advanced
        Parameters:
        contentTypeResolver - the value to set
        Returns:
        the dsl builder

      • contentTypeResolver

        default MailEndpointBuilderFactory.AdvancedMailEndpointConsumerBuilder contentTypeResolver​(String contentTypeResolver)
        Resolver to determine Content-Type for file attachments. The option will be converted to a <code>org.apache.camel.component.mail.ContentTypeResolver</code> type. Group: advanced
        Parameters:
        contentTypeResolver - the value to set
        Returns:
        the dsl builder

      • debugMode

        default MailEndpointBuilderFactory.AdvancedMailEndpointConsumerBuilder debugMode​(boolean debugMode)
        Enable debug mode on the underlying mail framework. The SUN Mail framework logs the debug messages to System.out by default. The option is a: <code>boolean</code> type. Default: false Group: advanced
        Parameters:
        debugMode - the value to set
        Returns:
        the dsl builder

      • debugMode

        default MailEndpointBuilderFactory.AdvancedMailEndpointConsumerBuilder debugMode​(String debugMode)
        Enable debug mode on the underlying mail framework. The SUN Mail framework logs the debug messages to System.out by default. The option will be converted to a <code>boolean</code> type. Default: false Group: advanced
        Parameters:
        debugMode - the value to set
        Returns:
        the dsl builder

      • headerFilterStrategy

        default MailEndpointBuilderFactory.AdvancedMailEndpointConsumerBuilder headerFilterStrategy​(org.apache.camel.spi.HeaderFilterStrategy headerFilterStrategy)
        To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter headers. The option is a: <code>org.apache.camel.spi.HeaderFilterStrategy</code> type. Group: advanced
        Parameters:
        headerFilterStrategy - the value to set
        Returns:
        the dsl builder

      • headerFilterStrategy

        default MailEndpointBuilderFactory.AdvancedMailEndpointConsumerBuilder headerFilterStrategy​(String headerFilterStrategy)
        To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter headers. The option will be converted to a <code>org.apache.camel.spi.HeaderFilterStrategy</code> type. Group: advanced
        Parameters:
        headerFilterStrategy - the value to set
        Returns:
        the dsl builder

      • ignoreUnsupportedCharset

        default MailEndpointBuilderFactory.AdvancedMailEndpointConsumerBuilder ignoreUnsupportedCharset​(boolean ignoreUnsupportedCharset)
        Option to let Camel ignore unsupported charset in the local JVM when sending mails. If the charset is unsupported then charset=XXX (where XXX represents the unsupported charset) is removed from the content-type and it relies on the platform default instead. The option is a: <code>boolean</code> type. Default: false Group: advanced
        Parameters:
        ignoreUnsupportedCharset - the value to set
        Returns:
        the dsl builder

      • ignoreUnsupportedCharset

        default MailEndpointBuilderFactory.AdvancedMailEndpointConsumerBuilder ignoreUnsupportedCharset​(String ignoreUnsupportedCharset)
        Option to let Camel ignore unsupported charset in the local JVM when sending mails. If the charset is unsupported then charset=XXX (where XXX represents the unsupported charset) is removed from the content-type and it relies on the platform default instead. The option will be converted to a <code>boolean</code> type. Default: false Group: advanced
        Parameters:
        ignoreUnsupportedCharset - the value to set
        Returns:
        the dsl builder

      • ignoreUriScheme

        default MailEndpointBuilderFactory.AdvancedMailEndpointConsumerBuilder ignoreUriScheme​(boolean ignoreUriScheme)
        Option to let Camel ignore unsupported charset in the local JVM when sending mails. If the charset is unsupported then charset=XXX (where XXX represents the unsupported charset) is removed from the content-type and it relies on the platform default instead. The option is a: <code>boolean</code> type. Default: false Group: advanced
        Parameters:
        ignoreUriScheme - the value to set
        Returns:
        the dsl builder

      • ignoreUriScheme

        default MailEndpointBuilderFactory.AdvancedMailEndpointConsumerBuilder ignoreUriScheme​(String ignoreUriScheme)
        Option to let Camel ignore unsupported charset in the local JVM when sending mails. If the charset is unsupported then charset=XXX (where XXX represents the unsupported charset) is removed from the content-type and it relies on the platform default instead. The option will be converted to a <code>boolean</code> type. Default: false Group: advanced
        Parameters:
        ignoreUriScheme - the value to set
        Returns:
        the dsl builder

      • javaMailProperties

        default MailEndpointBuilderFactory.AdvancedMailEndpointConsumerBuilder javaMailProperties​(Properties javaMailProperties)
        Sets the java mail options. Will clear any default properties and only use the properties provided for this method. The option is a: <code>java.util.Properties</code> type. Group: advanced
        Parameters:
        javaMailProperties - the value to set
        Returns:
        the dsl builder

      • javaMailProperties

        default MailEndpointBuilderFactory.AdvancedMailEndpointConsumerBuilder javaMailProperties​(String javaMailProperties)
        Sets the java mail options. Will clear any default properties and only use the properties provided for this method. The option will be converted to a <code>java.util.Properties</code> type. Group: advanced
        Parameters:
        javaMailProperties - the value to set
        Returns:
        the dsl builder

      • session

        default MailEndpointBuilderFactory.AdvancedMailEndpointConsumerBuilder session​(javax.mail.Session session)
        Specifies the mail session that camel should use for all mail interactions. Useful in scenarios where mail sessions are created and managed by some other resource, such as a JavaEE container. When using a custom mail session, then the hostname and port from the mail session will be used (if configured on the session). The option is a: <code>javax.mail.Session</code> type. Group: advanced
        Parameters:
        session - the value to set
        Returns:
        the dsl builder

      • session

        default MailEndpointBuilderFactory.AdvancedMailEndpointConsumerBuilder session​(String session)
        Specifies the mail session that camel should use for all mail interactions. Useful in scenarios where mail sessions are created and managed by some other resource, such as a JavaEE container. When using a custom mail session, then the hostname and port from the mail session will be used (if configured on the session). The option will be converted to a <code>javax.mail.Session</code> type. Group: advanced
        Parameters:
        session - the value to set
        Returns:
        the dsl builder

      • useInlineAttachments

        default MailEndpointBuilderFactory.AdvancedMailEndpointConsumerBuilder useInlineAttachments​(boolean useInlineAttachments)
        Whether to use disposition inline or attachment. The option is a: <code>boolean</code> type. Default: false Group: advanced
        Parameters:
        useInlineAttachments - the value to set
        Returns:
        the dsl builder

      • useInlineAttachments

        default MailEndpointBuilderFactory.AdvancedMailEndpointConsumerBuilder useInlineAttachments​(String useInlineAttachments)
        Whether to use disposition inline or attachment. The option will be converted to a <code>boolean</code> type. Default: false Group: advanced
        Parameters:
        useInlineAttachments - the value to set
        Returns:
        the dsl builder