eventd-im.conf(5)

IM plugin configuration

Build version: 0.27.0 - v0.27.0-15-gdb4a168e (master)

Name

eventd-im.conf — IM plugin configuration

Synopsis

Configuration for the IM plugin.

Description

The im plugin provides messaging through libpurple.

Global sections

Section [IM]

Accounts=

A string list

A list of account names to be used in the account specific sections.

Section [IMAccount account name]

Each section should refer to an account name (see the section called “Section [IM]).

Protocol=

A string

A libpurple protocol name, e.g. "prpl-irc".

Username=

A string

A libpurple user name, the exact format is protocol-dependant, e.g. "bot@chat.freenode.net".

Password=

A string

The password of the account, if needed.

Port=

An integer

The connection port, needed for some protocols.

UseTLS= (defaults to true)

A boolean

Whether to use TLS or not.

For IRC, simply uses TLS. For XMPP and Oscar, forces TLS.

ChatLeaveTimeout= (defaults to -1)

A time in seconds (-1 for infinity)

The number of seconds the plugin will remain connected to a chat room.

ReconnectTimeout= (defaults to 5)

A strictly positive time in seconds

The number of seconds the plugin will wait before attempting to connect after a connection failure. This amount is doubled after each failed attempt, up to 3600 (1 hour).

ReconnectMaxTries= (defaults to 0)

An integer (0 for infinity)

The number of time the plugin will retry to connect after a connection failure.

Action sections

Section [IM]

Disable=

A boolean

If true, no message is sent.

Account=

An account name

The account that will send the message (see eventd-im.conf(5)).

Recipients=

A list of recipient name

A list of recipients to send the message to, the exact format is protocol-dependant, e.g. "example@xmpp.org" or "#project".

Chat= (defaults to true)

A boolean

If true, Recipients= is used as a list of chat rooms names (e.g. some protocols requires to join a chat room before talking in it).

Message=

A format string

The message to be sent.

Events

The im plugin also generates a few events about its connection state.

They are in the eventd-im category.

Common data

All events from this plugin share the following set of data:

account

A string

The name of the account from which this event originates.

Account connection events

Event signed-on

This event is sent when the plugin connected an account successfully.

Event signed-off

This event is sent when an account got disconnected.

In addition to the common data, it has the following one:

error

A boolean

Whether the account is in an error state or not at the time of the disconnection.

Conversation events

Common data

All conversation events share, in addition to the common data, the following set of data:

conv

A string

The name of the conversation from which this event originates.

conv-joined

This event is sent when the plugin joined the conversation.

conv-left

This event is sent when the plugin left the conversation.

See Also

eventd core man pages
eventd(1)

eventd daemon command-line options

eventdctl(1)

eventdctl (control tool) command-line options

eventd.conf(5)

eventd configuration

Contains information about all the event configuration

Plugins distributed with eventd will use the same scheme: eventd-plugin-name for their additional eventd command-line options, eventdctl-plugin-name for their additional eventdctl command-line options, eventd-plugin-name.conf for their configuration,

Plugins man pages