Package com.simplicite.util

Class Mail

  • public class Mail
extends java.lang.Object
    Send emails thru standard mail service or Outlook thru Java Outlook Connector

    • Constructor Summary

      Constructors 
      Constructor Description
      Mail()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use constructor with grant argument
      Mail​(Grant grant)
      Constructor

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Mail.MailAttach documentAttach​(ObjectDB obj, ObjectField f)
      Build an attachment from the content of a document or image object field
      Mail.MailImage documentImage​(ObjectDB obj, ObjectField f)
      Build an inlined image from the content of a document or image field
      Mail.MailImage documentImage​(ObjectDB obj, ObjectField f, boolean thumbnail)
      Build an inlined image from the content of a document or image field
      static java.lang.String getAddressPart​(java.lang.String addr)
      Get the plain email address part of a full email address string
      static java.lang.String getNamePart​(java.lang.String addr)
      Get the plain name part of a full email address string
      static Mail.MailAttach getResourceAttach​(Grant g, java.lang.Object o, java.lang.String type, java.lang.String code)
      Build an attachment from a resource
      static Mail.MailImage getResourceImage​(Grant g, java.lang.Object o, java.lang.String type, java.lang.String code, boolean thumbnail)
      Get inlined image from a resource
      Mail.MailAttach objectAttach​(ObjectDB obj, java.lang.String templateName)
      Build an attachement from an object publication
      Mail.MailAttach resourceAttach​(ExternalObject ext, java.lang.String type, java.lang.String code)
      Build an attachment from an external object resource
      Mail.MailAttach resourceAttach​(ObjectDB obj, java.lang.String type, java.lang.String code)
      Buld an attachment from an object resource
      Mail.MailAttach resourceAttach​(java.lang.String type, java.lang.String code)
      Build an attachment from a disposition resource
      Mail.MailImage resourceIcon​(ExternalObject ext, java.lang.String code, boolean thumbnail)
      Build an inlined image from an external object icon resource
      Mail.MailImage resourceIcon​(ObjectDB obj, java.lang.String code, boolean thumbnail)
      Build an inlined image from an object icon resource
      Mail.MailImage resourceIcon​(java.lang.String code, boolean thumbnail)
      Build an inlined image from an icon disposition resource
      Mail.MailImage resourceImage​(ExternalObject ext, java.lang.String code, boolean thumbnail)
      Build an inlined image from an external object resource
      Mail.MailImage resourceImage​(ObjectDB obj, java.lang.String code, boolean thumbnail)
      Build an inlined image from an object resource
      Mail.MailImage resourceImage​(java.lang.String code, boolean thumbnail)
      Build an inlined image from a disposition resource
      boolean send​(java.lang.String[] to, java.lang.String from, java.lang.String[] cc, java.lang.String[] bcc, java.lang.String subject, java.lang.String body)
      Send a simple email thru JavaMail or Outlook client (when system param EMAIL_SEND_OUTLOOK = yes)
      boolean send​(java.lang.String[] to, java.lang.String from, java.lang.String[] cc, java.lang.String[] bcc, java.lang.String subject, java.lang.String body, java.lang.String mime)
      Send a simple email thru JavaMail or Outlook client (when system param EMAIL_SEND_OUTLOOK = yes)
      boolean send​(java.lang.String[] to, java.lang.String from, java.lang.String[] cc, java.lang.String subject, java.lang.String body)
      Send a simple email thru JavaMail or Outlook client (when system param EMAIL_SEND_OUTLOOK = yes)
      boolean send​(java.lang.String to, java.lang.String from, java.lang.String subject, java.lang.String body)
      Send a simple email thru JavaMail or Outlook client (when system param EMAIL_SEND_OUTLOOK = yes)
      boolean sendInvitation​(java.util.Date start, java.util.Date end, java.lang.String location, java.lang.String organizerEmail, java.lang.String organizerName, java.lang.String[] attendeeEmails, java.lang.String[] attendeeNames, java.lang.String[] ccAttendeeEmails, java.lang.String[] ccAttendeeNames, java.lang.String[] bccAttendeeEmails, java.lang.String[] bccAttendeeNames, java.lang.String summary, java.lang.String shortDescription, java.lang.String longDescription, Mail.MailAttach[] attachs)
      Send an invitation to an event to several attendees and several cc/bcc attendees
      boolean sendInvitation​(java.util.Date start, java.util.Date end, java.lang.String location, java.lang.String organizerEmail, java.lang.String organizerName, java.lang.String[] attendeeEmails, java.lang.String[] attendeeNames, java.lang.String summary, java.lang.String shortDescription, java.lang.String longDescription)
      Send an invitation to an event to several attendees
      boolean sendInvitation​(java.util.Date start, java.util.Date end, java.lang.String location, java.lang.String organizerEmail, java.lang.String organizerName, java.lang.String attendeeEmail, java.lang.String attendeeName, java.lang.String summary, java.lang.String shortDescription, java.lang.String longDescription)
      Send an invitation to an event to one attendee
      boolean sendWithAttach​(java.lang.String[] to, java.lang.String from, java.lang.String[] cc, java.lang.String[] bcc, java.lang.String subject, java.lang.String body, java.lang.String mime, java.lang.String[] files, Mail.MailAttach[] attachs)
      Send an email with attachments thru JavaMail or Outlook client (when system param EMAIL_SEND_OUTLOOK = yes)
      boolean sendWithAttach​(java.lang.String[] to, java.lang.String from, java.lang.String[] cc, java.lang.String[] bcc, java.lang.String subject, java.lang.String body, java.lang.String mime, java.lang.String[] files, Mail.MailAttach[] attachs, Mail.MailImage[] images)
      Send an email with attachments thru JavaMail or Outlook client (when system param EMAIL_SEND_OUTLOOK = yes)
      boolean sendWithAttach​(java.lang.String[] to, java.lang.String from, java.lang.String replyTo, java.lang.String[] cc, java.lang.String[] bcc, java.lang.String subject, java.lang.String body, java.lang.String mime, java.lang.String[] files, Mail.MailAttach[] attachs, Mail.MailImage[] images)
      Send an email with attachments thru JavaMail or Outlook client (when system param EMAIL_SEND_OUTLOOK = yes)
      boolean sendWithAttach​(java.lang.String to, java.lang.String from, java.lang.String cc, java.lang.String bcc, java.lang.String subject, java.lang.String body, java.lang.String mime, Mail.MailAttach[] attachs)
      Send an email with attachments thru JavaMail or Outlook client (when system param EMAIL_SEND_OUTLOOK = yes)
      boolean sendWithAttach​(java.lang.String to, java.lang.String from, java.lang.String cc, java.lang.String bcc, java.lang.String subject, java.lang.String body, java.lang.String mime, java.lang.String[] files)
      Send an email with attachments thru JavaMail or Outlook client (when system param EMAIL_SEND_OUTLOOK = yes)
      Mail.MailAttach vCalendarAttach​(VCalendarTool.VCalendarEvent[] events, Grant g)
      Build an attachement vCalendar
      Mail.MailAttach vCalendarAttach​(VCalendarTool.VCalendarEvent[] events, Grant g, java.lang.String attachName)
      Build a vCalendar attachement
      Mail.MailAttach vCalendarAttach​(VCalendarTool.VCalendarEvent event, Grant g)
      Build a vCalendar attachement

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • MAIL_MIME_TYPE_HTML

        public static final java.lang.String MAIL_MIME_TYPE_HTML
        HTML MIME type

      • MAIL_MIME_TYPE_TEXT

        public static final java.lang.String MAIL_MIME_TYPE_TEXT
        Plain text MIME type

    • Constructor Detail

      • Mail

        @Deprecated(forRemoval=true,
            since="4.0")
