File pop3server_lua.luadoc

Functions

pop3server.get_mailmessage_flag (p, num, flag) Get mailmessage flag.
pop3server.get_mailmessage_size (p, num) Gets message size.
pop3server.get_mailmessage_uidl (p, num) Gets message uidl.
pop3server.get_popstate_boxsize (p) Gets the box size.
pop3server.get_popstate_nummesg (p) Get number of messages in the box.
pop3server.get_popstate_password (p) Gets the stored password.
pop3server.get_popstate_username (p) Gets the stored username.
pop3server.pop3server.set_mailmessage_uidl (p, num, uidl) Sets the message uidl.
pop3server.popserver_callback (buffer, popserver_data) The callback to send data.
pop3server.set_mailmessage_flag (p, num, flag) Sets a message flag.
pop3server.set_mailmessage_size (p, num, size, numum) Sets the message size.
pop3server.set_popstate_boxsize (p, size) Sets the box size.
pop3server.set_popstate_nummesg (p, num) Sets the mailbox message number.
pop3server.set_popstate_password (p, passwd) Sets password.
pop3server.set_popstate_username (p, username) Sets the username.
pop3server.unset_mailmessage_flag (p, num, flag) Removes a mailmessage flag.


Functions

pop3server.get_mailmessage_flag (p, num, flag)
Get mailmessage flag.

Parameters

  • p: userdata The pstate.
  • num: number the message number, from 1 to n.
  • flag: number the MAILMESSAGE_* flag.

Return value:

boolean true if is set.
pop3server.get_mailmessage_size (p, num)
Gets message size.

Parameters

  • p: userdata The pstate.
  • num: number the message number, from 1 to n.
pop3server.get_mailmessage_uidl (p, num)
Gets message uidl.

Parameters

  • p: userdata The pstate.
  • num: number the message number, from 1 to n.
pop3server.get_popstate_boxsize (p)
Gets the box size.

Parameters

  • p: userdata The pstate.
pop3server.get_popstate_nummesg (p)
Get number of messages in the box.

Parameters

  • p: userdata The pstate.
pop3server.get_popstate_password (p)
Gets the stored password.

Parameters

  • p: userdata The pstate.

Return value:

string.
pop3server.get_popstate_username (p)
Gets the stored username.

Parameters

  • p: userdata The pstate.

Return value:

string.
pop3server.pop3server.set_mailmessage_uidl (p, num, uidl)
Sets the message uidl.

Parameters

  • p: userdata The pstate.
  • num: number the message number, from 1 to n.
  • uidl:
pop3server.popserver_callback (buffer, popserver_data)
The callback to send data.

Parameters

  • buffer: string the data.."\r\n".
  • popserver_data: userdata the pdata passed by the caller.
pop3server.set_mailmessage_flag (p, num, flag)
Sets a message flag.

Parameters

  • p: userdata The pstate.
  • num: number the message number, from 1 to n.
  • flag: number the MAILMESSAGE_* flag.
pop3server.set_mailmessage_size (p, num, size, numum)
Sets the message size.

Parameters

  • p: userdata The pstate.
  • num:
  • size: number the message size.
  • numum: number the message number, from 1 to n.
pop3server.set_popstate_boxsize (p, size)
Sets the box size.

Parameters

  • p: userdata The pstate.
  • size:
pop3server.set_popstate_nummesg (p, num)
Sets the mailbox message number. Used in stat

Parameters

  • p: userdata The pstate.
  • num: number The number of messages.
pop3server.set_popstate_password (p, passwd)
Sets password. Can be used to remember it for furter elaboration

Parameters

  • p: userdata The pstate.
  • passwd: string The password.
pop3server.set_popstate_username (p, username)
Sets the username. Can be used to remember it for furter elaboration

Parameters

  • p: userdata The pstate.
  • username: string The username.
pop3server.unset_mailmessage_flag (p, num, flag)
Removes a mailmessage flag.

Parameters

  • p: userdata The pstate.
  • num: number the message number, from 1 to n.
  • flag: number the MAILMESSAGE_* flag.

Valid XHTML 1.0!