Package org.opencms.mail

Class CmsSimpleMail

  • public class CmsSimpleMail
extends org.apache.commons.mail.SimpleEmail
    This class is used to send simple text internet email messages without attachments.

    It uses the Apache Commons Email API and extends the provided classes to conveniently generate emails using the OpenCms configuration.

    Since:
    6.0.0

    • Field Summary

      • Fields inherited from class org.apache.commons.mail.Email

        ATTACHMENTS, authenticator, bccList, bounceAddress, ccList, charset, content, CONTENT_TYPE, contentType, debug, EMAIL_BODY, EMAIL_SUBJECT, emailBody, FILE_SERVER, fromAddress, headers, hostName, ISO_8859_1, KOI8_R, MAIL_DEBUG, MAIL_HOST, MAIL_PORT, MAIL_SMTP_AUTH, MAIL_SMTP_CONNECTIONTIMEOUT, MAIL_SMTP_FROM, MAIL_SMTP_PASSWORD, MAIL_SMTP_SOCKET_FACTORY_CLASS, MAIL_SMTP_SOCKET_FACTORY_FALLBACK, MAIL_SMTP_SOCKET_FACTORY_PORT, MAIL_SMTP_TIMEOUT, MAIL_SMTP_USER, MAIL_TRANSPORT_PROTOCOL, MAIL_TRANSPORT_TLS, message, popBeforeSmtp, popHost, popPassword, popUsername, RECEIVER_EMAIL, RECEIVER_NAME, replyList, SENDER_EMAIL, SENDER_NAME, sentDate, SMTP, smtpPort, socketConnectionTimeout, socketTimeout, ssl, sslSmtpPort, subject, TEXT_HTML, TEXT_PLAIN, tls, toList, US_ASCII

    • Constructor Summary

      Constructors 
      Constructor Description
      CmsSimpleMail()
      Default constructor of a CmsSimpleMail.
      CmsSimpleMail​(CmsMailHost mailHost)
      Constructor of a CmsSimpleMail where the mail host is explicitly chosen.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String send()
      Overrides to add a better message for authentication exception.

      • Methods inherited from class org.apache.commons.mail.SimpleEmail

        setMsg

      • Methods inherited from class org.apache.commons.mail.Email

        addBcc, addBcc, addBcc, addBcc, addCc, addCc, addCc, addCc, addHeader, addReplyTo, addReplyTo, addReplyTo, addTo, addTo, addTo, addTo, buildMimeMessage, createMimeMessage, getBccAddresses, getBounceAddress, getCcAddresses, getFromAddress, getHeader, getHeaders, getHostName, getMailSession, getMimeMessage, getReplyToAddresses, getSentDate, getSmtpPort, getSocketConnectionTimeout, getSocketTimeout, getSslSmtpPort, getSubject, getToAddresses, isSendPartial, isSSL, isSSLCheckServerIdentity, isSSLOnConnect, isStartTLSEnabled, isStartTLSRequired, isTLS, sendMimeMessage, setAuthentication, setAuthenticator, setBcc, setBounceAddress, setCc, setCharset, setContent, setContent, setDebug, setFrom, setFrom, setFrom, setHeaders, setHostName, setMailSession, setMailSessionFromJNDI, setPopBeforeSmtp, setReplyTo, setSendPartial, setSentDate, setSmtpPort, setSocketConnectionTimeout, setSocketTimeout, setSSL, setSSLCheckServerIdentity, setSSLOnConnect, setSslSmtpPort, setStartTLSEnabled, setStartTLSRequired, setSubject, setTLS, setTo, toInternetAddressArray, updateContentType

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • CmsSimpleMail

        public CmsSimpleMail()
        Default constructor of a CmsSimpleMail.

        The mail host name and the mail from address are set to the OpenCms default values of the configuration.

      • CmsSimpleMail

        public CmsSimpleMail​(CmsMailHost mailHost)
        Constructor of a CmsSimpleMail where the mail host is explicitly chosen.

        The mail from address is set to the OpenCms default values of the configuration.

        Parameters:
        mailHost - the mail host to use (a host configured in OpenCms).

    • Method Detail

      • send

        public java.lang.String send()
        Overrides to add a better message for authentication exception.

        Overrides:
        send in class org.apache.commons.mail.Email
        See Also:
        Email.send()