org.safs.tools.mail

Class Mailer

java.lang.Object

org.safs.tools.mail.Mailer

public class Mailer
extends java.lang.Object

Used to send email.
Note:
If the mail server is not in local network and "http proxy server" is needed to connect Internet,
then the VM properties -Dhttp.proxyHost and -Dhttp.proxyPort are required to avoid the connection problem.

Examples:

1. java org.safs.tools.logs.Mailer -h
   to get help information of this program
2. java org.safs.tools.logs.Mailer -to user@company.com -sub "Don not reply this email!" -msg "Helooooo mail coming" -type text/plain
   send to user a plain text "Helooooo mail coming" with subject "Don not reply this email!"
3. java org.safs.tools.logs.Mailer -to user@company.com -sub "Don not reply this email!" -msg "<h1>Helooooo mail coming</h1>" -type text/html
   send to user an html text "<h1>Helooooo mail coming</h1>" with subject "Don not reply this email!"
4. java org.safs.tools.logs.Mailer -to user1@company.com;user2@company.com -sub "Don not reply this email!" -msg "Helooooo mail coming" -type text/plain
   send to user1 and user2 a plain text "Helooooo mail coming" with subject "Don not reply this email!"
5. java org.safs.tools.logs.Mailer -to user1@company.com -cc user2@company.com -sub "Don not reply this email!" -msg "Helooooo mail coming" -type text/plain
   send to user1 a plain text "Helooooo mail coming" with subject "Don not reply this email!", at the same time this email will be cc to user2
6. java org.safs.tools.logs.Mailer -to user@company.com -sub "Don not reply this email!" -msg "Helooooo mail coming" -type text/plain -attach "C:\yourpath\afile.txt"
   send to user a plain text "Helooooo mail coming" with subject "Don not reply this email!" with attached file as "afile.txt"
7. java org.safs.tools.logs.Mailer -to user@company.com -sub "Don not reply this email!" -msg "Helooooo mail coming" -type text/plain -attach "C:\yourpath\afile.txt=alias.txt"
   send to user a plain text "Helooooo mail coming" with subject "Don not reply this email!" with attached file as "alias.txt"
8. java org.safs.tools.logs.Mailer -to user@company.com -sub "Don not reply this email!" -msg "Helooooo mail coming" -type text/plain –attach "C:\yourpath\test.bat=test.bat.remove;C:\safs\lib\safsmail.jar=mail.jar.removeme;C:\safs\lib\windowsclassmap.dat"
   send to user a plain text "Helooooo mail coming" with subject "Don not reply this email!" with multiple attached file as "test.bat.remove", "mail.jar.removeme" and "windowsclassmap.dat"

Author:

(Lei Wang)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Mailer.MimeContent
static class	Mailer.MimeType
static class	Mailer.Protocol

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	debug If true, the debug message will be output to console.
static java.lang.String	DEFAULT_HOST
static int	DEFAULT_PORT
static Mailer.Protocol	DEFAULT_PROTOCOL Mailer.Protocol.SMTP
static java.lang.String	SEPARATOR_EQUAL
static java.lang.String	SEPARATOR_SEMI_COLON

Constructor Summary

Constructors

Constructor and Description
Mailer() Create a Mailer with default host "", port 25 and protocol DEFAULT_PROTOCOL, without Authentication (no need of user/password)
Mailer(java.lang.String host, int port, Mailer.Protocol protocol) Create a Mailer with host, port and protocol, without Authentication (no need of user/password)
Mailer(java.lang.String host, int port, Mailer.Protocol protocol, java.lang.String user, java.lang.String password) Create a Mailer with Authentication (user/password) and host/port/protocol
Mailer(java.lang.String user, java.lang.String password) Create a Mailer with default host "", port 25 and protocol DEFAULT_PROTOCOL, with Authentication (user/password)

Method Summary

