MailMsg

java.lang.Object
- triana.types.TrianaType
- - triana.types.Document
  - - triana.types.MailMsg

All Implemented Interfaces:

java.io.Serializable, AsciiComm, SequenceInterface
```
public class MailMsg
extends Document
implements AsciiComm
```
MailMsg is a subclass of Document which stores the contents of a single email message. The message is stored with headers if it is incoming, and with MIME attachments. The type provides methods for examining relevant information, such as the date and sender of the message. Messages can be locked when created, so that they are createTool-only. For non-locked messages, there are messages for setting the date, sender, etc, and for setting the text. There are also methods for interpreting the date for a wide variety of possible input formats; for parsing email names into email addresses and personal names; and for locating and testing the integrity of MIME attachments.
The first version 1.x provides very limited inspection of header data. Only the date, from, to, cc, bcc, subject, and message-id fields are available as parameter data. There is no facility yet for inserting a MIME attachment or dealing with flags for whether messages have been createTool or replied to, their priority, threads etc.

See Also:
Serialized Form

Field Summary
- Fields inherited from class triana.types.TrianaType
  NOT_CONNECTED, NOT_READY, OUT_OF_RANGE

Constructor Summary

Constructors
Constructor and Description
`MailMsg()` Constructs an empty MailMsg.
`MailMsg(java.lang.String message, FileName file)` Constructs a MailMsg from an input mail message, complete with header and MIME attachments, and the name of the file from which it was createTool.

Method Summary

