Plugin: xmsg

Variables

max_inotifycount

Type.  integer

Default value.  25

Max number of inotify events that will be processed on one loop
execution. After reaching that count, next events (awaiting in the
queue) will be silently ignored and resume timer will be created (see:
session variable oneshot_resume_timer).


Session Variables

alias

Type.  string

Default value.  none

short session name

auto_away

Type.  integer

Default value.  600

Idle time in seconds, after which status will be set to 'away'.
If 0, auto_away will be disabled.

auto_away_descr

Type.  string

Default value.  none

Description to be set while entering auto-away. If null, the current
description will be kept. Can contain following escape sequences:

	%?	output following chars only if description is set

	%!	output following chars only if description is not set

	%/	output following chars always (disable above)

	%$	output current description here

	%%	output '%'

auto_xa

Type.  integer

Default value.  0

Idle time in seconds, after which status will be set to 'xa'.
If 0, auto_xa will be disabled.

auto_xa_descr

Type.  string

Default value.  none

Description to be set while entering auto-xa. If null, the current
description will be kept. Can contain following escape sequences:

	%?	output following chars only if description is set

	%!	output following chars only if description is not set

	%/	output following chars always (disable above)

	%$	output current description here

	%%	output '%'

auto_back

Type.  integer

Default value.  0

Variable determines that status will be change to 'available', if current
away status was set automatically.
If 1, status is changed whenever user send any message.
If 2, status is changed after keypressed.

auto_connect

Type.  bool

Default value.  0

Variable determines session should be connected after program startup.

auto_reconnect

Type.  integer

Default value.  10

Variable determines, that how long program need to wait to reconnect, 
after disconnect or invalid connection.
If 0, program won't try.

connect_timeout

Type.  integer

Default value.  30

Number of seconds after which connecting will timeout. Set to 0
to disable timeouting (not recommended).


Session Variables

auto_connect

Type.  bool

Default value.  1

If set to true, this session will be connected automagically
on program startup.

charset

Type.  string

Default value.  none

Character set to use when fetching or sending messages. If NULL, no
conversion will be made - i.e. current charset will be used.

dotfile_suffix

Type.  string

Default value.  none

Suffix added to dotfiles on message retrieval. It allows you to use one
than one client on the same incoming message directory.

max_filesize

Type.  integer

Default value.  16384

Files larger than value of this variable won't be read by xmsg plugin.

max_oneshot_files

Type.  integer

Default value.  25

Max count of files that'll be processed during one function call.
If function reaches that count, it'll break off the loop, and set resume
timer (see: oneshot_resume_timer). Value of 0 means no limit.

name_separator

Type.  string

Default value.  .

Separator dividing filename into main part (used in UID-s) and suffix.
Filename will be divided on last occurrence of this character. If null,
dividing will be disabled. If more than one char, the one closer to
the end of filename will be used.

oneshot_resume_timer

Type.  integer

Default value.  3

Delay (in seconds), after which the process, stopped by reaching
max_oneshot_files, will be resumed. If set to 0, no autoresume'll
be done (the process'll be resumed on next function call, for example
on next /connect).

rescan_timer

Type.  integer

Default value.  0 or 300

Interval of rescanning incoming message directory. It shouldn't be used
(and thus is set to 0 by default) in inotify environments.

send_cmd

Type.  string

Default value.  (none)

Command used to send messages to xmsg plugin; it'll be launched with
two args - an UID (without xmsg:) and path to file with message inside.
Note that xmsg doesn't check return value from this handler app/script,
so errors should be returned by use of session's incoming message dir.

unlink_sent

Type.  bool

Default value.  1

If set to true, incoming message files will be removed after reading.
Otherwise, xmsg will create dotfiles to mark them.

unlink_toobig

Type.  bool

Default value.  0

If set to true, files larger than max_filesize will be deleted,
otherwise they'll be ignored (and dotfiles for them will be created).