Modifier and Type	Method and Description
static void	addMessag(java.lang.String message, Mailer.MimeType msg_type, java.util.Map<java.lang.Integer,Mailer.MimeContent> contents)
protected javax.mail.Session	getSession() Note: Before calling this method, we must call #prepareProperties(String, String) and prepareProperties(String, int, Protocol).
static void	handleAttachments(java.lang.String attachments, java.util.Map<java.lang.String,java.lang.String> attachments_alias)
static void	handleRecipients(java.lang.String recipients, java.util.List<java.lang.String> list)
static void	main(java.lang.String[] args)
javax.mail.internet.MimeMessage	prepareMimeMessage(java.util.List<java.lang.String> recipients, java.lang.String subject) Prepare the MimeMessage for sending.
protected javax.mail.internet.MimeMessage	prepareMimeMessage(java.util.Map<javax.mail.Message.RecipientType,java.util.List<java.lang.String>> type_recipients, java.lang.String subject) Prepare the MimeMessage for sending.
protected static javax.mail.internet.MimeMessage	prepareMimeMessage(javax.mail.Session session, java.util.List<java.lang.String> recipients, java.lang.String from, java.lang.String subject)
protected static javax.mail.internet.MimeMessage	prepareMimeMessage(javax.mail.Session session, java.util.Map<javax.mail.Message.RecipientType,java.util.List<java.lang.String>> type_recipients, java.lang.String from, java.lang.String subject)
void	send(java.util.List<java.lang.String> recipients, java.lang.String subject, java.util.Map<java.lang.Integer,Mailer.MimeContent> contents, java.util.Map<java.lang.String,java.lang.String> attchments_alias) Mail a set of objects, the content's type is defined by MimeType. It will also send attachments provided by the last parameter 'attchments_alias'.
void	send(java.util.List<java.lang.String> recipients, java.lang.String subject, java.lang.Object body, Mailer.MimeType type) Mail object content, the content's type is defined by parameter format.
void	send(java.util.List<java.lang.String> recipients, java.lang.String subject, java.lang.Object body, Mailer.MimeType type, java.util.List<java.lang.String> attachments) Mail object, the content's type is defined by parameter format. It will also send attachments provided by the last parameter 'attachments'.
void	send(java.util.List<java.lang.String> recipients, java.lang.String subject, java.lang.Object body, Mailer.MimeType type, java.util.Map<java.lang.String,java.lang.String> attchments_alias) Mail an object, the content's type is defined by MimeType. It will also send attachments provided by the last parameter 'attchments_alias'.
void	send(java.util.List<java.lang.String> recipients, java.lang.String subject, java.lang.Object body, Mailer.MimeType type, java.lang.String attachment) Mail object, the content's type is defined by parameter format. It will also send attachments provided by the last parameter 'attachment'.
void	send(java.util.List<java.lang.String> recipients, java.lang.String subject, java.lang.String body) Mail text message.
void	send(java.util.Map<javax.mail.Message.RecipientType,java.util.List<java.lang.String>> type_recipients, java.lang.String subject, java.util.Map<java.lang.Integer,Mailer.MimeContent> contents, java.util.Map<java.lang.String,java.lang.String> attchments_alias) Mail a set of objects, the content's type is defined by MimeType. It will also send attachments provided by the last parameter 'attchments_alias'.
protected void	send(javax.mail.internet.MimeMessage message) Before calling this method, the property "mail.transport.protocol" should be ready, refer to prepareProperties(String, int, Protocol).
void	setSender(java.lang.String sender) Set the mail sender.

Methods inherited from class java.lang.Object

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

Field Detail

SEPARATOR_SEMI_COLON

public static java.lang.String SEPARATOR_SEMI_COLON

SEPARATOR_EQUAL

public static java.lang.String SEPARATOR_EQUAL

DEFAULT_HOST

public static final java.lang.String DEFAULT_HOST

See Also:

Constant Field Values

DEFAULT_PORT

public static final int DEFAULT_PORT

See Also:

Constant Field Values

DEFAULT_PROTOCOL

public static final Mailer.Protocol DEFAULT_PROTOCOL

Mailer.Protocol.SMTP

debug

public static boolean debug

If true, the debug message will be output to console.

Constructor Detail

Mailer

public Mailer()
       throws java.lang.Exception

Create a Mailer with default host "", port 25 and protocol DEFAULT_PROTOCOL, without Authentication (no need of user/password)

Throws:

java.lang.Exception

Mailer

public Mailer(java.lang.String host,
              int port,
              Mailer.Protocol protocol)
       throws java.lang.Exception

Create a Mailer with host, port and protocol, without Authentication (no need of user/password)

Parameters:

host - , String, the host name of the mail server.

port - , int, the port number the mailer service is listening to.