Methods
Modifier and Type	Method and Description
`StringVector`	`addressList(java.lang.String addresses)` Attempts to separate the input String into addresses of email recipients.
`void`	`addToFolder(java.lang.String fn)` Adds to the list toFolders a foldername (just a String ) of the folder (mailbox) into which the message should be written.
`void`	`addToFolders(StringVector fns)` Adds to the list toFolders a StringVector of foldernames of the folders (mailboxes) into which the message should be written.
`boolean`	`checkMIME()` Checks MIME attachments to see if the delimiters are consistent.
`TrianaType`	`copyMe()` This is one of the most important methods of Triana data.
`void`	`copyParameters(TrianaType source)` Copies modifiable parameters from the given source.
`StringVector`	`copyToFolders()` Returns a copy-by-value of the list of filenames of the folders (mailboxes) into which the message should be written.
`boolean`	`equals(java.lang.Object doc)` Returns true if the specified object doc is the same type and has the same contents as this object, including the path name and file name.
`static java.lang.String`	`filenameFromName(java.lang.String nameIn)` Creates a filename in a standard format from an input personal name.
`java.lang.String`	`getBlindCopiesTo()` Returns the blind (hidden) carbon-copy recipient(s) of the message as a String containing all such recipients, exactly as in the email message.
`StringVector`	`getBlindCopiesToList()` Returns the blind (hidden) recipient addressess in a StringVector, one recipient per element.
`java.lang.String`	`getBody()` Returns the message body, without the header, including any MIME attachments.
`int`	`getBodyLocation()` Returns the character index location where the message body begins after the header.
`java.lang.String`	`getBodyNoMIME()` Returns the message body, without the header or MIME attachments.
`java.lang.String`	`getCopiesTo()` Returns the carbon-copy recipient(s) of the message as a String containing all such recipients just as contained in the email message.
`StringVector`	`getCopiesToList()` Returns the carbon-copy recipient addressess in a StringVector, one recipient per element.
`java.lang.String`	`getDate()` Returns the date of the message.
`boolean`	`getDeletion()` Returns true if the message has been marked for deletion.
`FileName`	`getFromFolder()` Returns the filename of the folder (mailbox) from which the message was createTool.
`java.lang.String`	`getID()` Returns the ID of the message.
`boolean`	`getLock()` Returns the value of the lock parameter
`FileName`	`getMailRoot()` Returns the filename of the directory that is the root of the mail file system from which this message came.
`java.lang.String`	`getMIME()` Returns the MIME attachment, as encoded in the message.
`int`	`getMIMELocation()` Returns the character index location where the MIME attachment begins after the main body text.
`java.lang.String`	`getRecipient()` Returns the recipient(s) of the message as a String containing all recipients, just as given in the email message.
`StringVector`	`getRecipientList()` Returns the recipient addresses in a StringVector, one recipient per element.
`java.lang.String`	`getSender()` Returns the sender of the message.
`StringVector`	`getSenderList()` Returns the sender of the message as a StringVector with one element.
`java.lang.String`	`getSubject()` Returns the subject of the message.
`StringVector`	`getToFolders()` Returns the list of filenames of the folders (mailboxes) into which the message should be written.
`void`	`inputFromStream(java.io.BufferedReader dis)` Used when Triana types want to be able to receive ASCII data from the output of other programs.
`boolean`	`isDamaged()` Returns true if the message has been marked as damaged.
`void`	`lock()` Locks the message so it cannot be edited.
`void`	`outputToStream(java.io.PrintWriter dos)` Used when Triana types want to be able to send ASCII data to other programs using strings.
`static StringVector`	`parseAddress(java.lang.String fullAddress)` Parses a String containing a single recipient address into the email address (the part containing the @ symbol) and the name of the person, if it exists.
`java.util.Date`	`parseDate(java.text.SimpleDateFormat s)`
`void`	`setBlindCopiesTo(java.lang.String newBlindCopiesTo)` Sets the blind (hidden) carbon-copy recipient(s) of the message.
`void`	`setBodyLocation(int newBody)` Sets the character index at which the message starts, after the header.
`void`	`setCopiesTo(java.lang.String newCopiesTo)` Sets the carbon-copy recipient(s) of the message.
`void`	`setDamaged(boolean dam)` Sets the boolean flag that marks the message as damaged.
`void`	`setDate(java.lang.String newDate)` Sets the date of the message.
`void`	`setDeletion(boolean del)` Sets the boolean flag that deletes the message.
`void`	`setFromFolder(FileName fn)` Sets the filename of the folder (mailbox) from which the message was createTool.
`void`	`setID(java.lang.String newID)` Sets the ID of the message.
`boolean`	`setMailRoot(FileName fn)` Sets the filename of the directory that is the root of the mail file system from which this message came.
`void`	`setMIMELocation(int newMIME)` Sets the character index at which the MIME attachment starts, after the body text.
`void`	`setRecipient(java.lang.String newRecipient)` Sets the recipient(s) of the message.
`void`	`setSender(java.lang.String newSender)` Sets the sender of the message.
`void`	`setSubject(java.lang.String newSubject)` Sets the subject of the message.
`void`	`setToFolders(StringVector to)` Sets the list of filenames of the folders (mailboxes) into which the message should be written.
`java.lang.String`	`toString()` Provides the toString method for completeness.
`void`	`unlock()` Unlocks the message so it can be edited.

Methods inherited from class triana.types.Document
add, addCharGroupsLayer, addLine, addLineNumber, containedInCharGroup, containedInCharGroup, copyData, countLines, cutGroupString, cutString, deleteCharGroups, deleteLineNumber, deleteLineNumbers, domainOfCharGroup, existCharGroups, findNext, findNext, findNextInGroup, findNextInGroup, getCharGroup, getCharGroups, getCharGroups, getCharGroupsComplement, getCharGroupStack, getDomain, getFile, getFileNoPath, getFileRef, getFileType, getGroupString, getLineNumber, getLineNumbers, getPath, getString, getText, insertString, insertStringAsCharGroup, isLineNumber, isTextHTML, length, listCharGroups, listCharGroups, listGroupStrings, listGroupStrings, listGroupStringsNoDelims, listLineNumbers, listLineNumbersAndLines, nextCharGroup, nextCharGroup, nextLineNo, prevCharGroup, prevCharGroup, remove, remove, removeCharGroup, removeCharGroups, replaceAll, replaceGroupString, replaceNext, replaceNext, replaceString, setCharGroup, setCharGroups, setFile, setFile, setLineNumbers, setText, shiftCharGroups, shiftLineNumbers, updateObsoletePointers

