com.screenscraper.util.mail

Class EmailClient

java.lang.Object

com.screenscraper.util.mail.EmailClient

public final class EmailClient
extends java.lang.Object

A simple client for sending email

Version:

1.0

Constructor Summary

Constructors

Constructor and Description
EmailClient(java.lang.String outboundHostType, java.lang.String outboundHost, int outboundPort, EmailEncryptionType encryption, java.lang.String username, java.lang.String password) Prepares an Email Client to send email.
EmailClient(java.lang.String outboundHostType, java.lang.String outboundHost, int outboundPort, java.lang.String username, java.lang.String password) Prepares an Email Client to send email.

Method Summary

Modifier and Type	Method and Description
SendableEmailMessage	createMessage() Creates a message that can be sent using the current client
java.lang.String	getInboundHost() Returns the name of the inbound mail server
java.lang.Integer	getInboundPort() Returns the port of the inbound mail server
java.lang.String	getOutboundHost() Returns the name of the outbound mail server
java.lang.Integer	getOutboundPort() Returns the port of the outbound mail server
void	sendSimpleEmail(java.lang.String to, java.lang.String subject, java.lang.String message) Sends a simple email to the client.

Methods inherited from class java.lang.Object

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

Constructor Detail

EmailClient

public EmailClient(@Nullable
                   java.lang.String outboundHostType,
                   java.lang.String outboundHost,
                   int outboundPort,
                   @Nullable
                   java.lang.String username,
                   @Nullable
                   java.lang.String password)

Prepares an Email Client to send email. This method will use encryption to connect to the server

Parameters:

outboundHostType - The type of the host, such as 'smtp'

outboundHost - The name of the outbound mail server

outboundPort - The port used to connect to the outbound server

username - The username for the account

password - The password for the account

EmailClient

public EmailClient(@Nullable
                   java.lang.String outboundHostType,
                   java.lang.String outboundHost,
                   int outboundPort,
                   @NotNull
                   EmailEncryptionType encryption,
                   @Nullable
                   java.lang.String username,
                   @Nullable
                   java.lang.String password)

Prepares an Email Client to send email.

Parameters:

outboundHostType - The type of the host, such as 'smtp'

outboundHost - The name of the outbound mail server

outboundPort - The port used to connect to the outbound server

username - The username for the account

password - The password for the account

encryption - The type of encryption used on the connection

Method Detail

sendSimpleEmail

public void sendSimpleEmail(@NotNull
                            java.lang.String to,
                            java.lang.String subject,
                            java.lang.String message)
                     throws javax.mail.MessagingException

Sends a simple email to the client. This will use the username used to connect to the mail server as the from address.

Parameters:

to - The address this message will be sent to

subject - The subject of the email

message - The message to send, as HTML

Throws:

javax.mail.MessagingException - On any error setting message fields or sending the message

createMessage

@NotNull
public SendableEmailMessage createMessage()

Creates a message that can be sent using the current client

Returns:

A message that can be filled with information before being sent

getOutboundHost

@Nullable
public java.lang.String getOutboundHost()

Returns the name of the outbound mail server

Returns:

The name of the outbound mail server

getOutboundPort

@Nullable
public java.lang.Integer getOutboundPort()

Returns the port of the outbound mail server

Returns:

The port of the outbound mail server

getInboundHost

@Nullable
public java.lang.String getInboundHost()

Returns the name of the inbound mail server

Returns:

The name of the inbound mail server

getInboundPort

@Nullable
public java.lang.Integer getInboundPort()

Returns the port of the inbound mail server

Returns:

The port of the inbound mail server