protocol - , Protocol, the mail service's protocol

Throws:

java.lang.Exception

Mailer

public Mailer(java.lang.String user,
              java.lang.String password)
       throws java.lang.Exception

Create a Mailer with default host "", port 25 and protocol DEFAULT_PROTOCOL, with Authentication (user/password)

Parameters:

user - , String, the user name used to login.

password - , String, the password of the user.

Throws:

java.lang.Exception

Mailer

public Mailer(java.lang.String host,
              int port,
              Mailer.Protocol protocol,
              java.lang.String user,
              java.lang.String password)
       throws java.lang.Exception

Create a Mailer with Authentication (user/password) and host/port/protocol

Parameters:

host - , String, the host name of the mail server.

port - , int, the port number the mailer service is listening to.

protocol - , Protocol, the mail service's protocol

user - , String, the user name used to login.

password - , String, the password of the user.

Throws:

java.lang.Exception

Method Detail

getSession

protected javax.mail.Session getSession()
                                 throws java.lang.Exception

Note: Before calling this method, we must call #prepareProperties(String, String) and prepareProperties(String, int, Protocol).

Returns:

a java mail Session

Throws:

java.lang.Exception

See Also:

prepareProperties(String, int, Protocol), #prepareProperties(String, String)

setSender

public void setSender(java.lang.String sender)

Set the mail sender.

Parameters:

sender -

prepareMimeMessage

public javax.mail.internet.MimeMessage prepareMimeMessage(java.util.List<java.lang.String> recipients,
                                                          java.lang.String subject)
                                                   throws java.lang.Exception

Prepare the MimeMessage for sending.

Parameters:

recipients - , List, a list of recipients (TO)

subject - , String, the mail's subject

Returns:

the MimeMessage

Throws:

java.lang.Exception

See Also:

send(List, String, String), #send(List, String, String, MimeType), #send(List, String, String, MimeType, String)

prepareMimeMessage

protected javax.mail.internet.MimeMessage prepareMimeMessage(java.util.Map<javax.mail.Message.RecipientType,java.util.List<java.lang.String>> type_recipients,
                                                             java.lang.String subject)
                                                      throws java.lang.Exception

Prepare the MimeMessage for sending.

Parameters:

type_recipients - , Map>

subject - , String, the mail's subject

Returns:

Throws:

java.lang.Exception

See Also:

send(List, String, String), #send(List, String, String, MimeType), #send(List, String, String, MimeType, String)

prepareMimeMessage

protected static javax.mail.internet.MimeMessage prepareMimeMessage(javax.mail.Session session,
                                                                    java.util.List<java.lang.String> recipients,
                                                                    java.lang.String from,
                                                                    java.lang.String subject)
                                                             throws java.lang.Exception

Throws:

java.lang.Exception

prepareMimeMessage

protected static javax.mail.internet.MimeMessage prepareMimeMessage(javax.mail.Session session,
                                                                    java.util.Map<javax.mail.Message.RecipientType,java.util.List<java.lang.String>> type_recipients,
                                                                    java.lang.String from,
                                                                    java.lang.String subject)
                                                             throws java.lang.Exception

Throws:

java.lang.Exception

send

protected void send(javax.mail.internet.MimeMessage message)
             throws SAFSException

Before calling this method, the property "mail.transport.protocol" should be ready, refer to prepareProperties(String, int, Protocol).

Parameters:

message -

Throws:

SAFSException

See Also:

#prepareProperties(String, int, Protocol)}, prepareProperties(String, String, Protocol), getSession()

send

public void send(java.util.List<java.lang.String> recipients,
                 java.lang.String subject,
                 java.lang.String body)
          throws SAFSException

Mail text message.

Parameters:

recipients - , List, a list of recipients

subject - , String, the mail's subject

body - , String, the text message to mail.

Throws:

SAFSException - if there is something wrong

send

public void send(java.util.List<java.lang.String> recipients,
                 java.lang.String subject,
                 java.lang.Object body,
                 Mailer.MimeType type)
          throws SAFSException

Mail object content, the content's type is defined by parameter format.

Parameters:

recipients - , List, a list of recipients

subject - , String, the mail's subject

body - , Object, the object to mail.

type - , the MimeType of the mail body.

Throws:

SAFSException - if there is something wrong

send