Methods inherited from class triana.types.TrianaType
containerSize, dataExists, deleteFromContainer, getDataContainer, getFromContainer, getSequenceNumber, insertIntoContainer, inspectDataContainer, setDataContainer, setSequenceNumber

Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - MailMsg
```
public MailMsg()
```
    Constructs an empty MailMsg.
  - MailMsg
```
public MailMsg(java.lang.String message,
       FileName file)
```
    Constructs a MailMsg from an input mail message, complete with header and MIME attachments, and the name of the file from which it was createTool. It is locked to createTool-only: it cannot be modified. Various header data are createTool and set, but it is not inspected for consistency of its MIME attachments.
    
    Parameters:
    message - The email message, with its header
- Method Detail
  - parseDate
```
public java.util.Date parseDate(java.text.SimpleDateFormat s)
```
  - getSender
```
public java.lang.String getSender()
```
    Returns the sender of the message.
    
    Returns:
    String The sender as contained in the message
  - getSenderList
```
public StringVector getSenderList()
```
    Returns the sender of the message as a StringVector with one element.
    
    Returns:
    StringVector The sender as contained in the message
  - setSender
```
public void setSender(java.lang.String newSender)
```
    Sets the sender of the message. This only works if the message is not createTool-only.
    
    Parameters:
    newSender - The sender to be set into the message
  - getDate
```
public java.lang.String getDate()
```
    Returns the date of the message.
    
    Returns:
    String The date as contained in the message
  - setDate
```
public void setDate(java.lang.String newDate)
```
    Sets the date of the message. This only works if the message is not createTool-only.
    
    Parameters:
    newDate - The date to be set into the message
  - getRecipient
```
public java.lang.String getRecipient()
```
    Returns the recipient(s) of the message as a String containing all recipients, just as given in the email message.
    
    Returns:
    String The recipient(s) as contained in the message
  - getRecipientList
```
public StringVector getRecipientList()
```
    Returns the recipient addresses in a StringVector, one recipient per element. This method separates the recipients String into separate addresses by dividing it at commas that are not contained inside quotation marks or brackets.
    
    Returns:
    StringVector The individual addresses as a list
  - setRecipient
```
public void setRecipient(java.lang.String newRecipient)
```
    Sets the recipient(s) of the message. This only works if the message is not createTool-only.
    
    Parameters:
    newRecipient - The recipient(s) to be set into the message
  - getCopiesTo
```
public java.lang.String getCopiesTo()
```
    Returns the carbon-copy recipient(s) of the message as a String containing all such recipients just as contained in the email message.
    
    Returns:
    String The carbon-copy recipient(s) as contained in the message
  - getCopiesToList
```
public StringVector getCopiesToList()
```
    Returns the carbon-copy recipient addressess in a StringVector, one recipient per element. This method separates the recipients String into separate addresses by dividing it at commas that are not contained inside quotation marks or brackets.
    
    Returns:
    StringVector The individual addresses as a list
  - setCopiesTo
```
public void setCopiesTo(java.lang.String newCopiesTo)
```
    Sets the carbon-copy recipient(s) of the message. This only works if the message is not createTool-only.
    
    Parameters:
    newCopiesTo - The carbon-copy recipient(s) to be set into the message
  - getBlindCopiesTo
```
public java.lang.String getBlindCopiesTo()
```
    Returns the blind (hidden) carbon-copy recipient(s) of the message as a String containing all such recipients, exactly as in the email message.
    
    Returns:
    String The blind carbon-copy recipient(s) as contained in the message
  - getBlindCopiesToList
```
public StringVector getBlindCopiesToList()
```
    Returns the blind (hidden) recipient addressess in a StringVector, one recipient per element. This method separates the recipients String into separate addresses by dividing it at commas that are not contained inside quotation marks or brackets.
    
    Returns:
    StringVector The individual addresses as a list
  - setBlindCopiesTo
