MailEndpointBuilderFactory.MailEndpointConsumerBuilder (Camel

All Superinterfaces:

org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver

All Known Subinterfaces:

MailEndpointBuilderFactory.MailEndpointBuilder

Enclosing interface:

MailEndpointBuilderFactory
```
public static interface MailEndpointBuilderFactory.MailEndpointConsumerBuilder
extends org.apache.camel.builder.EndpointConsumerBuilder
```
Builder for endpoint consumers for the IMAP component.

Method Summary

All Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`default MailEndpointBuilderFactory.AdvancedMailEndpointConsumerBuilder`	`advanced()`
`default MailEndpointBuilderFactory.MailEndpointConsumerBuilder`	`backoffErrorThreshold(int backoffErrorThreshold)` The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.
`default MailEndpointBuilderFactory.MailEndpointConsumerBuilder`	`backoffErrorThreshold(String backoffErrorThreshold)` The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.
`default MailEndpointBuilderFactory.MailEndpointConsumerBuilder`	`backoffIdleThreshold(int backoffIdleThreshold)` The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
`default MailEndpointBuilderFactory.MailEndpointConsumerBuilder`	`backoffIdleThreshold(String backoffIdleThreshold)` The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.
`default MailEndpointBuilderFactory.MailEndpointConsumerBuilder`	`backoffMultiplier(int backoffMultiplier)` To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row.
`default MailEndpointBuilderFactory.MailEndpointConsumerBuilder`	`backoffMultiplier(String backoffMultiplier)` To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row.
`default MailEndpointBuilderFactory.MailEndpointConsumerBuilder`	`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.
`default MailEndpointBuilderFactory.MailEndpointConsumerBuilder`	`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.
`default MailEndpointBuilderFactory.MailEndpointConsumerBuilder`	`closeFolder(boolean closeFolder)` Whether the consumer should close the folder after polling.
`default MailEndpointBuilderFactory.MailEndpointConsumerBuilder`	`closeFolder(String closeFolder)` Whether the consumer should close the folder after polling.
`default MailEndpointBuilderFactory.MailEndpointConsumerBuilder`	`copyTo(String copyTo)` After processing a mail message, it can be copied to a mail folder with the given name.
`default MailEndpointBuilderFactory.MailEndpointConsumerBuilder`	`decodeFilename(boolean decodeFilename)` If set to true, the MimeUtility.decodeText method will be used to decode the filename.
`default MailEndpointBuilderFactory.MailEndpointConsumerBuilder`	`decodeFilename(String decodeFilename)` If set to true, the MimeUtility.decodeText method will be used to decode the filename.
`default MailEndpointBuilderFactory.MailEndpointConsumerBuilder`	`delay(long delay)` Milliseconds before the next poll.
`default MailEndpointBuilderFactory.MailEndpointConsumerBuilder`	`delay(String delay)` Milliseconds before the next poll.
`default MailEndpointBuilderFactory.MailEndpointConsumerBuilder`	`delete(boolean delete)` Deletes the messages after they have been processed.
`default MailEndpointBuilderFactory.MailEndpointConsumerBuilder`	`delete(String delete)` Deletes the messages after they have been processed.
`default MailEndpointBuilderFactory.MailEndpointConsumerBuilder`	`disconnect(boolean disconnect)` Whether the consumer should disconnect after polling.
`default MailEndpointBuilderFactory.MailEndpointConsumerBuilder`	`disconnect(String disconnect)` Whether the consumer should disconnect after polling.
`default MailEndpointBuilderFactory.MailEndpointConsumerBuilder`	`greedy(boolean greedy)` If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.
`default MailEndpointBuilderFactory.MailEndpointConsumerBuilder`	`greedy(String greedy)` If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.
`default MailEndpointBuilderFactory.MailEndpointConsumerBuilder`	`handleFailedMessage(boolean handleFailedMessage)` If the mail consumer cannot retrieve a given mail message, then this option allows to handle the caused exception by the consumer's error handler.
`default MailEndpointBuilderFactory.MailEndpointConsumerBuilder`	`handleFailedMessage(String handleFailedMessage)` If the mail consumer cannot retrieve a given mail message, then this option allows to handle the caused exception by the consumer's error handler.
`default MailEndpointBuilderFactory.MailEndpointConsumerBuilder`	`idempotentRepository(org.apache.camel.spi.IdempotentRepository idempotentRepository)` A pluggable repository org.apache.camel.spi.IdempotentRepository which allows to cluster consuming from the same mailbox, and let the repository coordinate whether a mail message is valid for the consumer to process.
`default MailEndpointBuilderFactory.MailEndpointConsumerBuilder`	`idempotentRepository(String idempotentRepository)` A pluggable repository org.apache.camel.spi.IdempotentRepository which allows to cluster consuming from the same mailbox, and let the repository coordinate whether a mail message is valid for the consumer to process.
`default MailEndpointBuilderFactory.MailEndpointConsumerBuilder`	`idempotentRepositoryRemoveOnCommit(boolean idempotentRepositoryRemoveOnCommit)` When using idempotent repository, then when the mail message has been successfully processed and is committed, should the message id be removed from the idempotent repository (default) or be kept in the repository.
`default MailEndpointBuilderFactory.MailEndpointConsumerBuilder`	`idempotentRepositoryRemoveOnCommit(String idempotentRepositoryRemoveOnCommit)` When using idempotent repository, then when the mail message has been successfully processed and is committed, should the message id be removed from the idempotent repository (default) or be kept in the repository.
`default MailEndpointBuilderFactory.MailEndpointConsumerBuilder`	`initialDelay(long initialDelay)` Milliseconds before the first poll starts.
`default MailEndpointBuilderFactory.MailEndpointConsumerBuilder`	`initialDelay(String initialDelay)` Milliseconds before the first poll starts.
`default MailEndpointBuilderFactory.MailEndpointConsumerBuilder`	`maxMessagesPerPoll(int maxMessagesPerPoll)` Specifies the maximum number of messages to gather per poll.
`default MailEndpointBuilderFactory.MailEndpointConsumerBuilder`	`maxMessagesPerPoll(String maxMessagesPerPoll)` Specifies the maximum number of messages to gather per poll.
`default MailEndpointBuilderFactory.MailEndpointConsumerBuilder`	`mimeDecodeHeaders(boolean mimeDecodeHeaders)` This option enables transparent MIME decoding and unfolding for mail headers.
`default MailEndpointBuilderFactory.MailEndpointConsumerBuilder`	`mimeDecodeHeaders(String mimeDecodeHeaders)` This option enables transparent MIME decoding and unfolding for mail headers.
`default MailEndpointBuilderFactory.MailEndpointConsumerBuilder`	`moveTo(String moveTo)` After processing a mail message, it can be moved to a mail folder with the given name.
`default MailEndpointBuilderFactory.MailEndpointConsumerBuilder`	`password(String password)` The password for login.
`default MailEndpointBuilderFactory.MailEndpointConsumerBuilder`	`peek(boolean peek)` Will mark the javax.mail.Message as peeked before processing the mail message.
`default MailEndpointBuilderFactory.MailEndpointConsumerBuilder`	`peek(String peek)` Will mark the javax.mail.Message as peeked before processing the mail message.
`default MailEndpointBuilderFactory.MailEndpointConsumerBuilder`	`repeatCount(long repeatCount)` Specifies a maximum limit of number of fires.
`default MailEndpointBuilderFactory.MailEndpointConsumerBuilder`	`repeatCount(String repeatCount)` Specifies a maximum limit of number of fires.
`default MailEndpointBuilderFactory.MailEndpointConsumerBuilder`	`runLoggingLevel(org.apache.camel.LoggingLevel runLoggingLevel)` The consumer logs a start/complete log line when it polls.
`default MailEndpointBuilderFactory.MailEndpointConsumerBuilder`	`runLoggingLevel(String runLoggingLevel)` The consumer logs a start/complete log line when it polls.
`default MailEndpointBuilderFactory.MailEndpointConsumerBuilder`	`scheduledExecutorService(ScheduledExecutorService scheduledExecutorService)` Allows for configuring a custom/shared thread pool to use for the consumer.
`default MailEndpointBuilderFactory.MailEndpointConsumerBuilder`	`scheduledExecutorService(String scheduledExecutorService)` Allows for configuring a custom/shared thread pool to use for the consumer.
`default MailEndpointBuilderFactory.MailEndpointConsumerBuilder`	`scheduler(Object scheduler)` To use a cron scheduler from either camel-spring or camel-quartz component.
`default MailEndpointBuilderFactory.MailEndpointConsumerBuilder`	`scheduler(String scheduler)` To use a cron scheduler from either camel-spring or camel-quartz component.
`default MailEndpointBuilderFactory.MailEndpointConsumerBuilder`	`schedulerProperties(Map values)` To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.
`default MailEndpointBuilderFactory.MailEndpointConsumerBuilder`	`schedulerProperties(String key, Object value)` To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.
`default MailEndpointBuilderFactory.MailEndpointConsumerBuilder`	`searchTerm(Map values)` Refers to a javax.mail.search.SearchTerm which allows to filter mails based on search criteria such as subject, body, from, sent after a certain date etc.
`default MailEndpointBuilderFactory.MailEndpointConsumerBuilder`	`searchTerm(String key, Object value)` Refers to a javax.mail.search.SearchTerm which allows to filter mails based on search criteria such as subject, body, from, sent after a certain date etc.
`default MailEndpointBuilderFactory.MailEndpointConsumerBuilder`	`sendEmptyMessageWhenIdle(boolean sendEmptyMessageWhenIdle)` If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead.
`default MailEndpointBuilderFactory.MailEndpointConsumerBuilder`	`sendEmptyMessageWhenIdle(String sendEmptyMessageWhenIdle)` If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead.
`default MailEndpointBuilderFactory.MailEndpointConsumerBuilder`	`skipFailedMessage(boolean skipFailedMessage)` If the mail consumer cannot retrieve a given mail message, then this option allows to skip the message and move on to retrieve the next mail message.
`default MailEndpointBuilderFactory.MailEndpointConsumerBuilder`	`skipFailedMessage(String skipFailedMessage)` If the mail consumer cannot retrieve a given mail message, then this option allows to skip the message and move on to retrieve the next mail message.
`default MailEndpointBuilderFactory.MailEndpointConsumerBuilder`	`sortTerm(Object[] sortTerm)` Sorting order for messages.
`default MailEndpointBuilderFactory.MailEndpointConsumerBuilder`	`sortTerm(String sortTerm)` Sorting order for messages.
`default MailEndpointBuilderFactory.MailEndpointConsumerBuilder`	`sslContextParameters(Object sslContextParameters)` To configure security using SSLContextParameters.
`default MailEndpointBuilderFactory.MailEndpointConsumerBuilder`	`sslContextParameters(String sslContextParameters)` To configure security using SSLContextParameters.
`default MailEndpointBuilderFactory.MailEndpointConsumerBuilder`	`startScheduler(boolean startScheduler)` Whether the scheduler should be auto started.
`default MailEndpointBuilderFactory.MailEndpointConsumerBuilder`	`startScheduler(String startScheduler)` Whether the scheduler should be auto started.
`default MailEndpointBuilderFactory.MailEndpointConsumerBuilder`	`timeUnit(String timeUnit)` Time unit for initialDelay and delay options.
`default MailEndpointBuilderFactory.MailEndpointConsumerBuilder`	`timeUnit(TimeUnit timeUnit)` Time unit for initialDelay and delay options.
`default MailEndpointBuilderFactory.MailEndpointConsumerBuilder`	`unseen(boolean unseen)` Whether to limit by unseen mails only.
`default MailEndpointBuilderFactory.MailEndpointConsumerBuilder`	`unseen(String unseen)` Whether to limit by unseen mails only.
`default MailEndpointBuilderFactory.MailEndpointConsumerBuilder`	`useFixedDelay(boolean useFixedDelay)` Controls if fixed delay or fixed rate is used.
`default MailEndpointBuilderFactory.MailEndpointConsumerBuilder`	`useFixedDelay(String useFixedDelay)` Controls if fixed delay or fixed rate is used.
`default MailEndpointBuilderFactory.MailEndpointConsumerBuilder`	`username(String username)` The username for login.

Methods inherited from interface org.apache.camel.builder.EndpointConsumerBuilder
doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getUri

Methods inherited from interface org.apache.camel.EndpointConsumerResolver
resolve, resolve

- Method Detail
  - advanced
```
default MailEndpointBuilderFactory.AdvancedMailEndpointConsumerBuilder advanced()
```
  - bridgeErrorHandler
```
default MailEndpointBuilderFactory.MailEndpointConsumerBuilder 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
    
    Parameters:
    
    bridgeErrorHandler - the value to set
    
    Returns:
    
    the dsl builder
  - bridgeErrorHandler
```
default MailEndpointBuilderFactory.MailEndpointConsumerBuilder 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
    
    Parameters:
    
    bridgeErrorHandler - the value to set
    
    Returns:
    
    the dsl builder
  - closeFolder
```
default MailEndpointBuilderFactory.MailEndpointConsumerBuilder closeFolder(boolean closeFolder)
```
    Whether the consumer should close the folder after polling. Setting this option to false and having disconnect=false as well, then the consumer keep the folder open between polls. The option is a: <code>boolean</code> type. Default: true Group: consumer
    
    Parameters:
    
    closeFolder - the value to set
    
    Returns:
    
    the dsl builder
  - closeFolder
```
default MailEndpointBuilderFactory.MailEndpointConsumerBuilder closeFolder(String closeFolder)
```
    Whether the consumer should close the folder after polling. Setting this option to false and having disconnect=false as well, then the consumer keep the folder open between polls. The option will be converted to a <code>boolean</code> type. Default: true Group: consumer
    
    Parameters:
    
    closeFolder - the value to set
    
    Returns:
    
    the dsl builder
  - copyTo
```
default MailEndpointBuilderFactory.MailEndpointConsumerBuilder copyTo(String copyTo)
```
    After processing a mail message, it can be copied to a mail folder with the given name. You can override this configuration value, with a header with the key copyTo, allowing you to copy messages to folder names configured at runtime. The option is a: <code>java.lang.String</code> type. Group: consumer
    
    Parameters:
    
    copyTo - the value to set
    
    Returns:
    
    the dsl builder
  - decodeFilename
```
default MailEndpointBuilderFactory.MailEndpointConsumerBuilder decodeFilename(boolean decodeFilename)
```
    If set to true, the MimeUtility.decodeText method will be used to decode the filename. This is similar to setting JVM system property mail.mime.encodefilename. The option is a: <code>boolean</code> type. Default: false Group: consumer
    
    Parameters:
    
    decodeFilename - the value to set
    
    Returns:
    
    the dsl builder
  - decodeFilename
```
default MailEndpointBuilderFactory.MailEndpointConsumerBuilder decodeFilename(String decodeFilename)
```
    If set to true, the MimeUtility.decodeText method will be used to decode the filename. This is similar to setting JVM system property mail.mime.encodefilename. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer
    
    Parameters:
    
    decodeFilename - the value to set
    
    Returns:
    
    the dsl builder
  - delete
```
default MailEndpointBuilderFactory.MailEndpointConsumerBuilder delete(boolean delete)
```
    Deletes the messages after they have been processed. This is done by setting the DELETED flag on the mail message. If false, the SEEN flag is set instead. As of Camel 2.10 you can override this configuration option by setting a header with the key delete to determine if the mail should be deleted or not. The option is a: <code>boolean</code> type. Default: false Group: consumer
    
    Parameters:
    
    delete - the value to set
    
    Returns:
    
    the dsl builder
  - delete
```
default MailEndpointBuilderFactory.MailEndpointConsumerBuilder delete(String delete)
```
    Deletes the messages after they have been processed. This is done by setting the DELETED flag on the mail message. If false, the SEEN flag is set instead. As of Camel 2.10 you can override this configuration option by setting a header with the key delete to determine if the mail should be deleted or not. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer
    
    Parameters:
    
    delete - the value to set
    
    Returns:
    
    the dsl builder
  - disconnect
```
default MailEndpointBuilderFactory.MailEndpointConsumerBuilder disconnect(boolean disconnect)
```
    Whether the consumer should disconnect after polling. If enabled this forces Camel to connect on each poll. The option is a: <code>boolean</code> type. Default: false Group: consumer
    
    Parameters:
    
    disconnect - the value to set
    
    Returns:
    
    the dsl builder
  - disconnect
```
default MailEndpointBuilderFactory.MailEndpointConsumerBuilder disconnect(String disconnect)
```
    Whether the consumer should disconnect after polling. If enabled this forces Camel to connect on each poll. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer
    
    Parameters:
    
    disconnect - the value to set
    
    Returns:
    
    the dsl builder
  - handleFailedMessage
```
default MailEndpointBuilderFactory.MailEndpointConsumerBuilder handleFailedMessage(boolean handleFailedMessage)
```
    If the mail consumer cannot retrieve a given mail message, then this option allows to handle the caused exception by the consumer's error handler. By enable the bridge error handler on the consumer, then the Camel routing error handler can handle the exception instead. The default behavior would be the consumer throws an exception and no mails from the batch would be able to be routed by Camel. The option is a: <code>boolean</code> type. Default: false Group: consumer
    
    Parameters:
    
    handleFailedMessage - the value to set
    
    Returns:
    
    the dsl builder
  - handleFailedMessage
```
default MailEndpointBuilderFactory.MailEndpointConsumerBuilder handleFailedMessage(String handleFailedMessage)
```
    If the mail consumer cannot retrieve a given mail message, then this option allows to handle the caused exception by the consumer's error handler. By enable the bridge error handler on the consumer, then the Camel routing error handler can handle the exception instead. The default behavior would be the consumer throws an exception and no mails from the batch would be able to be routed by Camel. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer
    
    Parameters:
    
    handleFailedMessage - the value to set
    
    Returns:
    
    the dsl builder
  - maxMessagesPerPoll
```
default MailEndpointBuilderFactory.MailEndpointConsumerBuilder maxMessagesPerPoll(int maxMessagesPerPoll)
```
    Specifies the maximum number of messages to gather per poll. By default, no maximum is set. Can be used to set a limit of e.g. 1000 to avoid downloading thousands of files when the server starts up. Set a value of 0 or negative to disable this option. The option is a: <code>int</code> type. Group: consumer
    
    Parameters:
    
    maxMessagesPerPoll - the value to set
    
    Returns:
    
    the dsl builder
  - maxMessagesPerPoll
```
default MailEndpointBuilderFactory.MailEndpointConsumerBuilder maxMessagesPerPoll(String maxMessagesPerPoll)
```
    Specifies the maximum number of messages to gather per poll. By default, no maximum is set. Can be used to set a limit of e.g. 1000 to avoid downloading thousands of files when the server starts up. Set a value of 0 or negative to disable this option. The option will be converted to a <code>int</code> type. Group: consumer
    
    Parameters:
    
    maxMessagesPerPoll - the value to set
    
    Returns:
    
    the dsl builder
  - mimeDecodeHeaders
```
default MailEndpointBuilderFactory.MailEndpointConsumerBuilder mimeDecodeHeaders(boolean mimeDecodeHeaders)
```
    This option enables transparent MIME decoding and unfolding for mail headers. The option is a: <code>boolean</code> type. Default: false Group: consumer
    
    Parameters:
    
    mimeDecodeHeaders - the value to set
    
    Returns:
    
    the dsl builder
  - mimeDecodeHeaders
```
default MailEndpointBuilderFactory.MailEndpointConsumerBuilder mimeDecodeHeaders(String mimeDecodeHeaders)
```
    This option enables transparent MIME decoding and unfolding for mail headers. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer
    
    Parameters:
    
    mimeDecodeHeaders - the value to set
    
    Returns:
    
    the dsl builder
  - moveTo
```
default MailEndpointBuilderFactory.MailEndpointConsumerBuilder moveTo(String moveTo)
```
    After processing a mail message, it can be moved to a mail folder with the given name. You can override this configuration value, with a header with the key moveTo, allowing you to move messages to folder names configured at runtime. The option is a: <code>java.lang.String</code> type. Group: consumer
    
    Parameters:
    
    moveTo - the value to set
    
    Returns:
    
    the dsl builder
  - peek
```
default MailEndpointBuilderFactory.MailEndpointConsumerBuilder peek(boolean peek)
```
    Will mark the javax.mail.Message as peeked before processing the mail message. This applies to IMAPMessage messages types only. By using peek the mail will not be eager marked as SEEN on the mail server, which allows us to rollback the mail message if there is an error processing in Camel. The option is a: <code>boolean</code> type. Default: true Group: consumer
    
    Parameters:
    
    peek - the value to set
    
    Returns:
    
    the dsl builder
  - peek
```
default MailEndpointBuilderFactory.MailEndpointConsumerBuilder peek(String peek)
```
    Will mark the javax.mail.Message as peeked before processing the mail message. This applies to IMAPMessage messages types only. By using peek the mail will not be eager marked as SEEN on the mail server, which allows us to rollback the mail message if there is an error processing in Camel. The option will be converted to a <code>boolean</code> type. Default: true Group: consumer
    
    Parameters:
    
    peek - the value to set
    
    Returns:
    
    the dsl builder
  - sendEmptyMessageWhenIdle
```
default MailEndpointBuilderFactory.MailEndpointConsumerBuilder sendEmptyMessageWhenIdle(boolean sendEmptyMessageWhenIdle)
```
    If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead. The option is a: <code>boolean</code> type. Default: false Group: consumer
    
    Parameters:
    
    sendEmptyMessageWhenIdle - the value to set
    
    Returns:
    
    the dsl builder
  - sendEmptyMessageWhenIdle
```
default MailEndpointBuilderFactory.MailEndpointConsumerBuilder sendEmptyMessageWhenIdle(String sendEmptyMessageWhenIdle)
```
    If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer
    
    Parameters:
    
    sendEmptyMessageWhenIdle - the value to set
    
    Returns:
    
    the dsl builder
  - skipFailedMessage
```
default MailEndpointBuilderFactory.MailEndpointConsumerBuilder skipFailedMessage(boolean skipFailedMessage)
```
    If the mail consumer cannot retrieve a given mail message, then this option allows to skip the message and move on to retrieve the next mail message. The default behavior would be the consumer throws an exception and no mails from the batch would be able to be routed by Camel. The option is a: <code>boolean</code> type. Default: false Group: consumer
    
    Parameters:
    
    skipFailedMessage - the value to set
    
    Returns:
    
    the dsl builder
  - skipFailedMessage
```
default MailEndpointBuilderFactory.MailEndpointConsumerBuilder skipFailedMessage(String skipFailedMessage)
```
    If the mail consumer cannot retrieve a given mail message, then this option allows to skip the message and move on to retrieve the next mail message. The default behavior would be the consumer throws an exception and no mails from the batch would be able to be routed by Camel. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer
    
    Parameters:
    
    skipFailedMessage - the value to set
    
    Returns:
    
    the dsl builder
  - unseen
```
default MailEndpointBuilderFactory.MailEndpointConsumerBuilder unseen(boolean unseen)
```
    Whether to limit by unseen mails only. The option is a: <code>boolean</code> type. Default: true Group: consumer
    
    Parameters:
    
    unseen - the value to set
    
    Returns:
    
    the dsl builder
  - unseen
```
default MailEndpointBuilderFactory.MailEndpointConsumerBuilder unseen(String unseen)
```
    Whether to limit by unseen mails only. The option will be converted to a <code>boolean</code> type. Default: true Group: consumer
    
    Parameters:
    
    unseen - the value to set
    
    Returns:
    
    the dsl builder
  - idempotentRepository
```
default MailEndpointBuilderFactory.MailEndpointConsumerBuilder idempotentRepository(org.apache.camel.spi.IdempotentRepository idempotentRepository)
```
    A pluggable repository org.apache.camel.spi.IdempotentRepository which allows to cluster consuming from the same mailbox, and let the repository coordinate whether a mail message is valid for the consumer to process. By default no repository is in use. The option is a: <code>org.apache.camel.spi.IdempotentRepository</code> type. Group: filter
    
    Parameters:
    
    idempotentRepository - the value to set
    
    Returns:
    
    the dsl builder
  - idempotentRepository
```
default MailEndpointBuilderFactory.MailEndpointConsumerBuilder idempotentRepository(String idempotentRepository)
```
    A pluggable repository org.apache.camel.spi.IdempotentRepository which allows to cluster consuming from the same mailbox, and let the repository coordinate whether a mail message is valid for the consumer to process. By default no repository is in use. The option will be converted to a <code>org.apache.camel.spi.IdempotentRepository</code> type. Group: filter
    
    Parameters:
    
    idempotentRepository - the value to set
    
    Returns:
    
    the dsl builder
  - idempotentRepositoryRemoveOnCommit
```
default MailEndpointBuilderFactory.MailEndpointConsumerBuilder idempotentRepositoryRemoveOnCommit(boolean idempotentRepositoryRemoveOnCommit)
```
    When using idempotent repository, then when the mail message has been successfully processed and is committed, should the message id be removed from the idempotent repository (default) or be kept in the repository. By default its assumed the message id is unique and has no value to be kept in the repository, because the mail message will be marked as seen/moved or deleted to prevent it from being consumed again. And therefore having the message id stored in the idempotent repository has little value. However this option allows to store the message id, for whatever reason you may have. The option is a: <code>boolean</code> type. Default: true Group: filter
    
    Parameters:
    
    idempotentRepositoryRemoveOnCommit - the value to set
    
    Returns:
    
    the dsl builder
  - idempotentRepositoryRemoveOnCommit
```
default MailEndpointBuilderFactory.MailEndpointConsumerBuilder idempotentRepositoryRemoveOnCommit(String idempotentRepositoryRemoveOnCommit)
```
    When using idempotent repository, then when the mail message has been successfully processed and is committed, should the message id be removed from the idempotent repository (default) or be kept in the repository. By default its assumed the message id is unique and has no value to be kept in the repository, because the mail message will be marked as seen/moved or deleted to prevent it from being consumed again. And therefore having the message id stored in the idempotent repository has little value. However this option allows to store the message id, for whatever reason you may have. The option will be converted to a <code>boolean</code> type. Default: true Group: filter
    
    Parameters:
    
    idempotentRepositoryRemoveOnCommit - the value to set
    
    Returns:
    
    the dsl builder
  - searchTerm
```
default MailEndpointBuilderFactory.MailEndpointConsumerBuilder searchTerm(String key,
                                                                          Object value)
```
    Refers to a javax.mail.search.SearchTerm which allows to filter mails based on search criteria such as subject, body, from, sent after a certain date etc. The option is a: <code>javax.mail.search.SearchTerm</code> type. The option is multivalued, and you can use the searchTerm(String, Object) method to add a value (call the method multiple times to set more values). Group: filter
    
    Parameters:
    
    key - the option key
    
    value - the option value
    
    Returns:
    
    the dsl builder
  - searchTerm
```
default MailEndpointBuilderFactory.MailEndpointConsumerBuilder searchTerm(Map values)
```
    Refers to a javax.mail.search.SearchTerm which allows to filter mails based on search criteria such as subject, body, from, sent after a certain date etc. The option is a: <code>javax.mail.search.SearchTerm</code> type. The option is multivalued, and you can use the searchTerm(String, Object) method to add a value (call the method multiple times to set more values). Group: filter
    
    Parameters:
    
    values - the values
    
    Returns:
    
    the dsl builder
  - backoffErrorThreshold
```
default MailEndpointBuilderFactory.MailEndpointConsumerBuilder backoffErrorThreshold(int backoffErrorThreshold)
```
    The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. The option is a: <code>int</code> type. Group: scheduler
    
    Parameters:
    
    backoffErrorThreshold - the value to set
    
    Returns:
    
    the dsl builder
  - backoffErrorThreshold
```
default MailEndpointBuilderFactory.MailEndpointConsumerBuilder backoffErrorThreshold(String backoffErrorThreshold)
```
    The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. The option will be converted to a <code>int</code> type. Group: scheduler
    
    Parameters:
    
    backoffErrorThreshold - the value to set
    
    Returns:
    
    the dsl builder
  - backoffIdleThreshold
```
default MailEndpointBuilderFactory.MailEndpointConsumerBuilder backoffIdleThreshold(int backoffIdleThreshold)
```
    The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. The option is a: <code>int</code> type. Group: scheduler
    
    Parameters:
    
    backoffIdleThreshold - the value to set
    
    Returns:
    
    the dsl builder
  - backoffIdleThreshold
```
default MailEndpointBuilderFactory.MailEndpointConsumerBuilder backoffIdleThreshold(String backoffIdleThreshold)
```
    The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. The option will be converted to a <code>int</code> type. Group: scheduler
    
    Parameters:
    
    backoffIdleThreshold - the value to set
    
    Returns:
    
    the dsl builder
  - backoffMultiplier
```
default MailEndpointBuilderFactory.MailEndpointConsumerBuilder backoffMultiplier(int backoffMultiplier)
```
    To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. The option is a: <code>int</code> type. Group: scheduler
    
    Parameters:
    
    backoffMultiplier - the value to set
    
    Returns:
    
    the dsl builder
  - backoffMultiplier
```
default MailEndpointBuilderFactory.MailEndpointConsumerBuilder backoffMultiplier(String backoffMultiplier)
```
    To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. The option will be converted to a <code>int</code> type. Group: scheduler
    
    Parameters:
    
    backoffMultiplier - the value to set
    
    Returns:
    
    the dsl builder
  - delay
```
default MailEndpointBuilderFactory.MailEndpointConsumerBuilder delay(long delay)
```
    Milliseconds before the next poll. The option is a: <code>long</code> type. Default: 60000 Group: scheduler
    
    Parameters:
    
    delay - the value to set
    
    Returns:
    
    the dsl builder
  - delay
```
default MailEndpointBuilderFactory.MailEndpointConsumerBuilder delay(String delay)
```
    Milliseconds before the next poll. The option will be converted to a <code>long</code> type. Default: 60000 Group: scheduler
    
    Parameters:
    
    delay - the value to set
    
    Returns:
    
    the dsl builder
  - greedy
```
default MailEndpointBuilderFactory.MailEndpointConsumerBuilder greedy(boolean greedy)
```
    If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages. The option is a: <code>boolean</code> type. Default: false Group: scheduler
    
    Parameters:
    
    greedy - the value to set
    
    Returns:
    
    the dsl builder
  - greedy
```
default MailEndpointBuilderFactory.MailEndpointConsumerBuilder greedy(String greedy)
```
    If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages. The option will be converted to a <code>boolean</code> type. Default: false Group: scheduler
    
    Parameters:
    
    greedy - the value to set
    
    Returns:
    
    the dsl builder
  - initialDelay
```
default MailEndpointBuilderFactory.MailEndpointConsumerBuilder initialDelay(long initialDelay)
```
    Milliseconds before the first poll starts. The option is a: <code>long</code> type. Default: 1000 Group: scheduler
    
    Parameters:
    
    initialDelay - the value to set
    
    Returns:
    
    the dsl builder
  - initialDelay
```
default MailEndpointBuilderFactory.MailEndpointConsumerBuilder initialDelay(String initialDelay)
```
    Milliseconds before the first poll starts. The option will be converted to a <code>long</code> type. Default: 1000 Group: scheduler
    
    Parameters:
    
    initialDelay - the value to set
    
    Returns:
    
    the dsl builder
  - repeatCount
```
default MailEndpointBuilderFactory.MailEndpointConsumerBuilder repeatCount(long repeatCount)
```
    Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever. The option is a: <code>long</code> type. Default: 0 Group: scheduler
    
    Parameters:
    
    repeatCount - the value to set
    
    Returns:
    
    the dsl builder
  - repeatCount
```
default MailEndpointBuilderFactory.MailEndpointConsumerBuilder repeatCount(String repeatCount)
```
    Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever. The option will be converted to a <code>long</code> type. Default: 0 Group: scheduler
    
    Parameters:
    
    repeatCount - the value to set
    
    Returns:
    
    the dsl builder
  - runLoggingLevel
```
default MailEndpointBuilderFactory.MailEndpointConsumerBuilder runLoggingLevel(org.apache.camel.LoggingLevel runLoggingLevel)
```
    The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. The option is a: <code>org.apache.camel.LoggingLevel</code> type. Default: TRACE Group: scheduler
    
    Parameters:
    
    runLoggingLevel - the value to set
    
    Returns:
    
    the dsl builder
  - runLoggingLevel
```
default MailEndpointBuilderFactory.MailEndpointConsumerBuilder runLoggingLevel(String runLoggingLevel)
```
    The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. The option will be converted to a <code>org.apache.camel.LoggingLevel</code> type. Default: TRACE Group: scheduler
    
    Parameters:
    
    runLoggingLevel - the value to set
    
    Returns:
    
    the dsl builder
  - scheduledExecutorService
```
default MailEndpointBuilderFactory.MailEndpointConsumerBuilder scheduledExecutorService(ScheduledExecutorService scheduledExecutorService)
```
    Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. The option is a: <code>java.util.concurrent.ScheduledExecutorService</code> type. Group: scheduler
    
    Parameters:
    
    scheduledExecutorService - the value to set
    
    Returns:
    
    the dsl builder
  - scheduledExecutorService
```
default MailEndpointBuilderFactory.MailEndpointConsumerBuilder scheduledExecutorService(String scheduledExecutorService)
```
    Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. The option will be converted to a <code>java.util.concurrent.ScheduledExecutorService</code> type. Group: scheduler
    
    Parameters:
    
    scheduledExecutorService - the value to set
    
    Returns:
    
    the dsl builder
  - scheduler
```
default MailEndpointBuilderFactory.MailEndpointConsumerBuilder scheduler(Object scheduler)
```
    To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler. The option is a: <code>java.lang.Object</code> type. Default: none Group: scheduler
    
    Parameters:
    
    scheduler - the value to set
    
    Returns:
    
    the dsl builder
  - scheduler
```
default MailEndpointBuilderFactory.MailEndpointConsumerBuilder scheduler(String scheduler)
```
    To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler. The option will be converted to a <code>java.lang.Object</code> type. Default: none Group: scheduler
    
    Parameters:
    
    scheduler - the value to set
    
    Returns:
    
    the dsl builder
  - schedulerProperties
```
default MailEndpointBuilderFactory.MailEndpointConsumerBuilder schedulerProperties(String key,
                                                                                   Object value)
```
    To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler. The option is a: <code>java.util.Map<java.lang.String, java.lang.Object></code> type. The option is multivalued, and you can use the schedulerProperties(String, Object) method to add a value (call the method multiple times to set more values). Group: scheduler
    
    Parameters:
    
    key - the option key
    
    value - the option value
    
    Returns:
    
    the dsl builder
  - schedulerProperties
```
default MailEndpointBuilderFactory.MailEndpointConsumerBuilder schedulerProperties(Map values)
```
    To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler. The option is a: <code>java.util.Map<java.lang.String, java.lang.Object></code> type. The option is multivalued, and you can use the schedulerProperties(String, Object) method to add a value (call the method multiple times to set more values). Group: scheduler
    
    Parameters:
    
    values - the values
    
    Returns:
    
    the dsl builder
  - startScheduler
```
default MailEndpointBuilderFactory.MailEndpointConsumerBuilder startScheduler(boolean startScheduler)
```
    Whether the scheduler should be auto started. The option is a: <code>boolean</code> type. Default: true Group: scheduler
    
    Parameters:
    
    startScheduler - the value to set
    
    Returns:
    
    the dsl builder
  - startScheduler
```
default MailEndpointBuilderFactory.MailEndpointConsumerBuilder startScheduler(String startScheduler)
```
    Whether the scheduler should be auto started. The option will be converted to a <code>boolean</code> type. Default: true Group: scheduler
    
    Parameters:
    
    startScheduler - the value to set
    
    Returns:
    
    the dsl builder
  - timeUnit
```
default MailEndpointBuilderFactory.MailEndpointConsumerBuilder timeUnit(TimeUnit timeUnit)
```
    Time unit for initialDelay and delay options. The option is a: <code>java.util.concurrent.TimeUnit</code> type. Default: MILLISECONDS Group: scheduler
    
    Parameters:
    
    timeUnit - the value to set
    
    Returns:
    
    the dsl builder
  - timeUnit
```
default MailEndpointBuilderFactory.MailEndpointConsumerBuilder timeUnit(String timeUnit)
```
    Time unit for initialDelay and delay options. The option will be converted to a <code>java.util.concurrent.TimeUnit</code> type. Default: MILLISECONDS Group: scheduler
    
    Parameters:
    
    timeUnit - the value to set
    
    Returns:
    
    the dsl builder
  - useFixedDelay
```
default MailEndpointBuilderFactory.MailEndpointConsumerBuilder useFixedDelay(boolean useFixedDelay)
```
    Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. The option is a: <code>boolean</code> type. Default: true Group: scheduler
    
    Parameters:
    
    useFixedDelay - the value to set
    
    Returns:
    
    the dsl builder
  - useFixedDelay
```
default MailEndpointBuilderFactory.MailEndpointConsumerBuilder useFixedDelay(String useFixedDelay)
```
    Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. The option will be converted to a <code>boolean</code> type. Default: true Group: scheduler
    
    Parameters:
    
    useFixedDelay - the value to set
    
    Returns:
    
    the dsl builder
  - password
```
default MailEndpointBuilderFactory.MailEndpointConsumerBuilder password(String password)
```
    The password for login. See also setAuthenticator(MailAuthenticator). The option is a: <code>java.lang.String</code> type. Group: security
    
    Parameters:
    
    password - the value to set
    
    Returns:
    
    the dsl builder
  - sslContextParameters
```
default MailEndpointBuilderFactory.MailEndpointConsumerBuilder sslContextParameters(Object sslContextParameters)
```
    To configure security using SSLContextParameters. The option is a: <code>org.apache.camel.support.jsse.SSLContextParameters</code> type. Group: security
    
    Parameters:
    
    sslContextParameters - the value to set
    
    Returns:
    
    the dsl builder
  - sslContextParameters
```
default MailEndpointBuilderFactory.MailEndpointConsumerBuilder sslContextParameters(String sslContextParameters)
```
    To configure security using SSLContextParameters. The option will be converted to a <code>org.apache.camel.support.jsse.SSLContextParameters</code> type. Group: security
    
    Parameters:
    
    sslContextParameters - the value to set
    
    Returns:
    
    the dsl builder
  - username
```
default MailEndpointBuilderFactory.MailEndpointConsumerBuilder username(String username)
```
    The username for login. See also setAuthenticator(MailAuthenticator). The option is a: <code>java.lang.String</code> type. Group: security
    
    Parameters:
    
    username - the value to set
    
    Returns:
    
    the dsl builder
  - sortTerm
```
default MailEndpointBuilderFactory.MailEndpointConsumerBuilder sortTerm(Object[] sortTerm)
```
    Sorting order for messages. Only natively supported for IMAP. Emulated to some degree when using POP3 or when IMAP server does not have the SORT capability. The option is a: <code>com.sun.mail.imap.SortTerm[]</code> type. Group: sort
    
    Parameters:
    
    sortTerm - the value to set
    
    Returns:
    
    the dsl builder
  - sortTerm
```
default MailEndpointBuilderFactory.MailEndpointConsumerBuilder sortTerm(String sortTerm)
```
    Sorting order for messages. Only natively supported for IMAP. Emulated to some degree when using POP3 or when IMAP server does not have the SORT capability. The option will be converted to a <code>com.sun.mail.imap.SortTerm[]</code> type. Group: sort
    
    Parameters:
    
    sortTerm - the value to set
    
    Returns:
    
    the dsl builder

Interface MailEndpointBuilderFactory.MailEndpointConsumerBuilder

Method Summary

Methods inherited from interface org.apache.camel.builder.EndpointConsumerBuilder

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

Method Detail

advanced

bridgeErrorHandler

bridgeErrorHandler

closeFolder

closeFolder

copyTo

decodeFilename

decodeFilename

delete

delete

disconnect

disconnect

handleFailedMessage

handleFailedMessage

maxMessagesPerPoll

maxMessagesPerPoll

mimeDecodeHeaders

mimeDecodeHeaders

moveTo

peek

peek

sendEmptyMessageWhenIdle

sendEmptyMessageWhenIdle

skipFailedMessage

skipFailedMessage

unseen

unseen

idempotentRepository

idempotentRepository

idempotentRepositoryRemoveOnCommit

idempotentRepositoryRemoveOnCommit

searchTerm

searchTerm

backoffErrorThreshold

backoffErrorThreshold

backoffIdleThreshold

backoffIdleThreshold

backoffMultiplier

backoffMultiplier

delay

delay

greedy

greedy

initialDelay

initialDelay

repeatCount

repeatCount

runLoggingLevel

runLoggingLevel

scheduledExecutorService

scheduledExecutorService

scheduler

scheduler

schedulerProperties

schedulerProperties

startScheduler

startScheduler

timeUnit

timeUnit

useFixedDelay

useFixedDelay

password

sslContextParameters

sslContextParameters

username

sortTerm

sortTerm