public Mail()
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use constructor with grant argument

      • Mail

        public Mail​(Grant grant)
        Constructor
        Parameters:
        grant - Grant (null means using system admin grant)

    • Method Detail

      • vCalendarAttach

        public Mail.MailAttach vCalendarAttach​(VCalendarTool.VCalendarEvent event,
                                       Grant g)
        Build a vCalendar attachement
        Parameters:
        event - Calendar event
        g - Grant (can be null then dates are generated as UTC)
        Returns:
        Mail attachment

      • vCalendarAttach

        public Mail.MailAttach vCalendarAttach​(VCalendarTool.VCalendarEvent[] events,
                                       Grant g)
        Build an attachement vCalendar
        Parameters:
        events - Calendar events
        g - Grant (can be null then dates are generated as UTC)
        Returns:
        Mail attachment

      • vCalendarAttach

        public Mail.MailAttach vCalendarAttach​(VCalendarTool.VCalendarEvent[] events,
                                       Grant g,
                                       java.lang.String attachName)
        Build a vCalendar attachement
        Parameters:
        events - Calendar events
        g - Grant (can be null then dates are generated as UTC)
        attachName - Attachement name (can be null then calendar.ics is used)
        Returns:
        Mail attachment

      • objectAttach

        public Mail.MailAttach objectAttach​(ObjectDB obj,
                                    java.lang.String templateName)
        Build an attachement from an object publication
        Parameters:
        obj - Object
        templateName - Publication template name
        Returns:
        Mail attachment

      • documentAttach

        public Mail.MailAttach documentAttach​(ObjectDB obj,
                                      ObjectField f)
        Build an attachment from the content of a document or image object field
        Parameters:
        obj - Object
        f - Field
        Returns:
        Mail attachment

      • resourceAttach

        public Mail.MailAttach resourceAttach​(java.lang.String type,
                                      java.lang.String code)
        Build an attachment from a disposition resource
        Parameters:
        type - Resource type
        code - Resource code
        Returns:
        Mail attachment

      • resourceAttach

        public Mail.MailAttach resourceAttach​(ObjectDB obj,
                                      java.lang.String type,
                                      java.lang.String code)
        Buld an attachment from an object resource
        Parameters:
        obj - Object
        type - Resource type
        code - Resource code
        Returns:
        Mail attachment

      • resourceAttach

        public Mail.MailAttach resourceAttach​(ExternalObject ext,
                                      java.lang.String type,
                                      java.lang.String code)
        Build an attachment from an external object resource
        Parameters:
        ext - External object
        type - Resource type
        code - Resource code
        Returns:
        Mail attachment

      • getResourceAttach

        public static Mail.MailAttach getResourceAttach​(Grant g,
                                                java.lang.Object o,
                                                java.lang.String type,
                                                java.lang.String code)
        Build an attachment from a resource
        Parameters:
        g - Grant
        o - Resource owner: null (disposition) or business object or external object
        type - Resource type
        code - Resource code
        Returns:
        Mail attachment

      • documentImage

        public Mail.MailImage documentImage​(ObjectDB obj,
                                    ObjectField f)
        Build an inlined image from the content of a document or image field
        Parameters:
        obj - Object
        f - Field (must be document or image type)
        Returns:
        Mail inlined image

      • documentImage

        public Mail.MailImage documentImage​(ObjectDB obj,
                                    ObjectField f,
                                    boolean thumbnail)
        Build an inlined image from the content of a document or image field
        Parameters:
        obj - Object
        f - Field (document or image)
        thumbnail - Use thumbnail (only applicable to image field type)?
        Returns:
        Mail inlined image

      • resourceImage

        public Mail.MailImage resourceImage​(java.lang.String code,
                                    boolean thumbnail)
        Build an inlined image from a disposition resource
        Parameters:
        code - Resource code
        thumbnail - Use thumbnail?
        Returns:
        Mail inlined image

      • resourceIcon

        public Mail.MailImage resourceIcon​(java.lang.String code,
                                   boolean thumbnail)
        Build an inlined image from an icon disposition resource
        Parameters:
        code - Resource code
        thumbnail - Use thumbnail?
        Returns:
        Mail inlined image

      • resourceImage

        public Mail.MailImage resourceImage​(ObjectDB obj,
                                    java.lang.String code,
                                    boolean thumbnail)
        Build an inlined image from an object resource
        Parameters:
        obj - Object
        code - Resource code
        thumbnail - Use thumbnail?
        Returns:
        Mail inlined image

      • resourceIcon

        public Mail.MailImage resourceIcon​(ObjectDB obj,
                                   java.lang.String code,
                                   boolean thumbnail)
        Build an inlined image from an object icon resource
        Parameters:
        obj - Object
        code - Resource code
        thumbnail - Use thumbnail?
        Returns:
        Mail inlined image

      • resourceImage

        public Mail.MailImage resourceImage​(ExternalObject ext,
                                    java.lang.String code,
                                    boolean thumbnail)
        Build an inlined image from an external object resource
        Parameters:
        ext - External object
        code - Resource code
        thumbnail - Use thumbnail?
        Returns:
        Mail inlined image

      • resourceIcon

        public Mail.MailImage resourceIcon​(ExternalObject ext,
                                   java.lang.String code,
                                   boolean thumbnail)
        Build an inlined image from an external object icon resource
        Parameters:
        ext - External object
        code - Resource code
        thumbnail - Use thumbnail?
        Returns:
        Mail inlined image

      • getResourceImage

        public static Mail.MailImage getResourceImage​(Grant g,
                                              java.lang.Object o,
                                              java.lang.String type,
                                              java.lang.String code,
                                              boolean thumbnail)
        Get inlined image from a resource
        Parameters:
        g - Grant
        o - Resource owner: null (disposition) or business object or external object
        type - Resource type
        code - Resource code
        thumbnail - Use thumbnail?
        Returns:
        Mail inlined image

      • send

        public boolean send​(java.lang.String to,
                    java.lang.String from,
                    java.lang.String subject,
                    java.lang.String body)
        Send a simple email thru JavaMail or Outlook client (when system param EMAIL_SEND_OUTLOOK = yes)
        Parameters:
        to - Recipient email
        from - Sender email
        subject - Email subject
        body - Mail content (MIME type is forced to HTML if <html> is found in body)
        Returns:
        True if the email was sent

      • send

        public boolean send​(java.lang.String[] to,
                    java.lang.String from,
                    java.lang.String[] cc,
                    java.lang.String subject,
                    java.lang.String body)
        Send a simple email thru JavaMail or Outlook client (when system param EMAIL_SEND_OUTLOOK = yes)
        Parameters:
        to - Recipient emails
        from - Sender email
        cc - Copies emails
        subject - Email subject
        body - Mail content (MIME type is forced to HTML if <html> is found in body)
        Returns:
        True if the email was sent

      • send

        public boolean send​(java.lang.String[] to,
                    java.lang.String from,
                    java.lang.String[] cc,
                    java.lang.String[] bcc,
                    java.lang.String subject,
                    java.lang.String body)
        Send a simple email thru JavaMail or Outlook client (when system param EMAIL_SEND_OUTLOOK = yes)
        Parameters:
        to - Recipient emails
        from - Sender email
        cc - Copies emails
        bcc - Blind copies
        subject - Email subject
        body - Mail content (MIME type is forced to HTML if <html> is found in body)
        Returns:
        True if the email was sent

      • send

        public boolean send​(java.lang.String[] to,
                    java.lang.String from,
                    java.lang.String[] cc,
                    java.lang.String[] bcc,
                    java.lang.String subject,
                    java.lang.String body,
                    java.lang.String mime)
        Send a simple email thru JavaMail or Outlook client (when system param EMAIL_SEND_OUTLOOK = yes)
        Parameters:
        to - Recipient emails
        from - Sender email
        cc - Copies emails
        bcc - Blind copies
        subject - Email subject
        body - Mail content (MIME type is forced to HTML if <html> is found in body)
        mime - Content mime (plain text if null)
        Returns:
        True if the email was sent

      • sendWithAttach

        public boolean sendWithAttach​(java.lang.String to,
                              java.lang.String from,
                              java.lang.String cc,
                              java.lang.String bcc,
                              java.lang.String subject,
                              java.lang.String body,
                              java.lang.String mime,
                              java.lang.String[] files)
        Send an email with attachments thru JavaMail or Outlook client (when system param EMAIL_SEND_OUTLOOK = yes)
        Parameters:
        to - Recipient emails
        from - Sender email
        cc - Copies emails
        bcc - Blind copies
        subject - Email subject
        body - Mail content
        mime - Content mime (plain text if null)
        files - Files to attach
        Returns:
        True if the email was sent

      • sendWithAttach

        public boolean sendWithAttach​(java.lang.String to,
                              java.lang.String from,
                              java.lang.String cc,
                              java.lang.String bcc,
                              java.lang.String subject,
                              java.lang.String body,
                              java.lang.String mime,
                              Mail.MailAttach[] attachs)
        Send an email with attachments thru JavaMail or Outlook client (when system param EMAIL_SEND_OUTLOOK = yes)
        Parameters:
        to - Recipient emails
        from - Sender email
        cc - Copies emails
        bcc - Blind copies
        subject - Email subject
        body - Mail content
        mime - Content mime (plain text if null)
        attachs - Objects attachment
        Returns:
        True if the email was sent

      • sendWithAttach

        public boolean sendWithAttach​(java.lang.String[] to,
                              java.lang.String from,
                              java.lang.String[] cc,
                              java.lang.String[] bcc,
                              java.lang.String subject,
                              java.lang.String body,
                              java.lang.String mime,
                              java.lang.String[] files,
                              Mail.MailAttach[] attachs)
        Send an email with attachments thru JavaMail or Outlook client (when system param EMAIL_SEND_OUTLOOK = yes)
        Parameters:
        to - Recipient emails
        from - Sender email
        cc - Copies emails
        bcc - Blind copies
        subject - Email subject
        body - Mail content
        mime - Content mime (plain text if null)
        files - Files to attach
        attachs - Objects attachment
        Returns:
        True if the email was sent

      • sendWithAttach

        public boolean sendWithAttach​(java.lang.String[] to,
                              java.lang.String from,
                              java.lang.String[] cc,
                              java.lang.String[] bcc,
                              java.lang.String subject,
                              java.lang.String body,
                              java.lang.String mime,
                              java.lang.String[] files,
                              Mail.MailAttach[] attachs,
                              Mail.MailImage[] images)
        Send an email with attachments thru JavaMail or Outlook client (when system param EMAIL_SEND_OUTLOOK = yes)
        Parameters:
        to - Recipient emails
        from - Sender email
        cc - Copies emails
        bcc - Blind copies
        subject - Email subject
        body - Mail content
        mime - Content mime (plain text if null)
        files - Files to attach
        attachs - Objects attachment
        images - Inlined images
        Returns:
        True if the email was sent

      • sendWithAttach

        public boolean sendWithAttach​(java.lang.String[] to,
                              java.lang.String from,
                              java.lang.String replyTo,
                              java.lang.String[] cc,
                              java.lang.String[] bcc,
                              java.lang.String subject,
                              java.lang.String body,
                              java.lang.String mime,
                              java.lang.String[] files,
                              Mail.MailAttach[] attachs,
                              Mail.MailImage[] images)
        Send an email with attachments thru JavaMail or Outlook client (when system param EMAIL_SEND_OUTLOOK = yes)
        Parameters:
        to - Recipient emails
        from - Sender email
        replyTo - Reply email
        cc - Copies emails
        bcc - Blind copies
        subject - Email subject
        body - Mail content
        mime - Content mime (plain text if null)
        files - Files to attach
        attachs - Objects attachment
        images - Inlined images
        Returns:
        True if the email was sent

      • getAddressPart

        public static java.lang.String getAddressPart​(java.lang.String addr)
        Get the plain email address part of a full email address string
        Parameters:
        addr - Full email address string
        Returns:
        Plain email address part

      • getNamePart

        public static java.lang.String getNamePart​(java.lang.String addr)
        Get the plain name part of a full email address string
        Parameters:
        addr - Full email address string
        Returns:
        Plain name part

      • sendInvitation

        public boolean sendInvitation​(java.util.Date start,
                              java.util.Date end,
                              java.lang.String location,
                              java.lang.String organizerEmail,
                              java.lang.String organizerName,
                              java.lang.String attendeeEmail,
                              java.lang.String attendeeName,
                              java.lang.String summary,
                              java.lang.String shortDescription,
                              java.lang.String longDescription)
        Send an invitation to an event to one attendee
        Parameters:
        start - Event start date
        end - Event end date
        location - Event location
        organizerEmail - Event organizer email
        organizerName - Event organizer name
        attendeeEmail - Event attendee email
        attendeeName - Event attendee name
        summary - Event summary (used as invitation email object and vCard summary)
        shortDescription - Event short description (used as vCard description)
        longDescription - Event long description (used as email body with HTML MIME type)
        Returns:
        True if the invitation was sent

      • sendInvitation

        public boolean sendInvitation​(java.util.Date start,
                              java.util.Date end,
                              java.lang.String location,
                              java.lang.String organizerEmail,
                              java.lang.String organizerName,
                              java.lang.String[] attendeeEmails,
                              java.lang.String[] attendeeNames,
                              java.lang.String summary,
                              java.lang.String shortDescription,
                              java.lang.String longDescription)
        Send an invitation to an event to several attendees
        Parameters:
        start - Event start date
        end - Event end date
        location - Event location
        organizerEmail - Event organizer email
        organizerName - Event organizer name
        attendeeEmails - Event attendee emails
        attendeeNames - Event attendee names
        summary - Event summary (used as invitation email object and vCard summary)
        shortDescription - Event short description (used as vCard description)
        longDescription - Event long description (used as email body with HTML MIME type)
        Returns:
        True if the invitation was sent

      • sendInvitation

        public boolean sendInvitation​(java.util.Date start,
                              java.util.Date end,
                              java.lang.String location,
                              java.lang.String organizerEmail,
                              java.lang.String organizerName,
                              java.lang.String[] attendeeEmails,
                              java.lang.String[] attendeeNames,
                              java.lang.String[] ccAttendeeEmails,
                              java.lang.String[] ccAttendeeNames,
                              java.lang.String[] bccAttendeeEmails,
                              java.lang.String[] bccAttendeeNames,
                              java.lang.String summary,
                              java.lang.String shortDescription,
                              java.lang.String longDescription,
                              Mail.MailAttach[] attachs)
        Send an invitation to an event to several attendees and several cc/bcc attendees
        Parameters:
        start - Event start date
        end - Event end date
        location - Event location
        organizerEmail - Event organizer email
        organizerName - Event organizer name
        attendeeEmails - Event attendee emails
        attendeeNames - Event attendee names
        ccAttendeeEmails - Event CC attendee emails
        ccAttendeeNames - Event CC attendee names
        bccAttendeeEmails - Event BCC attendee emails
        bccAttendeeNames - Event BCC attendee names
        summary - Event summary (used as invitation email object and vCard summary)
        shortDescription - Event short description (used as vCard description)
        longDescription - Event long description (used as email body with HTML MIME type)
        attachs - Objects attachment
        Returns:
        True if the invitation was sent