MailHandler

FinishHandlingDetails FinishHandlingMessage FinishPreflightingMessage FinishedWithStream GetStreamForPart HandleBCCRecipients HandleCCRecipients HandleFormIdentifier HandleInReplyTo

HandleMessageIdentifier HandleOriginators HandleReplyTo HandleSubject HandleToRecipients StartHandlingDetails StartHandlingMessage StartPreflightingMessage

Attributes

Preflighting

Fields

Define Class MailHandler;
    mixes in with Object;

    field preflighting:     Boolean, getter;
        // true when the message is being preflighted

    attribute Preflighting: Boolean, readOnly;

// operations for preflighting message parts

    operation StartPreflightingMessage();
        // called by the MailFormatter at start before calling 
        // CreateStreamForPart for each part of the message.

    operation FinishPreflightingMessage();
        // called by the MailFormatter after all parts have been preflighted

// operations for handling message details

    operation StartHandlingDetails(), noMethod;
        // called by the MailFormatter before calling any of the
        // other detail handling operations.

    operation HandleOriginators(recipients: ObjectList), noMethod;
        // called with a list of originators of this message. Generally
        // this is a single entity representing the sender.

    operation HandleToRecipients(recipients: ObjectList), noMethod;
        // called with a list of To: recipients for this handler. This
        // can be a subset of all the To: recipients for this message, as
        // some might be being sent by a different handler.
        // Note: this list can be empty, if the destination service claims
        //       to allow messages with no To: recipient.

    operation HandleCCRecipients(recipients: ObjectList), noMethod;
        // called with a list of CC: recipients for this handler. This
        // otherwise the same as HandleToRecipients().

    operation HandleBCCRecipients(recipients: ObjectList), noMethod;
        // called with a list of BCC: recipients for this handler. This
        // otherwise the same as HandleToRecipients().

    operation HandleReplyTo(addressesToReplyTo: ObjectList), noMethod;
        // called with a list of addresses that should be used for replies
        // to this message.

    operation HandleSubject(subject: HasText), noMethod;
        // called to format the subject line of a message for sending

    operation HandleMessageIdentifier(messageID: HasText), noMethod;
        // called to format the subject line of a message for sending

    operation HandleFormIdentifier(formIdentifier: HasText), noMethod;
        // called to include the name of the form in the message

    operation HandleInReplyTo(referencedMessageIdentifier: HasText), noMethod;
        // called to include the a reference to a message to which this one
        // a response.

    operation FinishHandlingDetails(), noMethod;

// operations for handling message content

    operation StartHandlingMessage(), noMethod;
        // called after all message details have been handled. Message contents
        // will follow.

    operation GetStreamForPart(partLabel: ContentTypeLabel; uniqueID: HasText): Stream, noMethod;
        // called by mail formatters to get a stream to act as a destination
        // for part of a message. This stream is owned by the mail handler. During
        // preflighting it will return nilObject for the stream in the case where
        // the data for the part does not need to be written out.

    operation FinishedWithStream(partStream: Stream), noMethod;
        // called by mail formatters to return a stream created with CreateStreamForPart()
        // to the handler.

    operation FinishHandlingMessage(), noMethod;
        // last call for a message; time to send.
end class;