Field Detail

• subjectLayout

  protected Layout<E> subjectLayout

• layout

  protected Layout<E> layout

• session

  protected Session session

• eventEvaluator

  protected EventEvaluator<E> eventEvaluator

• discriminator

  protected Discriminator<E> discriminator

• cbTracker

  protected CyclicBufferTracker<E> cbTracker

Constructor Detail

• SMTPAppenderBase

  public SMTPAppenderBase()

Method Detail

• makeSubjectLayout

  protected abstract Layout<E> makeSubjectLayout(String subjectStr)

  return a layout for the subject string as appropriate for the module. If the subjectStr parameter is null, then a default value for subjectStr should be used.

  Parameters:

  subjectStr -

  Returns:

  a layout as appropriate for the module

• start

  public void start()

  Start the appender

• append

  protected void append(E eventObject)

  Perform SMTPAppender specific appending actions, delegating some of them to a subclass and checking if the event triggers an e-mail to be sent.

• eventMarksEndOfLife

  protected abstract boolean eventMarksEndOfLife(E eventObject)

• subAppend

  protected abstract void subAppend(CyclicBuffer<E> cb,
                                    E eventObject)

• checkEntryConditions

  public boolean checkEntryConditions()

  This method determines if there is a sense in attempting to append.

  It checks whether there is a set output target and also if there is a set layout. If these checks fail, then the boolean value false is returned.

• stop

  public void stop()

• getToList

  public List<PatternLayoutBase<E>> getToList()

  Returns value of the toList option.

• sendBuffer

  protected void sendBuffer(CyclicBuffer<E> cb,
                            E lastEventObject)

  Send the contents of the cyclic buffer as an e-mail message.

• fillBuffer

  protected abstract void fillBuffer(CyclicBuffer<E> cb,
                                     StringBuffer sbuf)

• getFrom

  public String getFrom()

  Returns value of the From option.

• getSubject

  public String getSubject()

  Returns value of the Subject option.

• setFrom

  public void setFrom(String from)

  The From option takes a string value which should be a e-mail address of the sender.

• setSubject

  public void setSubject(String subject)

  The Subject option takes a string value which should be a the subject of the e-mail message.

• setSMTPHost

  public void setSMTPHost(String smtpHost)

  Alias for smtpHost

  Parameters:

  smtpHost -

• setSmtpHost

  public void setSmtpHost(String smtpHost)

  The smtpHost option takes a string value which should be a the host name of the SMTP server that will send the e-mail message.

• getSMTPHost

  public String getSMTPHost()

  Alias for getSmtpHost().

• getSmtpHost

  public String getSmtpHost()

  Returns value of the SMTPHost option.

• setSMTPPort

  public void setSMTPPort(int port)

  Alias for setSmtpPort(int).

  Parameters:

  port -

• setSmtpPort

  public void setSmtpPort(int port)

  The port where the SMTP server is running. Default value is 25.

  Parameters:

  port -

• getSMTPPort

  public int getSMTPPort()

  Alias for getSmtpPort()

  Returns:

• getSmtpPort

  public int getSmtpPort()

  See setSmtpPort(int)

  Returns:

• getLocalhost

  public String getLocalhost()

• setLocalhost

  public void setLocalhost(String localhost)

  Set the "mail.smtp.localhost" property to the value passed as parameter to this method.

  Useful in case the hostname for the client host is not fully qualified and as a consequence the SMTP server rejects the clients HELO/EHLO command.

  Parameters:

  localhost -

• getCyclicBufferTracker

  public CyclicBufferTracker<E> getCyclicBufferTracker()

• setCyclicBufferTracker

  public void setCyclicBufferTracker(CyclicBufferTracker<E> cbTracker)

• getDiscriminator

  public Discriminator<E> getDiscriminator()

• setDiscriminator

  public void setDiscriminator(Discriminator<E> discriminator)

• isAsynchronousSending

  public boolean isAsynchronousSending()

• setAsynchronousSending

  public void setAsynchronousSending(boolean asynchronousSending)

  By default, SMTAppender transmits emails asynchronously. For synchronous email transmission set asynchronousSending to 'false'.

  Parameters:

  asynchronousSending - determines whether sending is done asynchronously or not

  Since:

  1.0.4

• addTo

  public void addTo(String to)

• makeNewToPatternLayout

  protected abstract PatternLayoutBase<E> makeNewToPatternLayout(String toPattern)

• getToAsListOfString

  public List<String> getToAsListOfString()

• isSTARTTLS

  public boolean isSTARTTLS()

• setSTARTTLS

  public void setSTARTTLS(boolean startTLS)

• isSSL

  public boolean isSSL()

• setSSL

  public void setSSL(boolean ssl)

• setEvaluator

  public void setEvaluator(EventEvaluator<E> eventEvaluator)

  The EventEvaluator option takes a string value representing the name of the class implementing the EventEvaluator interface. A corresponding object will be instantiated and assigned as the event evaluator for the SMTPAppender.

• getUsername

  public String getUsername()

• setUsername

  public void setUsername(String username)

• getPassword

  public String getPassword()

• setPassword

  public void setPassword(String password)

• getCharsetEncoding

  public String getCharsetEncoding()

  Returns:

  the charset encoding value

  See Also:

  setCharsetEncoding(String)

• getJndiLocation

  public String getJndiLocation()

• setJndiLocation

  public void setJndiLocation(String jndiLocation)

  Set the location where a javax.mail.Session resource is located in JNDI. Default value is "java:comp/env/mail/Session".

  Parameters:

  jndiLocation -

  Since:

  1.0.6

• isSessionViaJNDI

  public boolean isSessionViaJNDI()

• setSessionViaJNDI

  public void setSessionViaJNDI(boolean sessionViaJNDI)

  If set to true, a javax.mail.Session resource will be retrieved from JNDI. Default is false.

  Parameters:

  sessionViaJNDI - whether to obtain a javax.mail.Session by JNDI

  Since:

  1.0.6

• setCharsetEncoding

  public void setCharsetEncoding(String charsetEncoding)

  Set the character set encoding of the outgoing email messages. The default encoding is "UTF-8" which usually works well for most purposes.

  Parameters:

  charsetEncoding -

• getLayout

  public Layout<E> getLayout()

• setLayout

  public void setLayout(Layout<E> layout)