File /obj/handlers/mailer_new.c

Written by Turrican

Started May 1995

Includes

Class Index

• mail_info
  This class holds all generic information about a mail.
• mail_info_personal
  This class holds "personal" information about a mail.
• mailing_list
  This class stores information about a mailing list.

Method index

• do_mail_message(string, string, string, string, string, , string, int)
  This method allows a message to be mailed.
• finger_mail(string)
• format_date(int)
• new_mail(string)
• query_do_this_last()
  This method returns the call back function to use when the mailer has finished.
• read_mail(string, string)
  This function is the main entry point to the mailer.
• set_do_this_last(mixed *)
  This method sets the call back function to use when the mailer has finished.
• status_symbol(int)

Public Functions

do_mail_message

varargs int do_mail_message(string to,
                            string from,
                            string subject,
                            string ccs,
                            string body,
                             int,
                            string only_to,
                            int flag)

This method allows a message to be mailed. It checks the previous object to make sure it is one of the allowed set to do mailing.

Parameters:
to - Who it is to
from - Who it is from
subject - The subject of the message
ccs - The carbon copy recipients
body - The body of the message
only_to - Only mail to the to address
flag - Prevent this_player() from getting the messages if flag != 0

Example:

MAILER->do_mail_message( "pinkfish", "gumboot", "killer tomato", "",
         "The grass was greener yesterday,\nYours\nGumboot." );

finger_mail

string finger_mail(string player)

format_date

string format_date(int x)

new_mail

string new_mail(string player)

query_do_this_last

mixed * query_do_this_last()

This method returns the call back function to use when the mailer has finished.

Returns:
The call back function, format ({ ob, func })

read_mail

void read_mail(string recipient,
               string subject)

This function is the main entry point to the mailer. It is what is called to start up the system when a mailer is used.

Parameters:
recipient - If given, the mailer will start up by sending a message to the recipient
subject - What the subject should be in that case

Example:

mailer = clone_object( MAILER );
mailer->read_mail();

set_do_this_last

void set_do_this_last(mixed * func)

This method sets the call back function to use when the mailer has finished.

Parameters:
func - The call back function, format ({ ob, func })

status_symbol

string status_symbol(int status)

Classes

• mail_info

  class mail_info {
                    int mail_id;
                    int date;
                    string from;
                    string * to;
                    string * cc;
                    string subject;
                    string body;
                    int references;
  }
  
  

  
  This class holds all generic information about a mail.

  Members:
  mail_id - The mail ID
  
  date - When the mail was sent
  
  from - Who sent the mail
  
  to - Whom the mail was sent to
  
  cc - Whom the mail was CC'd to
  
  subject - The subject of the mail
  
  body - The main text of the mail
  
  references - The number of references to the mail
  

• mail_info_personal

  class mail_info_personal {
                             int mail_id;
                             int date;
                             string from;
                             string * to;
                             string * cc;
                             string subject;
                             int status;
  }
  
  

  
  This class holds "personal" information about a mail.

  Members:
  mail_id - The mail ID
  
  date - When the mail was sent
  
  from - Who sent the mail
  
  to - Whom the mail was sent to
  
  cc - Whom the mail was CC'd to
  
  subject - The subject of the mail
  
  status - What the status of the mail is
  

• mailing_list

  class mailing_list {
                       string * members;
                       string * controllers;
                       string creator;
  }
  
  

  
  This class stores information about a mailing list.

  Members:
  members - Members of the mailing list
  
  controllers - Controllers of the mailing list
  
  creator - Who created the mailing list