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

      • 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: org.apache.camel.spi.ExceptionHandler type. Group: consumer (advanced)
      • 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 org.apache.camel.spi.ExceptionHandler type. Group: consumer (advanced)
      • 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: int type. Default: -1 Group: consumer (advanced)
      • 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 int type. Default: -1 Group: consumer (advanced)
      • 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 org.apache.camel.component.mail.MailUidGenerator type. Group: consumer (advanced)
      • 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: boolean type. Default: true Group: consumer (advanced)
      • 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 boolean type. Default: true Group: consumer (advanced)
      • 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: org.apache.camel.spi.PollingConsumerPollStrategy type. Group: consumer (advanced)
      • 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 org.apache.camel.spi.PollingConsumerPollStrategy type. Group: consumer (advanced)
      • postProcessAction

        default MailEndpointBuilderFactory.AdvancedMailEndpointConsumerBuilder postProcessAction​(Object postProcessAction)
        Refers to an MailBoxPostProcessAction for doing post processing tasks on the mailbox once the normal processing ended. The option is a: org.apache.camel.component.mail.MailBoxPostProcessAction type. Group: consumer (advanced)
      • 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 org.apache.camel.component.mail.MailBoxPostProcessAction type. Group: consumer (advanced)
      • 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: java.util.Properties 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
      • 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: java.util.Properties 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
      • 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: java.lang.String type. Default: CamelMailAlternativeBody Group: advanced
      • attachmentsContentTransferEncodingResolver

        default MailEndpointBuilderFactory.AdvancedMailEndpointConsumerBuilder attachmentsContentTransferEncodingResolver​(Object attachmentsContentTransferEncodingResolver)
        To use a custom AttachmentsContentTransferEncodingResolver to resolve what content-type-encoding to use for attachments. The option is a: org.apache.camel.component.mail.AttachmentsContentTransferEncodingResolver type. Group: advanced
      • 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 org.apache.camel.component.mail.AttachmentsContentTransferEncodingResolver type. Group: advanced
      • authenticator

        default MailEndpointBuilderFactory.AdvancedMailEndpointConsumerBuilder authenticator​(Object 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: org.apache.camel.component.mail.MailAuthenticator type. Group: advanced
      • 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 org.apache.camel.component.mail.MailAuthenticator type. Group: advanced
      • 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: org.apache.camel.spi.HeaderFilterStrategy type. Group: advanced
      • 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: boolean type. Default: false Group: advanced
      • 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 boolean type. Default: false Group: advanced
      • 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: boolean type. Default: false Group: advanced
      • 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 boolean type. Default: false Group: advanced
      • session

        default MailEndpointBuilderFactory.AdvancedMailEndpointConsumerBuilder session​(Object 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: javax.mail.Session type. Group: advanced
      • 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 javax.mail.Session type. Group: advanced
      • synchronous

        default MailEndpointBuilderFactory.AdvancedMailEndpointConsumerBuilder synchronous​(boolean synchronous)
        Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). The option is a: boolean type. Default: false Group: advanced