Mail (Javadocs [I2P+ 2.13.0+] - API Version 0.9.70+)

java.lang.Object
- i2p.susi.webmail.Mail

Direct Known Subclasses:
Draft
```
class Mail
extends Object
```
Data structure representing a single email message for folder display and sorting.

Field Summary

Fields
Modifier and Type	Field and Description
`(package private) String[]`	`cc` addresses only, enclosed by `<>`
`String`	`contentType` Content-Type header value
`Date`	`date` The parsed message date
`String`	`dateOnly` Long date-only format for mail list tooltips
`String`	`dateString` Raw date string from the Date header
`String`	`error` Error message from parsing, or empty
`String`	`formattedDate` Formatted date string in UTC
`(package private) static byte[]`	`HEADER_MATCH` Also used by MailPart See MailPart for why we don't do \r\n\r\n
`String`	`localFormattedDate` Formatted date string in local time zone
`boolean`	`markForDeletion` Whether this message is flagged for deletion
`String`	`messageID` Message-ID as received, not HTML escaped
`String`	`quotedDate` Quoted date in local time zone, longer format
`String`	`reply` Address only, enclosed by `<>`.
`String`	`sender` As received, trimmed only, not HTML escaped
`String`	`shortSender` Sender name or address truncated with …
`String`	`shortSubject` Subject truncated with ….
`String`	`subject` As received, trimmed only, not HTML escaped.
`(package private) String[]`	`to` May be null.
`String`	`uidl` Unique ID assigned by the POP3 server

Constructor Summary
Constructors
Constructor and Description
Mail(String uidl)

Constructors
Constructor and Description
`Mail(String uidl)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`appendRecipients(PrintWriter out, String[] recipients, String prefix)` Adds all items from the array to the builder, separated by commas This is for display of a forwarded email.
`static void`	`appendRecipients(StringBuilder buf, ArrayList<String> recipients, String prefix)` Adds all items from the list to the builder, separated by tabs.
`static String`	`getAddress(String address)` Returns the first email address portion, enclosed by <>
`String`	`getAttachmentType()` Get the attachment type.
`Buffer`	`getBody()` This contains the header also.
`Buffer`	`getHeader()` This may or may not contain the body also.
`MailPart`	`getPart()` The parsed message part.
`static boolean`	`getRecipientsFromList(ArrayList<String> recipients, String[] ccs, boolean ok)` A little misnamed.
`static boolean`	`getRecipientsFromList(ArrayList<String> recipients, String text, boolean ok)` A little misnamed.
`long`	`getSize()`
`boolean`	`hasAttachment()` Whether the content type suggests an attachment.
`boolean`	`hasBody()` Whether the body has been loaded.
`boolean`	`hasHeader()`
`boolean`	`hasPart()` Whether the body has been parsed into a MailPart.
`boolean`	`isNew()` Whether this message is new (unread).
`boolean`	`isSpam()` Whether this message is identified as spam.
`void`	`setBody(Buffer rb)`
`void`	`setHeader(Buffer rb)`
`void`	`setNew(boolean isNew)`
`void`	`setSize(long size)`
`static boolean`	`validateAddress(String address)`

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

- Field Detail
  - cc
```
String[] cc
```
    addresses only, enclosed by <>
  - contentType
```
public String contentType
```
    Content-Type header value
  - date
```
public Date date
```
    The parsed message date
  - dateOnly
```
public String dateOnly
```
    Long date-only format for mail list tooltips
  - dateString
```
public String dateString
```
    Raw date string from the Date header
  - error
```
public String error
```
    Error message from parsing, or empty
  - formattedDate
```
public String formattedDate
```
    Formatted date string in UTC
  - HEADER_MATCH
```
static final byte[] HEADER_MATCH
```
    Also used by MailPart See MailPart for why we don't do \r\n\r\n
  - localFormattedDate
```
public String localFormattedDate
```
    Formatted date string in local time zone
  - markForDeletion
```
public boolean markForDeletion
```
    Whether this message is flagged for deletion
  - messageID
```
public String messageID
```
    Message-ID as received, not HTML escaped
  - quotedDate
```
public String quotedDate
```
    Quoted date in local time zone, longer format
  - reply
```
public String reply
```
    Address only, enclosed by <>.
  - sender
```
public String sender
```
    As received, trimmed only, not HTML escaped
  - shortSender
```
public String shortSender
```
    Sender name or address truncated with …
  - shortSubject
```
public String shortSubject
```
    Subject truncated with …. Default "".
  - subject
```
public String subject
```
    As received, trimmed only, not HTML escaped. Default "".
  - to
```
String[] to
```
    May be null. Non-empty if non-null. Not HTML escaped.
  - uidl
```
public final String uidl
```
    Unique ID assigned by the POP3 server
- Constructor Detail
  - Mail
```
public Mail(String uidl)
```
    Parameters:
    uidl - unique ID for this mail
- Method Detail
  - appendRecipients
```
public static void appendRecipients(PrintWriter out,
                                    String[] recipients,
                                    String prefix)