public void send(java.util.List<java.lang.String> recipients,
                 java.lang.String subject,
                 java.lang.Object body,
                 Mailer.MimeType type,
                 java.lang.String attachment)
          throws SAFSException

Mail object, the content's type is defined by parameter format.
It will also send attachments provided by the last parameter 'attachment'.

Parameters:

recipients - , List, a list of recipients

subject - , String, the mail's subject

body - , Object, the object to mail.

type - , the MimeType of the mail body.

attachment - , String, a full path file name to attach

Throws:

SAFSException - if there is something wrong

send

public void send(java.util.List<java.lang.String> recipients,
                 java.lang.String subject,
                 java.lang.Object body,
                 Mailer.MimeType type,
                 java.util.List<java.lang.String> attachments)
          throws SAFSException

Mail object, the content's type is defined by parameter format.
It will also send attachments provided by the last parameter 'attachments'.

Parameters:

recipients - , List, a list of recipients

subject - , String, the mail's subject

body - , Object, the object to mail.

type - , the MimeType of the mail body.

attachments - , List, a list of full path file name to attach

Throws:

SAFSException - if there is something wrong

send

public void send(java.util.List<java.lang.String> recipients,
                 java.lang.String subject,
                 java.lang.Object body,
                 Mailer.MimeType type,
                 java.util.Map<java.lang.String,java.lang.String> attchments_alias)
          throws SAFSException

Mail an object, the content's type is defined by MimeType.
It will also send attachments provided by the last parameter 'attchments_alias'.

Parameters:

recipients - , List, a list of recipients

subject - , String, the mail's subject

body - , Object, the object to mail.

type - , the MimeType of the mail body.

attchments_alias - , Map

Throws:

SAFSException - if there is something wrong

send

public void send(java.util.List<java.lang.String> recipients,
                 java.lang.String subject,
                 java.util.Map<java.lang.Integer,Mailer.MimeContent> contents,
                 java.util.Map<java.lang.String,java.lang.String> attchments_alias)
          throws SAFSException

Mail a set of objects, the content's type is defined by MimeType.
It will also send attachments provided by the last parameter 'attchments_alias'.

Parameters:

recipients - , List, a list of recipients

subject - , String, the mail's subject

contents - , Map only the first element will be sent as main message, other will be sent as attachment.

attchments_alias - , Map

Throws:

SAFSException - if there is something wrong

send

public void send(java.util.Map<javax.mail.Message.RecipientType,java.util.List<java.lang.String>> type_recipients,
                 java.lang.String subject,
                 java.util.Map<java.lang.Integer,Mailer.MimeContent> contents,
                 java.util.Map<java.lang.String,java.lang.String> attchments_alias)
          throws SAFSException

Mail a set of objects, the content's type is defined by MimeType.
It will also send attachments provided by the last parameter 'attchments_alias'.

Parameters:

type_recipients - , Map>, a map of recipients(to, cc, bcc)

subject - , String, the mail's subject

contents - , Map, only the first element will be sent as main message, other will be sent as attachment.

attchments_alias - , Map

Throws:

SAFSException - if there is something wrong

handleRecipients

public static void handleRecipients(java.lang.String recipients,
                                    java.util.List<java.lang.String> list)

Parameters:

recipients - ,String , semi-colon separated string, example user1@company1;user2@company2

list - (out), List, a list of email addresses.

handleAttachments

public static void handleAttachments(java.lang.String attachments,
                                     java.util.Map<java.lang.String,java.lang.String> attachments_alias)

Parameters:

attachments - ,String , semi-colon separated string, example c:\folder\file.txt=alias.txt;d:\directory\compress.zip=compress.zip.unzipme

attachments_alias - (out), Map, map containing a pair(filename, alias)
User needs instantiate a new Map and pass it in as a parameter.
If a HashMap instance is passed in, the attachments will be attached in disorder.
If a LinkedHashMap instance is passed in, the attachments will be attached in original order.

addMessag

public static void addMessag(java.lang.String message,
                             Mailer.MimeType msg_type,
                             java.util.Map<java.lang.Integer,Mailer.MimeContent> contents)

Parameters:

message - , String, the message to send

msg_type - , MimeType, the message type

contents - (out), Map, the Map to hold message to send. only the first element will be sent as main message, other will be sent as attachment.

main

public static void main(java.lang.String[] args)