```
public void setBlindCopiesTo(java.lang.String newBlindCopiesTo)
```
    Sets the blind (hidden) carbon-copy recipient(s) of the message. This only works if the message is not createTool-only.
    
    Parameters:
    newBlindCopiesTo - The blind carbon-copy recipient(s) to be set into the message
  - addressList
```
public StringVector addressList(java.lang.String addresses)
```
    Attempts to separate the input String into addresses of email recipients. It assumes that the input list consists of such addresses separated by commas. The method ignores commas contained within quotation marks or brackets, which could be used as part of a recipient's name. It is not confused by umlauts of the form given in the global variable umlaut.
    
    Parameters:
    addresses - The input newline- and comma-separated list of addresses
    
    Returns:
    The individual addresses as a List
  - getSubject
```
public java.lang.String getSubject()
```
    Returns the subject of the message.
    
    Returns:
    String The subject as contained in the message
  - setSubject
```
public void setSubject(java.lang.String newSubject)
```
    Sets the subject of the message. This only works if the message is not createTool-only.
    
    Parameters:
    newSubject - The subject to be set into the message
  - getID
```
public java.lang.String getID()
```
    Returns the ID of the message.
    
    Returns:
    String The ID as contained in the message
  - setID
```
public void setID(java.lang.String newID)
```
    Sets the ID of the message. This only works if the message is not createTool-only.
    
    Parameters:
    newID - The ID to be set into the message
  - setMailRoot
```
public boolean setMailRoot(FileName fn)
```
    Sets the filename of the directory that is the root of the mail file system from which this message came.
    
    Parameters:
    fn - The FileName of the directory that is the mail system root
    
    Returns:
    boolean True if the input name is a directory, false if not
  - getMailRoot
```
public FileName getMailRoot()
```
    Returns the filename of the directory that is the root of the mail file system from which this message came.
    
    Returns:
    FileName of the directory of the root of the mail system
  - setFromFolder
```
public void setFromFolder(FileName fn)
```
    Sets the filename of the folder (mailbox) from which the message was createTool.
    
    Parameters:
    fn - The file which contained the message when it was created
  - getFromFolder
```
public FileName getFromFolder()
```
    Returns the filename of the folder (mailbox) from which the message was createTool.
    
    Returns:
    FileName The file which contained the message when it was created
  - setToFolders
```
public void setToFolders(StringVector to)
```
    Sets the list of filenames of the folders (mailboxes) into which the message should be written.
    
    Parameters:
    to - The file into which the message should be written
  - addToFolder
```
public void addToFolder(java.lang.String fn)
```
    Adds to the list toFolders a foldername (just a String ) of the folder (mailbox) into which the message should be written.
    
    Parameters:
    fn - The file into which the message should be written
  - addToFolders
```
public void addToFolders(StringVector fns)
```
    Adds to the list toFolders a StringVector of foldernames of the folders (mailboxes) into which the message should be written.
    
    Parameters:
    fns - The file into which the message should be written
  - getToFolders
```
public StringVector getToFolders()
```
    Returns the list of filenames of the folders (mailboxes) into which the message should be written.
    
    Returns:
    LinkedList The list of files into which the message should be written
  - copyToFolders
```
public StringVector copyToFolders()
```
    Returns a copy-by-value of the list of filenames of the folders (mailboxes) into which the message should be written.
    
    Returns:
    LinkedList The list of files into which the message should be written
  - getDeletion
```
public boolean getDeletion()
```
    Returns true if the message has been marked for deletion.
    
    Returns:
    True if message is to be deleted
  - setDeletion
```
public void setDeletion(boolean del)
```
    Sets the boolean flag that deletes the message.
    
    Parameters:
    del - True if the message is to be deleted
  - isDamaged
```
public boolean isDamaged()
```
    Returns true if the message has been marked as damaged.
    
    Returns:
    True if message is damaged
  - setDamaged
```
public void setDamaged(boolean dam)
```
    Sets the boolean flag that marks the message as damaged.
    
    Parameters:
    dam - True if the message is damaged
  - getBodyLocation