```
    Adds all items from the array to the builder, separated by commas This is for display of a forwarded email.
    Parameters:
    prefix - prepended to the addresses, includes trailing ": "
  - appendRecipients
```
public static void appendRecipients(StringBuilder buf,
                                    ArrayList<String> recipients,
                                    String prefix)
```
    Adds all items from the list to the builder, separated by tabs. This is for SMTP/POP.
    Parameters:
    buf - out param
    prefix - prepended to the addresses
  - getAddress
```
public static String getAddress(String address)
```
    Returns the first email address portion, enclosed by <>
    Parameters:
    address - the address
    Returns:
    the address enclosed in angle brackets, or null
  - getAttachmentType
```
public String getAttachmentType()
```
    Get the attachment type.
    Returns:
    the attachment type string
  - getBody
```
public Buffer getBody()
```
    This contains the header also.
    Returns:
    may be null
  - getHeader
```
public Buffer getHeader()
```
    This may or may not contain the body also.
    Returns:
    if null, nothing has been loaded yet for this UIDL
  - getPart
```
public MailPart getPart()
```
    The parsed message part.
    Returns:
    the parsed MailPart, or null
  - getRecipientsFromList
```
public static boolean getRecipientsFromList(ArrayList<String> recipients,
                                            String[] ccs,
                                            boolean ok)
```
    A little misnamed. Adds all addresses from the elements in text to the recipients list.
    Parameters:
    recipients - out param
    ccs - the Cc addresses
    ok - will be returned
    Returns:
    true if ALL e-mail addresses are valid AND the in parameter was true
  - getRecipientsFromList
```
public static boolean getRecipientsFromList(ArrayList<String> recipients,
                                            String text,
                                            boolean ok)
```
    A little misnamed. Adds all addresses from the comma-separated line in text to the recipients list.
    Parameters:
    text - comma-separated
    recipients - out param
    ok - will be returned
    Returns:
    true if ALL e-mail addresses are valid AND the in parameter was true
  - getSize
```
public long getSize()
```
    Returns:
    0 if unknown
  - hasAttachment
```
public boolean hasAttachment()
```
    Whether the content type suggests an attachment.
    Returns:
    true if the content type suggests an attachment
  - hasBody
```
public boolean hasBody()
```
    Whether the body has been loaded.
    Returns:
    true if body is loaded
  - hasHeader
```
public boolean hasHeader()
```
    Returns:
    if false, nothing has been loaded yet for this UIDL
  - hasPart
```
public boolean hasPart()
```
    Whether the body has been parsed into a MailPart.
    Returns:
    true if the body has been parsed into a MailPart
  - isNew
```
public boolean isNew()
```
    Whether this message is new (unread).
    Returns:
    true if mail is new (unread)
  - isSpam
```
public boolean isSpam()
```
    Whether this message is identified as spam.
    Returns:
    true if identified as spam
  - setBody
```
public void setBody(Buffer rb)
```
    Parameters:
    rb - buffer containing body data
  - setHeader
```
public void setHeader(Buffer rb)
```
    Parameters:
    rb - buffer containing header data
  - setNew
```
public void setNew(boolean isNew)
```
    Parameters:
    isNew - the new/unread flag
  - setSize
```
public void setSize(long size)
```
    Parameters:
    size - the message size
  - validateAddress
```
public static boolean validateAddress(String address)
```
    Parameters:
    address - E-mail address to be validated
    Returns:
    Is the e-mail address valid?

Class Mail

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

cc

contentType

date

dateOnly

dateString

error

formattedDate

HEADER_MATCH

localFormattedDate

markForDeletion

messageID

quotedDate

reply

sender

shortSender

shortSubject

subject

to

uidl

Constructor Detail

Mail

Method Detail

appendRecipients

appendRecipients

getAddress

getAttachmentType

getBody

getHeader

getPart

getRecipientsFromList

getRecipientsFromList

getSize

hasAttachment

hasBody

hasHeader

hasPart

isNew

isSpam

setBody

setHeader

setNew

setSize

validateAddress