Class MailConfiguration

  • All Implemented Interfaces:
    Serializable

    public class MailConfiguration
    extends Object
    implements Serializable
    This class represents the configuration information of the JavaMail Session object within Java EE.
    See Also:
    Serialized Form
    • Constructor Detail

      • MailConfiguration

        public MailConfiguration​(String username,
                                 String mailFrom,
                                 String mailHost)
        Construct a specification of mail configuration with the given username, Mail From Address and mail hostname.
        Parameters:
        the - username.
        the - from address.
        the - mail hostname.
      • MailConfiguration

        public MailConfiguration​(MailResourceIntf mailRes)
        Construct a specification of mail configuration.
    • Method Detail

      • getUsername

        public String getUsername()
        Get the username for the mail session the server will provide.
        Returns:
        the username.
      • getPassword

        public String getPassword()
        Get the password for the mail session the server will provide.
        Returns:
        the password.
      • getAuth

        public boolean getAuth()
        Get whether authentication is enabled for the mail session the server will provide
        Returns:
        the authentication status.
      • getMailFrom

        public String getMailFrom()
        Get the mail from address for the mail session the server will provide.
        Returns:
        the from address.
      • getMailHost

        public String getMailHost()
        Get the mail hostname for the mail session the server will provide.
        Returns:
        the hostname of the mail server.
      • getMailStoreProtocol

        public String getMailStoreProtocol()
        Get the default Message Access Protocol for the mail session the server will provide.
        Returns:
        the store protocol of the mail server.
      • getMailTransportProtocol

        public String getMailTransportProtocol()
        Get the default Transport Protocol for the mail session the server will provide.
        Returns:
        the transport protocol of the mail server.
      • getMailStoreProtocolClass

        public String getMailStoreProtocolClass()
        Get the default Message Access Protocol class for the mail session the server will provide.
        Returns:
        the store protocol of the mail server.
      • getMailTransportProtocolClass

        public String getMailTransportProtocolClass()
        Get the default Transport Protocol class for the mail session the server will provide.
        Returns:
        the transport protocol of the mail server.
      • getMailDebug

        public boolean getMailDebug()
        Get the mail debug flag for the mail session the server will provide.
        Returns:
        the debug flag of the mail server.
      • getDescription

        public String getDescription()
        Get the mail description for the mail session the server will provide.
        Returns:
        the description of the mail server.
      • getJndiName

        public String getJndiName()
        Get the mail JNDI name for the mail session the server will provide.
        Returns:
        the JNDI name of the mail server.
      • getEnabled

        public boolean getEnabled()
        Get the mail enable flag for the mail session the server will provide.
        Returns:
        the enable flag of the mail server.
      • getMailProperties

        public Properties getMailProperties()
        Get the mail session properties as per JavaMail.
        Returns:
        the mail session properties.
      • print

        public void print​(StringBuilder toStringBuilder)
        A formatted representation of my state.