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

Interface GoogleMailComponentBuilderFactory.GoogleMailComponentBuilder

All Superinterfaces:
ComponentBuilder<org.apache.camel.component.google.mail.GoogleMailComponent>
All Known Implementing Classes:
GoogleMailComponentBuilderFactory.GoogleMailComponentBuilderImpl
Enclosing interface:
GoogleMailComponentBuilderFactory
public static interface GoogleMailComponentBuilderFactory.GoogleMailComponentBuilder extends ComponentBuilder<org.apache.camel.component.google.mail.GoogleMailComponent>
Builder for the Google Mail component.

  • Method Details

    • applicationName

      default GoogleMailComponentBuilderFactory.GoogleMailComponentBuilder applicationName(String applicationName)
      Google mail application name. Example would be camel-google-mail/1.0. The option is a: <code>java.lang.String</code> type. Group: common
      Parameters:
      applicationName - the value to set
      Returns:
      the dsl builder

    • clientId

      default GoogleMailComponentBuilderFactory.GoogleMailComponentBuilder clientId(String clientId)
      Client ID of the mail application. The option is a: <code>java.lang.String</code> type. Group: common
      Parameters:
      clientId - the value to set
      Returns:
      the dsl builder

    • configuration

      default GoogleMailComponentBuilderFactory.GoogleMailComponentBuilder configuration(org.apache.camel.component.google.mail.GoogleMailConfiguration configuration)
      To use the shared configuration. The option is a: <code>org.apache.camel.component.google.mail.GoogleMailConfiguration</code> type. Group: common
      Parameters:
      configuration - the value to set
      Returns:
      the dsl builder

    • delegate

      default GoogleMailComponentBuilderFactory.GoogleMailComponentBuilder delegate(String delegate)
      Delegate for wide-domain service account. The option is a: <code>java.lang.String</code> type. Group: common
      Parameters:
      delegate - the value to set
      Returns:
      the dsl builder

    • scopes

      default GoogleMailComponentBuilderFactory.GoogleMailComponentBuilder scopes(Collection<String> scopes)
      GMail scopes. The option is a: <code>java.util.Collection&lt;java.lang.String&gt;</code> type. Group: common
      Parameters:
      scopes - the value to set
      Returns:
      the dsl builder

    • bridgeErrorHandler

      default GoogleMailComponentBuilderFactory.GoogleMailComponentBuilder 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

    • lazyStartProducer

      default GoogleMailComponentBuilderFactory.GoogleMailComponentBuilder 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

    • autowiredEnabled

      default GoogleMailComponentBuilderFactory.GoogleMailComponentBuilder 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

    • clientFactory

      default GoogleMailComponentBuilderFactory.GoogleMailComponentBuilder clientFactory(org.apache.camel.component.google.mail.GoogleMailClientFactory clientFactory)
      To use the GoogleCalendarClientFactory as factory for creating the client. Will by default use BatchGoogleMailClientFactory. The option is a: <code>org.apache.camel.component.google.mail.GoogleMailClientFactory</code> type. Group: advanced
      Parameters:
      clientFactory - the value to set
      Returns:
      the dsl builder

    • accessToken

      default GoogleMailComponentBuilderFactory.GoogleMailComponentBuilder accessToken(String accessToken)
      OAuth 2 access token. This typically expires after an hour so refreshToken is recommended for long term usage. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      accessToken - the value to set
      Returns:
      the dsl builder

    • clientSecret

      default GoogleMailComponentBuilderFactory.GoogleMailComponentBuilder clientSecret(String clientSecret)
      Client secret of the mail application. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      clientSecret - the value to set
      Returns:
      the dsl builder

    • refreshToken

      default GoogleMailComponentBuilderFactory.GoogleMailComponentBuilder refreshToken(String refreshToken)
      OAuth 2 refresh token. Using this, the Google Calendar component can obtain a new accessToken whenever the current one expires - a necessity if the application is long-lived. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      refreshToken - the value to set
      Returns:
      the dsl builder

    • serviceAccountKey

      default GoogleMailComponentBuilderFactory.GoogleMailComponentBuilder serviceAccountKey(String serviceAccountKey)
      Service account key in json format to authenticate an application as a service account. Accept base64 adding the prefix base64:. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      serviceAccountKey - the value to set
      Returns:
      the dsl builder