i_adminsmtpclient.java

java开源的企业总线.xmlBlaster

/*------------------------------------------------------------------------------
Name:      I_AdminSmtpClient.java
Project:   xmlBlaster.org
Copyright: xmlBlaster.org, see xmlBlaster-LICENSE file
Comment:   Interface to access information about a client instance
------------------------------------------------------------------------------*/
package org.xmlBlaster.util.admin;

/**
 * Declares available methods to control the POP3 email poller.  
 *
 * @author [e-mail]
 * @since 1.0.8
 * @see org.xmlBlaster.util.protocol.email.SmtpClient
 */
public interface I_AdminSmtpClient extends I_AdminUsage {
   /** 
    * Force the MsgUnit attachment to always be base64 encoded.
    * @return Force base64
    */
   public boolean isContentForceBase64();
   
   /** 
    * Setting this to true we can force the MsgUnit attachment to
    * always be base64 encoded.
    * <br />
    * Javamail does base64 encoding automatically if need so
    * the default of this variable is false.
    * @param contentForceBase64
    */
   public void setContentForceBase64(boolean contentForceBase64);
   
   /**
    * @return Returns the messageIdForceBase64.
    */
   public boolean isMessageIdForceBase64();
   
   /** 
    * Setting this to true we can force the messageId attachment to
    * always be base64 encoded.
    * <br />
    * Javamail does base64 encoding automatically if need so
    * the default of this variable is false.
    */
   public void setMessageIdForceBase64(boolean messageIdForceBase64);

   /**
    * If the message to send has an expiry date and this
    * addExpiresHeader=true we send an 'Expires:' header in the email
    * (Expiry Date Indication). 
    * <br />
    * Supported as new RFC 822 header (Expires:).  In general, no
    * automatic action can be expected by MTAs.
    * <br />
    * Defaults to true.
    * @see http://www.faqs.org/rfcs/rfc2156.html
    */
   public boolean isAddExpiresHeader();

   /**
    * Add 'Expires:' email header. 
    * If the message to send has an expiry date and this
    * addExpiresHeader=true we send an 'Expires:' header in the email
    * (Expiry Date Indication). 
    * <br />
    * Supported as new RFC 822 header (Expires:).  In general, no
    * automatic action can be expected by MTAs.
    * <br />
    * Defaults to true.
    * @see http://www.faqs.org/rfcs/rfc2156.html
    */
   public void setAddExpiresHeader(boolean addExpiresHeader);
   
   /**
    * Defaults to false. 
    * @return Returns the breakLongMessageIdLine.
    */
   public boolean isBreakLongMessageIdLine();

   /**
    * Defaults to false. 
    * If set to true tries to keep the &lt;messageId> markup in lines
    * shorter than 72 characters.
    * @param breakLongMessageIdLine The breakLongMessageIdLine to set.
    */
   public void setBreakLongMessageIdLine(boolean breakLongMessageIdLine);

   /**
    * Access the SMTP access uri,
    * for example "smtp://aUser:[e-mail]:25"
    * @return The SMTP server uri
    */
   public String getSmtpUrl();

   /**
    * @param uri For example "smtp://aUser:[e-mail]:25"
    */
   public void setSmtpUrl(String uri);
   
   /**
    * mail.smtp.timeout
    * Socket I/O timeout value in milliseconds. Default is infinite timeout.
    */
   public int getSmtpIoTimeout();

   /**
    * mail.smtp.connectiontimeout
    * Socket connection timeout value in milliseconds. Default is infinite timeout.
    */
   public int getSmtpConnectionTimeout();
}