blob: 47118c62a11b59341bc1dd62a441e428cdca7933 [file] [log] [blame]
{"component":{"kind":"component","name":"aws2-ses","title":"AWS Simple Email Service (SES)","description":"Send e-mails through AWS SES service using AWS SDK version 2.x.","deprecated":false,"firstVersion":"3.1.0","label":"cloud,mail","javaType":"org.apache.camel.component.aws2.ses.Ses2Component","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-aws2-ses","version":"3.18.1","scheme":"aws2-ses","extendsScheme":"","syntax":"aws2-ses:from","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false},"headers":{"CamelAwsSesFrom":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The sender's email address.","constantName":"org.apache.camel.component.aws2.ses.Ses2Constants#FROM"},"CamelAwsSesMessageId":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Amazon SES message ID.","constantName":"org.apache.camel.component.aws2.ses.Ses2Constants#MESSAGE_ID"},"CamelAwsSesReplyToAddresses":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"List<String>","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The reply-to email address(es) for the message.","constantName":"org.apache.camel.component.aws2.ses.Ses2Constants#REPLY_TO_ADDRESSES"},"CamelAwsSesReturnPath":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The email address to which bounce notifications are to be forwarded.","constantName":"org.apache.camel.component.aws2.ses.Ses2Constants#RETURN_PATH"},"CamelAwsSesSubject":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The subject of the message.","constantName":"org.apache.camel.component.aws2.ses.Ses2Constants#SUBJECT"},"CamelAwsSesTo":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"List of comma separated destination email address.","constantName":"org.apache.camel.component.aws2.ses.Ses2Constants#TO"},"CamelAwsSesCc":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"List of comma separated destination carbon copy (cc) email address.","constantName":"org.apache.camel.component.aws2.ses.Ses2Constants#CC"},"CamelAwsSesBcc":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"List of comma separated destination blind carbon copy (bcc) email address.","constantName":"org.apache.camel.component.aws2.ses.Ses2Constants#BCC"},"CamelAwsSesHtmlEmail":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The flag to show if email content is HTML.","constantName":"org.apache.camel.component.aws2.ses.Ses2Constants#HTML_EMAIL"},"CamelAwsSesConfigurationSet":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"TThe configuration set to send.","constantName":"org.apache.camel.component.aws2.ses.Ses2Constants#CONFIGURATION_SET"}},"properties":{"from":{"kind":"path","displayName":"From","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ses.Ses2Configuration","configurationField":"configuration","description":"The sender's email address."},"amazonSESClient":{"kind":"parameter","displayName":"Amazon SESClient","group":"producer","label":"","required":false,"type":"object","javaType":"software.amazon.awssdk.services.ses.SesClient","deprecated":false,"deprecationNote":"","autowired":true,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ses.Ses2Configuration","configurationField":"configuration","description":"To use the AmazonSimpleEmailService as the client"},"bcc":{"kind":"parameter","displayName":"Bcc","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ses.Ses2Configuration","configurationField":"configuration","description":"List of comma separated destination blind carbon copy (bcc) email address. Can be overridden with 'CamelAwsSesBcc' header."},"cc":{"kind":"parameter","displayName":"Cc","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ses.Ses2Configuration","configurationField":"configuration","description":"List of comma separated destination carbon copy (cc) email address. Can be overridden with 'CamelAwsSesCc' header."},"configurationSet":{"kind":"parameter","displayName":"Configuration Set","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ses.Ses2Configuration","configurationField":"configuration","description":"Set the configuration set to send with every request. Override it with 'CamelAwsSesConfigurationSet' header."},"overrideEndpoint":{"kind":"parameter","displayName":"Override Endpoint","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.ses.Ses2Configuration","configurationField":"configuration","description":"Set the need for overidding the endpoint. This option needs to be used in combination with uriEndpointOverride option"},"proxyHost":{"kind":"parameter","displayName":"Proxy Host","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ses.Ses2Configuration","configurationField":"configuration","description":"To define a proxy host when instantiating the SES client"},"proxyPort":{"kind":"parameter","displayName":"Proxy Port","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Integer","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ses.Ses2Configuration","configurationField":"configuration","description":"To define a proxy port when instantiating the SES client"},"proxyProtocol":{"kind":"parameter","displayName":"Proxy Protocol","group":"producer","label":"","required":false,"type":"object","javaType":"software.amazon.awssdk.core.Protocol","enum":["HTTP","HTTPS"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"HTTPS","configurationClass":"org.apache.camel.component.aws2.ses.Ses2Configuration","configurationField":"configuration","description":"To define a proxy protocol when instantiating the SES client"},"region":{"kind":"parameter","displayName":"Region","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ses.Ses2Configuration","configurationField":"configuration","description":"The region in which SES client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example ap-east-1) You'll need to use the name Region.EU_WEST_1.id()"},"replyToAddresses":{"kind":"parameter","displayName":"Reply To Addresses","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ses.Ses2Configuration","configurationField":"configuration","description":"List of comma separated reply-to email address(es) for the message, override it using 'CamelAwsSesReplyToAddresses' header."},"returnPath":{"kind":"parameter","displayName":"Return Path","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ses.Ses2Configuration","configurationField":"configuration","description":"The email address to which bounce notifications are to be forwarded, override it using 'CamelAwsSesReturnPath' header."},"subject":{"kind":"parameter","displayName":"Subject","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ses.Ses2Configuration","configurationField":"configuration","description":"The subject which is used if the message header 'CamelAwsSesSubject' is not present."},"to":{"kind":"parameter","displayName":"To","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ses.Ses2Configuration","configurationField":"configuration","description":"List of comma separated destination email address. Can be overridden with 'CamelAwsSesTo' header."},"trustAllCertificates":{"kind":"parameter","displayName":"Trust All Certificates","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.ses.Ses2Configuration","configurationField":"configuration","description":"If we want to trust all certificates in case of overriding the endpoint"},"uriEndpointOverride":{"kind":"parameter","displayName":"Uri Endpoint Override","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.aws2.ses.Ses2Configuration","configurationField":"configuration","description":"Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option"},"useDefaultCredentialsProvider":{"kind":"parameter","displayName":"Use Default Credentials Provider","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.aws2.ses.Ses2Configuration","configurationField":"configuration","description":"Set whether the Ses client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in."},"lazyStartProducer":{"kind":"parameter","displayName":"Lazy Start Producer","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"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."},"accessKey":{"kind":"parameter","displayName":"Access Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.ses.Ses2Configuration","configurationField":"configuration","description":"Amazon AWS Access Key"},"secretKey":{"kind":"parameter","displayName":"Secret Key","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.aws2.ses.Ses2Configuration","configurationField":"configuration","description":"Amazon AWS Secret Key"}}}