```
public int getBodyLocation()
```
    Returns the character index location where the message body begins after the header.
    
    Returns:
    int The start of the message
  - setBodyLocation
```
public void setBodyLocation(int newBody)
```
    Sets the character index at which the message starts, after the header. This only works if the message is not createTool-only.
    
    Parameters:
    newBody - The starting character of the message body
  - getMIMELocation
```
public int getMIMELocation()
```
    Returns the character index location where the MIME attachment begins after the main body text.
    
    Returns:
    int The start of the MIME attachment
  - setMIMELocation
```
public void setMIMELocation(int newMIME)
```
    Sets the character index at which the MIME attachment starts, after the body text. This only works if the message is not createTool-only.
    
    Parameters:
    newMIME - The starting character of the MIME attachment
  - getLock
```
public boolean getLock()
```
    Returns the value of the lock parameter
    
    Returns:
    boolean True if message is createTool-only
  - unlock
```
public void unlock()
```
    Unlocks the message so it can be edited.
  - lock
```
public void lock()
```
    Locks the message so it cannot be edited.
  - getBody
```
public java.lang.String getBody()
```
    Returns the message body, without the header, including any MIME attachments.
    
    Returns:
    String The message body without the header but with attachments
  - getBodyNoMIME
```
public java.lang.String getBodyNoMIME()
```
    Returns the message body, without the header or MIME attachments.
    
    Returns:
    String The message body without the header or attachments
  - getMIME
```
public java.lang.String getMIME()
```
    Returns the MIME attachment, as encoded in the message.
    
    Returns:
    String The encoded MIME attachment
  - checkMIME
```
public boolean checkMIME()
```
    Checks MIME attachments to see if the delimiters are consistent.
    
    Returns:
    boolean True if the MIME attachments seem consistent
  - parseAddress
```
public static StringVector parseAddress(java.lang.String fullAddress)
```
    Parses a String containing a single recipient address into the email address (the part containing the @ symbol) and the name of the person, if it exists. These parts are placed in this order into the two elements of the StringVector that is returned. The input String can be an element of the StringVector returned by getRecipientList(), for example.
    The method finds the email address by looking for the first
    
    Parameters:
    fullAddress - The input String containing the full address
    
    Returns:
    Contains two Strings, the first being the address and the second the interpreted name
  - filenameFromName
```
public static java.lang.String filenameFromName(java.lang.String nameIn)
```
    Creates a filename in a standard format from an input personal name. The personal name can have many standard forms. The filename will be in the form LastnameFirstinitials with no spaces, and where "Lastname" includes name parts like "von" or "de", while "Firstinitials" is made from all given names separated from the part of the input name containing the elements of "Lastname". (Initials are included without punctuation.)
    This can be used to construct a filename automatically for email addresses from a given sender. The input personal name could be taken from the output of parseAddress.
    
    Parameters:
    nameIn - Input personal name
    
    Returns:
    filename Output file name in standard form
  - equals
```
public boolean equals(java.lang.Object doc)
```
    Returns true if the specified object doc is the same type and has the same contents as this object, including the path name and file name. This tests all the auxilliary data, such as subject, etc, but it does not test the deletion or damaged flags, nor does it test the source folder (fromFolder) or destination folders (toFoilders). This allows it to compare messages that may have come from different locations or are destined for different locations.
    
    Overrides:
    
    equals in class Document
    
    Returns:
    Boolean true if the argument is a Document with the same contents as this Document
  - copyMe
```
public TrianaType copyMe()
```
    This is one of the most important methods of Triana data. types. It returns a copy of the type invoking it. This must be overridden for every derived data type derived. If not, the data cannot be copied to be given to other units. Copying must be done by value, not by reference.
    To override, the programmer should not invoke the super.copyMe method. Instead, create an object of the current type and call methods copyData and copyParameters. If these have been written correctly, then they will do the copying. The code should createTool, for type YourType:
