Class Mailbox

java.lang.Object
org.apache.james.mime4j.dom.address.Address
org.apache.james.mime4j.dom.address.Mailbox
All Implemented Interfaces:
Serializable
public class Mailbox extends Address
Represents a single e-mail address.
See Also:

  • Field Details

    • serialVersionUID

      private static final long serialVersionUID
      See Also:

    • EMPTY_ROUTE_LIST

      private static final DomainList EMPTY_ROUTE_LIST

    • name

      private final String name

    • route

      private final DomainList route

    • localPart

      private final String localPart

    • domain

      private final String domain

  • Constructor Details

    • Mailbox

      public Mailbox(String name, DomainList route, String localPart, String domain)
      Creates a named mailbox with a route. Routes are obsolete.
      Parameters:
      name - the name of the e-mail address. May be null.
      route - The zero or more domains that make up the route. May be null.
      localPart - The part of the e-mail address to the left of the "@".
      domain - The part of the e-mail address to the right of the "@".

    • Mailbox

      Mailbox(String name, Mailbox baseMailbox)
      Creates a named mailbox based on an unnamed mailbox. Package private; internally used by Builder.

    • Mailbox

      public Mailbox(String localPart, String domain)
      Creates an unnamed mailbox without a route. Routes are obsolete.
      Parameters:
      localPart - The part of the e-mail address to the left of the "@".
      domain - The part of the e-mail address to the right of the "@".

    • Mailbox

      public Mailbox(DomainList route, String localPart, String domain)
      Creates an unnamed mailbox with a route. Routes are obsolete.
      Parameters:
      route - The zero or more domains that make up the route. May be null.
      localPart - The part of the e-mail address to the left of the "@".
      domain - The part of the e-mail address to the right of the "@".

    • Mailbox

      public Mailbox(String name, String localPart, String domain)
      Creates a named mailbox without a route. Routes are obsolete.
      Parameters:
      name - the name of the e-mail address. May be null.
      localPart - The part of the e-mail address to the left of the "@".
      domain - The part of the e-mail address to the right of the "@".

  • Method Details

    • getName

      public String getName()
      Returns the name of the mailbox or null if it does not have a name.

    • getRoute

      public DomainList getRoute()
      Returns the route list. If the mailbox does not have a route an empty domain list is returned.

    • getLocalPart

      public String getLocalPart()
      Returns the left part of the e-mail address (before "@").

    • getDomain

      public String getDomain()
      Returns the right part of the e-mail address (after "@").

    • getAddress

      public String getAddress()
      Returns the address in the form localPart@domain.
      Returns:
      the address part of this mailbox.

    • doAddMailboxesTo

      protected final void doAddMailboxesTo(List<Mailbox> results)
      Description copied from class: Address
      Adds any mailboxes represented by this address into the given List. Must be overridden by concrete subclasses.
      Specified by:
      doAddMailboxesTo in class Address

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object obj)
      Indicates whether some other object is "equal to" this mailbox.

      An object is considered to be equal to this mailbox if it is an instance of class Mailbox that holds the same address as this one. The domain is considered to be case-insensitive but the local-part is not (because of RFC 5321: the local-part of a mailbox MUST BE treated as case sensitive).

      Overrides:
      equals in class Object
      Parameters:
      obj - the object to test for equality.
      Returns:
      true if the specified object is a Mailbox that holds the same address as this one.

    • toString

      public String toString()
      Overrides:
      toString in class Object