Package org.apache.camel.builder.component.dsl

Interface ImapComponentBuilderFactory.ImapComponentBuilder

All Superinterfaces:
ComponentBuilder<org.apache.camel.component.mail.MailComponent>
All Known Implementing Classes:
ImapComponentBuilderFactory.ImapComponentBuilderImpl
Enclosing interface:
ImapComponentBuilderFactory
public static interface ImapComponentBuilderFactory.ImapComponentBuilder extends ComponentBuilder<org.apache.camel.component.mail.MailComponent>
Builder for the IMAP component.

  • Method Details

    • bridgeErrorHandler

      default ImapComponentBuilderFactory.ImapComponentBuilder 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

    • closeFolder

      default ImapComponentBuilderFactory.ImapComponentBuilder 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

    • copyTo

      default ImapComponentBuilderFactory.ImapComponentBuilder 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 ImapComponentBuilderFactory.ImapComponentBuilder 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

    • delete

      default ImapComponentBuilderFactory.ImapComponentBuilder 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

    • disconnect

      default ImapComponentBuilderFactory.ImapComponentBuilder 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

    • handleFailedMessage

      default ImapComponentBuilderFactory.ImapComponentBuilder 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

    • mimeDecodeHeaders

      default ImapComponentBuilderFactory.ImapComponentBuilder 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

    • moveTo

      default ImapComponentBuilderFactory.ImapComponentBuilder 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 ImapComponentBuilderFactory.ImapComponentBuilder peek(boolean peek)
      Will mark the jakarta.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

    • skipFailedMessage

      default ImapComponentBuilderFactory.ImapComponentBuilder 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

    • unseen

      default ImapComponentBuilderFactory.ImapComponentBuilder 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

    • failOnDuplicateFileAttachment

      default ImapComponentBuilderFactory.ImapComponentBuilder failOnDuplicateFileAttachment(boolean failOnDuplicateFileAttachment)
      Whether to fail processing the mail if the mail message contains attachments with duplicate file names. If set to false, then the duplicate attachment is skipped and a WARN is logged. If set to true then an exception is thrown failing to process the mail message. The option is a: <code>boolean</code> type. Default: false Group: consumer (advanced)
      Parameters:
      failOnDuplicateFileAttachment - the value to set
      Returns:
      the dsl builder

    • fetchSize

      default ImapComponentBuilderFactory.ImapComponentBuilder 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

    • folderName

      default ImapComponentBuilderFactory.ImapComponentBuilder folderName(String folderName)
      The folder to poll. The option is a: <code>java.lang.String</code> type. Default: INBOX Group: consumer (advanced)
      Parameters:
      folderName - the value to set
      Returns:
      the dsl builder

    • generateMissingAttachmentNames

      default ImapComponentBuilderFactory.ImapComponentBuilder generateMissingAttachmentNames(String generateMissingAttachmentNames)
      Set this to 'uuid' to set a UUID for the filename of the attachment if no filename was set. The option is a: <code>java.lang.String</code> type. Group: consumer (advanced)
      Parameters:
      generateMissingAttachmentNames - the value to set
      Returns:
      the dsl builder

    • handleDuplicateAttachmentNames

      default ImapComponentBuilderFactory.ImapComponentBuilder handleDuplicateAttachmentNames(String handleDuplicateAttachmentNames)
      Set the strategy to handle duplicate filenames of attachments never: attachments that have a filename which is already present in the attachments will be ignored unless failOnDuplicateFileAttachment is set to true. uuidPrefix: this will prefix the duplicate attachment filenames each with a uuid and underscore (uuid_filename.fileextension). uuidSuffix: this will suffix the duplicate attachment filenames each with a underscore and uuid (filename_uuid.fileextension). The option is a: <code>java.lang.String</code> type. Group: consumer (advanced)
      Parameters:
      handleDuplicateAttachmentNames - the value to set
      Returns:
      the dsl builder

    • mapMailMessage

      default ImapComponentBuilderFactory.ImapComponentBuilder 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 jakarta.mail.Message. You can retrieve this raw message by calling exchange.getIn().getBody(jakarta.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

    • bcc

      default ImapComponentBuilderFactory.ImapComponentBuilder bcc(String bcc)
      Sets the BCC email address. Separate multiple email addresses with comma. The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      bcc - the value to set
      Returns:
      the dsl builder

    • cc

      default ImapComponentBuilderFactory.ImapComponentBuilder cc(String cc)
      Sets the CC email address. Separate multiple email addresses with comma. The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      cc - the value to set
      Returns:
      the dsl builder

    • from

      default ImapComponentBuilderFactory.ImapComponentBuilder from(String from)
      The from email address. The option is a: <code>java.lang.String</code> type. Default: camel@localhost Group: producer
      Parameters:
      from - the value to set
      Returns:
      the dsl builder

    • lazyStartProducer

      default ImapComponentBuilderFactory.ImapComponentBuilder lazyStartProducer(boolean lazyStartProducer)
      Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. The option is a: <code>boolean</code> type. Default: false Group: producer
      Parameters:
      lazyStartProducer - the value to set
      Returns:
      the dsl builder

    • replyTo

      default ImapComponentBuilderFactory.ImapComponentBuilder replyTo(String replyTo)
      The Reply-To recipients (the receivers of the response mail). Separate multiple email addresses with a comma. The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      replyTo - the value to set
      Returns:
      the dsl builder

    • subject

      default ImapComponentBuilderFactory.ImapComponentBuilder subject(String subject)
      The Subject of the message being sent. Note: Setting the subject in the header takes precedence over this option. The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      subject - the value to set
      Returns:
      the dsl builder

    • to

      default ImapComponentBuilderFactory.ImapComponentBuilder to(String to)
      Sets the To email address. Separate multiple email addresses with comma. The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      to - the value to set
      Returns:
      the dsl builder

    • javaMailSender

      default ImapComponentBuilderFactory.ImapComponentBuilder javaMailSender(org.apache.camel.component.mail.JavaMailSender javaMailSender)
      To use a custom org.apache.camel.component.mail.JavaMailSender for sending emails. The option is a: <code>org.apache.camel.component.mail.JavaMailSender</code> type. Group: producer (advanced)
      Parameters:
      javaMailSender - the value to set
      Returns:
      the dsl builder

    • additionalJavaMailProperties

      default ImapComponentBuilderFactory.ImapComponentBuilder additionalJavaMailProperties(Properties additionalJavaMailProperties)
      Sets additional java mail properties, that will append/override any default properties that is set based on all the other options. This is useful if you need to add some special options but want to keep the others as is. The option is a: <code>java.util.Properties</code> type. Group: advanced
      Parameters:
      additionalJavaMailProperties - the value to set
      Returns:
      the dsl builder

    • alternativeBodyHeader

      default ImapComponentBuilderFactory.ImapComponentBuilder 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 ImapComponentBuilderFactory.ImapComponentBuilder 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

    • authenticator

      default ImapComponentBuilderFactory.ImapComponentBuilder 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

    • autowiredEnabled

      default ImapComponentBuilderFactory.ImapComponentBuilder autowiredEnabled(boolean autowiredEnabled)
      Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. The option is a: <code>boolean</code> type. Default: true Group: advanced
      Parameters:
      autowiredEnabled - the value to set
      Returns:
      the dsl builder

    • configuration

      default ImapComponentBuilderFactory.ImapComponentBuilder configuration(org.apache.camel.component.mail.MailConfiguration configuration)
      Sets the Mail configuration. The option is a: <code>org.apache.camel.component.mail.MailConfiguration</code> type. Group: advanced
      Parameters:
      configuration - the value to set
      Returns:
      the dsl builder

    • connectionTimeout

      default ImapComponentBuilderFactory.ImapComponentBuilder 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

    • contentType

      default ImapComponentBuilderFactory.ImapComponentBuilder 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 ImapComponentBuilderFactory.ImapComponentBuilder 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

    • debugMode

      default ImapComponentBuilderFactory.ImapComponentBuilder 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

    • ignoreUnsupportedCharset

      default ImapComponentBuilderFactory.ImapComponentBuilder 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

    • ignoreUriScheme

      default ImapComponentBuilderFactory.ImapComponentBuilder 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

    • javaMailProperties

      default ImapComponentBuilderFactory.ImapComponentBuilder 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

    • session

      default ImapComponentBuilderFactory.ImapComponentBuilder session(jakarta.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>jakarta.mail.Session</code> type. Group: advanced
      Parameters:
      session - the value to set
      Returns:
      the dsl builder

    • useInlineAttachments

      default ImapComponentBuilderFactory.ImapComponentBuilder 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

    • headerFilterStrategy

      default ImapComponentBuilderFactory.ImapComponentBuilder headerFilterStrategy(org.apache.camel.spi.HeaderFilterStrategy headerFilterStrategy)
      To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message. The option is a: <code>org.apache.camel.spi.HeaderFilterStrategy</code> type. Group: filter
      Parameters:
      headerFilterStrategy - the value to set
      Returns:
      the dsl builder

    • healthCheckConsumerEnabled

      default ImapComponentBuilderFactory.ImapComponentBuilder healthCheckConsumerEnabled(boolean healthCheckConsumerEnabled)
      Used for enabling or disabling all consumer based health checks from this component. The option is a: <code>boolean</code> type. Default: true Group: health
      Parameters:
      healthCheckConsumerEnabled - the value to set
      Returns:
      the dsl builder

    • healthCheckProducerEnabled

      default ImapComponentBuilderFactory.ImapComponentBuilder healthCheckProducerEnabled(boolean healthCheckProducerEnabled)
      Used for enabling or disabling all producer based health checks from this component. Notice: Camel has by default disabled all producer based health-checks. You can turn on producer checks globally by setting camel.health.producersEnabled=true. The option is a: <code>boolean</code> type. Default: true Group: health
      Parameters:
      healthCheckProducerEnabled - the value to set
      Returns:
      the dsl builder

    • password

      default ImapComponentBuilderFactory.ImapComponentBuilder 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 ImapComponentBuilderFactory.ImapComponentBuilder sslContextParameters(org.apache.camel.support.jsse.SSLContextParameters 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

    • useGlobalSslContextParameters

      default ImapComponentBuilderFactory.ImapComponentBuilder useGlobalSslContextParameters(boolean useGlobalSslContextParameters)
      Enable usage of global SSL context parameters. The option is a: <code>boolean</code> type. Default: false Group: security
      Parameters:
      useGlobalSslContextParameters - the value to set
      Returns:
      the dsl builder

    • username

      default ImapComponentBuilderFactory.ImapComponentBuilder 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