Class MailTool


  • public class MailTool
    extends java.lang.Object
    Mail toolbox
    Usage (from a business object) MailTool mail = new MailTool(getGrant()); mail.addRcpt("contact@simplicite.fr"); mail.setSubject("Test Template"); mail.addAttach(this, getField("fileAttribute")); mail.setBody("<p>Hello World</p>"); mail.send();
    • Constructor Summary

      Constructors 
      Constructor Description
      MailTool()
      Default contructor (using system admin grant)
      MailTool​(Grant g)
      Constructor
    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      void addAttach​(Mail.MailAttach att)
      Add attachment
      void addAttach​(ObjectDB obj, ObjectField field)
      Add attachment from object document or image field
      void addBcc​(java.lang.String addr)
      Add a blind copy address
      void addBcc​(java.lang.String[] addrs)
      Add several blind copy addresses
      void addBcc​(java.util.List<java.lang.String> addrs)
      Add several blind copy addresses
      void addCc​(java.lang.String addr)
      Add a copy address
      void addCc​(java.lang.String[] addrs)
      Add several copy addresses
      void addCc​(java.util.List<java.lang.String> addrs)
      Add several copy addresses
      java.lang.String addImage​(Mail.MailImage img)
      Add inlined image
      java.lang.String addImage​(ObjectDB obj, ObjectField field)
      Add inlined image from object document or image field
      void addRcpt​(java.lang.String addr)
      Add a recipient address
      void addRcpt​(java.lang.String[] addrs)
      Add several recipient addresses
      void addRcpt​(java.util.List<java.lang.String> addrs)
      Add several recipient addresses
      java.lang.String convertImages​(java.lang.String c, java.lang.String format)
      Replace inlined data images with cid and attachments
      Mail getMail()
      Get mailer
      void send()
      Send
      void setBody​(java.lang.String b)
      Set body
      void setContent​(java.lang.String c)
      Deprecated.
      Use setBody
      void setFrom​(java.lang.String addr)
      Set from address
      void setReplyTo​(java.lang.String addr)
      Set reply to address
      void setSubject​(java.lang.String s)
      Set subject
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • MailTool

        public MailTool()
        Default contructor (using system admin grant)
      • MailTool

        public MailTool​(Grant g)
        Constructor
        Parameters:
        g - Grant (null means using system admin grant)
    • Method Detail

      • getMail

        public final Mail getMail()
        Get mailer
        Returns:
        Mailer
      • setFrom

        public final void setFrom​(java.lang.String addr)
        Set from address
        Parameters:
        addr - Address
      • setReplyTo

        public final void setReplyTo​(java.lang.String addr)
        Set reply to address
        Parameters:
        addr - Address
      • addRcpt

        public final void addRcpt​(java.lang.String addr)
        Add a recipient address
        Parameters:
        addr - Address
      • addRcpt

        public final void addRcpt​(java.lang.String[] addrs)
        Add several recipient addresses
        Parameters:
        addrs - Addresses
      • addRcpt

        public final void addRcpt​(java.util.List<java.lang.String> addrs)
        Add several recipient addresses
        Parameters:
        addrs - Addresses
      • addCc

        public final void addCc​(java.lang.String addr)
        Add a copy address
        Parameters:
        addr - Address
      • addCc

        public final void addCc​(java.lang.String[] addrs)
        Add several copy addresses
        Parameters:
        addrs - Addresses
      • addCc

        public final void addCc​(java.util.List<java.lang.String> addrs)
        Add several copy addresses
        Parameters:
        addrs - Addresses
      • addBcc

        public final void addBcc​(java.lang.String addr)
        Add a blind copy address
        Parameters:
        addr - Address
      • addBcc

        public final void addBcc​(java.lang.String[] addrs)
        Add several blind copy addresses
        Parameters:
        addrs - Addresses
      • addBcc

        public final void addBcc​(java.util.List<java.lang.String> addrs)
        Add several blind copy addresses
        Parameters:
        addrs - Addresses
      • addAttach

        public final void addAttach​(Mail.MailAttach att)
        Add attachment
        Parameters:
        att - Attachment
      • addAttach

        public final void addAttach​(ObjectDB obj,
                                    ObjectField field)
        Add attachment from object document or image field
        Parameters:
        obj - Object
        field - Field
      • addImage

        public final java.lang.String addImage​(Mail.MailImage img)
        Add inlined image
        Parameters:
        img - Inlined image
        Returns:
        Inlined image reference ID
      • addImage

        public final java.lang.String addImage​(ObjectDB obj,
                                               ObjectField field)
        Add inlined image from object document or image field
        Parameters:
        obj - Object
        field - Field
        Returns:
        Inlined image reference ID
      • convertImages

        public java.lang.String convertImages​(java.lang.String c,
                                              java.lang.String format)
        Replace inlined data images with cid and attachments
        Parameters:
        c - html content with data images <img src="data:image/png;base64,..." />
        format - image format (default png)
        Returns:
        converted content with <img src="cid:..." />
      • setSubject

        public final void setSubject​(java.lang.String s)
        Set subject
        Parameters:
        s - Subject
      • setContent

        @Deprecated(forRemoval=false,
                    since="4.0")
        public void setContent​(java.lang.String c)
        Deprecated.
        Use setBody
      • setBody

        public void setBody​(java.lang.String b)
        Set body
        Parameters:
        b - Body
      • send

        public final void send()
        Send