HTML Utilities

Showing help on '$mail_agent'

mail distribution center (#46)

:resolve_addr - resolve(name,from,seen,prevrcpts,prevnotifs) => {rcpts,notifs} or E_INVARG
:sends_to - sends_to(from,addr,rcpt[,seen]) ==> true iff mail sent to addr passes through rcpt.
:send_message - send_message(from,rcpt-list,hdrs,msg) -- formats and sends a mail message. hders is either the text of the subject line, or a {subject,{reply-to,...}} list.
:raw_send - Copied from Mail Distribution Center (#6418):raw_send by Nosredna (#2487) Mon Feb 24 10:46:26 1997 PST
:touch - touch(name or list,seen) => does .last_used_time = time() if we haven't already touched this in the last hour
:acceptable - Only allow mailing lists/folders in here and only if their names aren't already taken.
:check_names - ...make sure the list has at least one usable name.
:match(string) => mailing list object in here that matches string.
:match_recipient(string[,meobj]) => $player or $mail_recipient object that matches string. Optional second argument (defaults to player) is returned in the case string=="me" and is also used to obtain a list of private $mail_recipients to match against.
:make_message(sender,recipients,subject/replyto/additional-headers,body)
:parse_address_field(string) => list of objects
:display_seq_full(msg_seq[,preamble]) => {cur, last-read-date}
:display_seq_headers(msg_seq[,cur[,last_read_date]])
:rm_message_seq(msg_seq) removes the given sequence of from folder (caller)
:undo_rmm() restores previously deleted messages in .messages_going to .messages.
:list_rmm() displays contents of .messages_going.
:renumber([cur]) -- assumes caller is a $mail_recipient or a $player.
:msg_summary_line(@msg) => date/from/subject as a single string.
:parse_message_seq - parse_message_seq(strings,cur[,last_old])
:_parse_from(string with |'s in it) => object list
:new_message_num() => number that the next incoming message will receive.
:length_num_le(num) => number of messages in folder numbered <= num
:exists_num_eq(num) => index of message in folder numbered == num
:from_msg_seq(object or list[,mask])
:%from_msg_seq(string or list of strings[,mask])
:to_msg_seq(object or list[,mask]) => msg_seq of messages to those people
:%to_msg_seq(string or list of strings[,mask])
:subject_msg_seq(target) => msg_seq of messages with target in the Subject:
:body_msg_seq(target[,mask]) => msg_seq of messages with target in the body
:messages_in_seq(msg_seq) => list of messages in msg_seq on folder (caller)
:__convert_new(@msg) => msg in new format (if it isn't already)
:to_text(@msg) => message in text form (suitable for printing)
:reserved_pattern(string)
:keep_message_seq(msg_seq)
:kept_msg_seq([mask])
:msg_seq_to_msg_num_string(msg_seq) => string giving the corresponding message numbers
:msg_seq_to_msg_num_list(msg_seq) => list of corresponding message numbers
:send_log_message - send_log_message(perms,from,rcpt-list,hdrs,msg) -- formats and sends a mail message. hders is either the text of the subject line, or a {subject,{reply-to,...}} list.
:parse_misc_headers(msg,@extract_names)
:resend_message - resend_message(new_sender,new_rcpts,from,to,hdrs,body)
:time - This was inspired by Xeric's port 4632 on *Core-DB-Issues
:announce - Usage: announce(message);
:announce_all - "Usage: announce_all(message)";
:announce_all_but - Usage: announce_all_but({person1, person2}, message);
:say - say <message>
:messages say_nothing_msg osay_nothing_msg - Is called when you use the say verb without anything to say. set say_nothing_msg. Useful for perhaps being underwater and bubbling when you open your mouth?
:match - usage: match (name of something to match.)
:acceptable - return this.free_entry;
:enterfunc - Called when an object enters the room. If the object's a player, makes them look at the room.
:add_exit add_entrance - Usage: room:add_exit(dest, aliases, ?bidirectional, ?exit_class)
:title - Returns: The name of the room prefixed with the name of the area the room is in.
:players - Used to get a list of players in the current room.
:objects - Returns a room's contents excluding any players.
:cannot_go_msg - Called when there is no exit in the direction the player's trying to go in.
:disfunc - Called when a player disconnects.
:recycle - Removes all exits from a room when it is recycled.
:match_exit - Usage: match_exit(name of an exit)
:huh - Called when other command matching fails. Currently checks for an exit with the same name as the command given.
:is_dark - Use to see if a room is dark. Right now just returns the property, but it could be used as a framework for more complex darknesses.
:dark_title_msg - This is the title of a dark room. Set the prop.
:dark_msg - Called when the room is dark, for the actual description. Set the property it references...
:initialize - Called when the room is created. Unsets entrances and exits.
:look_self - Called when a player looks at a room.
:process_exits - This verb can take args which should be in the same format as returned by this:obvious_exits. If none are given, it will call that verb.
:process_players - This verb expects the same output as $room:players, namely {{connected players}, {sleeping players}}.
:process_objects - $room:process_objects: Used to get the message about what nonplayer, nonexit things are in a room.
:obvious_exits - Returns: A list of the WAIF exits in the room who have their .obvious property set to 1.
:description - Combines room description with integration messages
:ejection_msg oejection_msg victim_ejection_msg - Copied from generic old room (#3):ejection_msg [verb author Hacker (#36)] at Tue Jan 29 01:20:22 2008 EST
:process_exit_dest - Copied from new generic room (#2700):process_exits [verb author Q (#249)] at Wed Apr 10 22:16:48 2019 UTC
:do_sit - Copied from generic new furniture (#1942):do_sit [verb author Q (#249)] at Thu Dec 15 18:47:11 2022 UTC
:sit_up - Copied from generic new furniture (#1942):sit_up [verb author Q (#249)] at Thu Dec 15 18:48:04 2022 UTC
:sit_with_msg osit_with_msg - Copied from generic new furniture (#1942):sit_with_msg [verb author Q (#249)] at Thu Dec 15 18:48:52 2022 UTC
:display_occupants - Copied from generic new furniture (#1942):display_occupants [verb author Q (#249)] at Tue Jan 24 13:47:33 2023 UTC
:no_room_for_sitters_msg no_room_for_recliners_msg already_sitting_on_this_msg sit_msg recline_msg sit_up_msg lie_back_msg stand_msg sitters_msg recliners_msg sit_with_you_msg osit_with_msg orecline_with_msg recline_with_you_msg already_reclining_on_this_msg - Copied from generic new furniture (#1942):sitters_msg [verb author Q (#249)] at Tue Jan 24 13:48:58 2023 UTC
:send_markdown - Copied from generic player (#6):send_markdown [verb author Q (#249)] at Sat May 17 18:54:22 2025 UTC
:random_msg - Trigger random ambient message if conditions are met.
:who_location_msg - Return custom location text for @who display, with pronoun substitution.
:list_exits - Return list of exit titles, optionally sorted by .sort_exits property.
:weather_location - Returns the weather location for this room - checks this.weather_location first, falls back to area's weather_location
:do_subbing - Substitute condition text for announcements
:replace_for_description - Replace condition text for description display
:update_temperature - Update temperature and announce changes
:update_humidity - Update humidity and announce changes - accepts optional weather_data map
:update_conditions - Update weather conditions and trigger effects
:trigger_events - Called to trigger any registered room events and schedule next check.
:add_room_event - Usage: room:add_room_event(name, interval, verb, ?args)
:remove_room_event - Usage: room:remove_room_event(name)
:cleanup_sitters - Remove invalid objects and players not in this room from sitters and recliners lists
:notify_wanderers - Notify wanderers in this room of an event
:format_player_list - format_player_list(players, msg) -> string or 0
:viewer_position_msg - viewer_position_msg() -> string or empty string
:mass - Copied from Root Class (#1):mass [verb author Daiverd (#2)] at Mon Nov 10 23:04:48 2008 CET
:cube - Copied from Root Class (#1):cube [verb author Daiverd (#2)] at Mon Nov 10 23:12:50 2008 CET
:weight - Copied from Root Class (#1):weight [verb author Daiverd (#2)] at Thu Nov 13 07:04:56 2008 CET
:travel_to(destination_coords, ?speed, ?callback_verb) -> arrival_time or error
:test_interpolated_coordinates - Test position interpolation along a path
:test_interpolated_coords_multiseg - Test interpolation with multiple path segments
:test_stop_travel - Test stopping mid-travel
:test_arrive - Test arrival at destination
:test_travel_to - Test travel_to setup
:interpolated_coordinates() -> {x, y, z}
:stop_travel() - Stop traveling and set coords to current interpolated position
:arrive() - Complete travel and set coords to destination
:interact_with(target) - suspends until nearby, kills task if can't reach
:_arrive_and_interact() - Arrival callback that resumes suspended task
:movement_velocity() -> movement speed in m/s
:add_option(<description>, <default value>)
:set_name - set_name(newname) attempts to change this.name to newname
:set_aliases - set_aliases(alias_list) attempts to change this.aliases to alias_list
:set_description - set_description(newdesc) attempts to change this.description to newdesc
:eject eject_nice eject_basic - eject(victim) --- usable by the owner of this to remove victim from this.contents. victim goes to its home if different from here, or $unclaimed or $player_start according as victim is a player.
:set_message(msg_name,new_value)
:do_examine - do_examine(examiner)
:examine_key - examine_key(examiner)
:examine_names - examine_names(examiner)
:examine_desc - examine_desc(who) - return the description, probably
:examine_contents - examine_contents(examiner)
:examine_verbs - Return a list of strings to be told to the player. Standard format says "Obvious verbs:" followed by a series of lines explaining syntax for each usable verb.
:get_message(msg_name)
:contents objects_for_match - Returns a list of the objects that are apparently inside this one. Don't confuse this with .contents, which is a property kept consistent with .location by the server. This verb should be used in `VR' situations, for instance when looking in a room, and does not necessarily have anything to do with the value of .contents (although the default implementation does). `Non-VR' commands (like @contents) should look directly at .contents.
:examine_verb_ok - examine_verb_ok(loc, index, info, syntax, commands_ok, hidden_verbs)
:is_listening - return 1 if the object can hear a :tell, or cares. Useful for active objects that want to stop when nothing is listening.
:hidden_verbs - hidden_verbs(who)
:examine_owner - examine_owner(examiner)
:loc_enter loc_exit - syntax: what, where, levels from original
:integrate_room_msg integrate_container_msg - If this.(verb) is not set, return this:integrate_msg(@args).
:empty_message - Usage: :empty_msg(msgname)
:ps*c po*c pr*c pp*c pq*c psu pou pru ppu pqu - Get the appropriate pronoun.
:vitals - Pass vitals upwards, towards vehicles/ships/etc
:match_targets() => Returns a list of objects used for matching code. Child implementations should probably call pass() before overriding.



-- telnet://project-mongoose.net:7777 -- Mail us -- http://project-mongoose.net:7780/ --
-- Five users connected --