001: /***
002: * jwma Java WebMail
003: * Copyright (c) 2000-2003 jwma team
004: *
005: * jwma is free software; you can distribute and use this source
006: * under the terms of the BSD-style license received along with
007: * the distribution.
008: ***/package dtw.webmail.model;
009:
010: /**
011: * An interface defining the contract for interaction with
012: * the JwmaMailIdentity model.
013: * <p>
014: * A <tt>JwmaMailIdentity</tt> allows the view programmer
015: * access to mail identity information.
016: *
017: * @author Dieter Wimberger
018: * @version 0.9.7 07/02/2003
019: */
020: public interface JwmaMailIdentity {
021:
022: /**
023: * Returns the unique identifier of this <tt>JwmaMailIdentity</tt>.
024: *
025: * @return the unique identifier as <tt>String</tt>.
026: */
027: public String getUID();
028:
029: /**
030: * Returns a <tt>String</tt> representing the
031: * name of this <tt>JwmaMailIdentity</tt>.
032: *
033: * @return the name of this <tt>JwmaMailIdentitya</tt>
034: * as <tt>String</tt>.
035: */
036: public String getName();
037:
038: /**
039: * Returns a <tt>String</tt> representing the
040: * mail address of this <tt>JwmaMailIdentity</tt>.
041: *
042: * @return the mail address as <tt>String</tt>.
043: */
044: public String getFrom();
045:
046: /**
047: * Returns a <tt>String</tt> representing the
048: * reply-to mail address of this
049: * <tt>JwmaMailIdentity</tt>.
050: *
051: * @return the reply-to mail address as <tt>String</tt>.
052: */
053: public String getReplyTo();
054:
055: /**
056: * Returns a <tt>String</tt> representing the
057: * signature of this <tt>JwmaMailIdentity</tt>.
058: *
059: * @return the standard signature as String.
060: */
061: public String getSignature();
062:
063: /**
064: * Returns the unique identifier of the contact related
065: * with this <tt>MailIdentity</tt>.
066: *
067: * @return the UID of the related contact as <tt>String</tt>.
068: */
069: public String getRelatedContact();
070:
071: /**
072: * Tests if the signature should be appended
073: * automatically for this <tt>JwmaMailIdentity</tt>.
074: *
075: * @return true if the signature should be appended
076: * automatically, false otherwise.
077: */
078: public boolean isAutoSigning();
079:
080: /**
081: * Returns a <tt>String</tt> representing the
082: * note of this <tt>JwmaMailIdentity</tt>.
083: *
084: * @return the note as <tt>String</tt>.
085: */
086: public String getNote();
087:
088: /**
089: * Returns a <tt>String</tt> representing the
090: * random append type of this <tt>JwmaMailIdentity</tt>.
091: *
092: * @return the standard signature as String.
093: */
094: public String getRandomAppendType();
095:
096: /**
097: * Tests if this <tt>JwmaMailIdentity</tt> want's a
098: * random string to be appended to a message.
099: *
100: * @return true if a random string should be appended,
101: * false otherwise.
102: */
103: public boolean isRandomAppendAllowed();
104:
105: }//Interface JwmaMailIdentity
|