IRC

Send and receive messages to/from and IRC chat.

Metadata

Property	Value
Scheme	`irc`
Support Level	Stable
Labels	chat
Version	4.10.2

Maven Dependency

<dependency>
    <groupId>org.apache.camel</groupId>
    <artifactId>camel-irc</artifactId>
    <version>4.10.2</version>
</dependency>

Endpoint Properties

Name	Type	Required	Default	Description
`hostname`	string	✓		Hostname for the IRC chat server
`port`	integer			Port number for the IRC chat server. If no port is configured then a default port of either 6667, 6668 or 6669 is used.
`autoRejoin`	boolean		`true`	Whether to auto re-join when being kicked
`channels`	string			Comma separated list of IRC channels.
`commandTimeout`	integer		`5000`	Delay in milliseconds before sending commands after the connection is established.
`keys`	string			Comma separated list of keys for channels.
`namesOnJoin`	boolean		`false`	Sends NAMES command to channel after joining it. onReply has to be true in order to process the result which will have the header value irc.num = '353'.
`nickname`	string			The nickname used in chat.
`persistent`	boolean		`true`	Use persistent messages.
`realname`	string			The IRC user's actual name.
`bridgeErrorHandler`	boolean		`false`	Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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.
`exceptionHandler`	object			To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored.
`exchangePattern`	object			Sets the exchange pattern when the consumer creates an exchange.
`lazyStartProducer`	boolean		`false`	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.
`colors`	boolean		`true`	Whether or not the server supports color codes.
`onJoin`	boolean		`true`	Handle user join events.
`onKick`	boolean		`true`	Handle kick events.
`onMode`	boolean		`true`	Handle mode change events.
`onNick`	boolean		`true`	Handle nickname change events.
`onPart`	boolean		`true`	Handle user part events.
`onPrivmsg`	boolean		`true`	Handle private message events.
`onQuit`	boolean		`true`	Handle user quit events.
`onReply`	boolean		`false`	Whether or not to handle general responses to commands or informational messages.
`onTopic`	boolean		`true`	Handle topic change events.
`nickPassword`	string			Your IRC server nickname password.
`password`	string			The IRC server password.
`sslContextParameters`	object			Used for configuring security using SSL. Reference to a org.apache.camel.support.jsse.SSLContextParameters in the Registry. This reference overrides any configured SSLContextParameters at the component level. Note that this setting overrides the trustManager option.
`trustManager`	object			The trust manager used to verify the SSL server's certificate.
`username`	string			The IRC server user name.