```
 YourType y = null; try { y =
 (YourType)getClass().newInstance(); y.copyData( this ); y.copyParameters( this ); y.setLegend( this.getLegend()
 ); } catch (IllegalAccessException ee) { System.out.println("Illegal Access: " + ee.getMessage()); } catch
 (InstantiationException ee) { System.out.println("Couldn't be instantiated: " + ee.getMessage()); } return y;
 
```
    The copied object's data should be identical to the original. The method here modifies only one item: a String indicating that the object was created as a copy is added to the description StringVector.
    Overrides:
    
    copyMe in class Document
    
    Returns:
    TrianaType Copy by value of the current Object except for an updated description
  - copyParameters
```
public void copyParameters(TrianaType source)
```
    Copies modifiable parameters from the given source.
    
    Overrides:
    
    copyParameters in class Document
    
    Parameters:
    source - The Document object being copied
  - outputToStream
```
public void outputToStream(java.io.PrintWriter dos)
                    throws java.io.IOException
```
    Used when Triana types want to be able to send ASCII data to other programs using strings. This is used to implement socket and to run other executables, written in C or other languages. With ASCII you don't have to worry about ENDIAN'ness as the conversions are all done via text. This is obviously slower than binary communication since you have to format the input and output within the other program.
    This method must be overridden in every subclass that defines new data or parameters. The overriding method should first call
```
 super.outputToStream(dos) 
```
    to get output from superior classes, and then new parameters defined for the current subclass must be output. Moreover, subclasses that first dimension their data arrays must explicitly transfer these data arrays.
    Specified by:
    
    outputToStream in interface AsciiComm
    
    Overrides:
    
    outputToStream in class Document
    
    Parameters:
    dos - The data output stream
    
    Throws:
    
    java.io.IOException
  - inputFromStream
```
public void inputFromStream(java.io.BufferedReader dis)
                     throws java.io.IOException
```
    Used when Triana types want to be able to receive ASCII data from the output of other programs. This is used to implement socket and to run other executables, written in C or other languages. With ASCII you don't have to worry about ENDIAN'ness as the conversions are all done via text. This is obviously slower than binary communication since you have to format the input and output within the other program.
    This method must be overridden in every subclass that defines new data or parameters. The overriding method should first call
```
 super.inputFromStream(dis) 
```
    to get input from superior classes, and then new parameters defined for the current subclass must be input. Moreover, subclasses that first dimension their data arrays must explicitly transfer these data arrays.
    Specified by:
    
    inputFromStream in interface AsciiComm
    
    Overrides:
    
    inputFromStream in class Document
    
    Parameters:
    dis - The data input stream
    
    Throws:
    
    java.io.IOException
  - toString
```
public java.lang.String toString()
```
    Description copied from class: Document
    
    Provides the toString method for completeness. Synonym for getText.
    
    Overrides:
    
    toString in class Document
    
    Returns:
    String the contents of this Document

Class MailMsg

Field Summary

Fields inherited from class triana.types.TrianaType

Constructor Summary

Method Summary

Methods inherited from class triana.types.Document

Methods inherited from class triana.types.TrianaType

Methods inherited from class java.lang.Object

Constructor Detail

MailMsg

MailMsg

Method Detail

parseDate

getSender

getSenderList

setSender

getDate

setDate

getRecipient

getRecipientList

setRecipient

getCopiesTo

getCopiesToList

setCopiesTo

getBlindCopiesTo

getBlindCopiesToList

setBlindCopiesTo

addressList

getSubject

setSubject

getID

setID

setMailRoot

getMailRoot

setFromFolder

getFromFolder

setToFolders

addToFolder

addToFolders

getToFolders

copyToFolders

getDeletion

setDeletion

isDamaged

setDamaged

getBodyLocation

setBodyLocation

getMIMELocation

setMIMELocation

getLock

unlock

lock

getBody

getBodyNoMIME

getMIME

checkMIME

parseAddress

filenameFromName

equals

copyMe

copyParameters

outputToStream

inputFromStream

toString