com.qoppa.pas.api.service

Interface EmailService

All Superinterfaces:

BaseService

public interface EmailService
extends BaseService

The EmailService can be used to send an email with a file attachment. Each instance of EmailService is initialized with the PAS Server default SMTP values stored in the settings. Changing the SMTP values for an instance of EmailService does not affect the PAS Server settings. The following values are initialized from the PAS Server settings:

• SMTPServer
• SMTPUserName
• SMTPPassword
• SMTPFromName
• SMTPSSL
• POP3Server
• POP3SSL

Author:

Qoppa Software

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	EmailService.Email This class contains the fields specific to an email message.

Method Summary

Modifier and Type	Method and Description
EmailService.Email	createNewEmail() Creates a new instance of Email.
String	getPOP3Server() Returns the POP3 server for this SMTP server, or null if a POP3 connection is not used.
String	getSMTPFromName() Returns the SMTP from name for this EmailService.
String	getSMTPPassword() Returns the SMTP password for this EmailService.
String	getSMTPServer() Returns the current SMTP server for this EmailService.
String	getSMTPUserName() Returns the SMTP user name for this EmailService.
boolean	isPOP3SSL() Returns whether or not the POP3 server for this EmailService will use the SSL protocol.
boolean	isSMTPSSL() Returns whether or not this EmailService will use the TLS/SSL protocol for this SMTP server.
void	sendEmail(EmailService.Email email) This method sends an email using the current SMTP settings in the EmailService and the parameters specified in the Email.
void	setPOP3Server(String pop3Server) Sets the POP3 server for this SMTP server.
void	setPOP3SSL(boolean enabled) Enables the SSL protocol for the POP3 server for this EmailService.
void	setSMTPFromName(String smtpFromName) Sets the SMTP from name for this EmailService.
void	setSMTPPassword(String smtpPassword) Sets the SMTP password for this EmailService.
void	setSMTPServer(String smtpServer) Sets the SMTP server for this EmailService.
void	setSMTPSSL(boolean enabled) Enables the TLS/SSL protocol for this EmailService.
void	setSMTPUserName(String smtpUuserName) Sets the SMTP user name for this EmailService.

Method Detail

createNewEmail

EmailService.Email createNewEmail()

Creates a new instance of Email. Once the email parameters are specified, the Email can be sent using sendEmail(com.qoppa.pas.api.service.EmailService.Email).

Returns:

A new instance of Email

See Also:

sendEmail(Email)

sendEmail

void sendEmail(EmailService.Email email)

This method sends an email using the current SMTP settings in the EmailService and the parameters specified in the Email.

Parameters:

email - the Email to send

See Also:

createNewEmail()

getSMTPServer

String getSMTPServer()

Returns the current SMTP server for this EmailService.

Returns:

the current SMTP server for this EmailService

setSMTPServer

void setSMTPServer(String smtpServer)

Sets the SMTP server for this EmailService.

Parameters:

smtpServer - the SMTP server for this EmailService.

isSMTPSSL

boolean isSMTPSSL()

Returns whether or not this EmailService will use the TLS/SSL protocol for this SMTP server.

Returns:

true if the EmailService will use the TLS/SSL protocol, false otherwise

setSMTPSSL

void setSMTPSSL(boolean enabled)

Enables the TLS/SSL protocol for this EmailService. If enabled, the EmailService will use the TLS/SSL protocol when sending email.

Parameters:

enabled - true if the TLS/SSL protocol is enabled, false otherwise

getSMTPUserName

String getSMTPUserName()

Returns the SMTP user name for this EmailService.

Returns:

the SMTP user name for this EmailService

setSMTPUserName

void setSMTPUserName(String smtpUuserName)

Sets the SMTP user name for this EmailService.

Parameters:

smtpUuserName - the SMTP user name to set

getSMTPPassword

String getSMTPPassword()

Returns the SMTP password for this EmailService.

Returns:

the SMTP password for this EmailService

setSMTPPassword

void setSMTPPassword(String smtpPassword)

Sets the SMTP password for this EmailService.

Parameters:

smtpPassword - the SMTP password to set

getSMTPFromName

String getSMTPFromName()

Returns the SMTP from name for this EmailService.

Returns:

the SMTP from name for this EmailService

setSMTPFromName

void setSMTPFromName(String smtpFromName)

Sets the SMTP from name for this EmailService.

Parameters:

smtpFromName - the SMTP from name to set

setPOP3Server

void setPOP3Server(String pop3Server)

Sets the POP3 server for this SMTP server. Set this value if the SMTP server requires a POP3 connection first.

Parameters:

pop3Server -

getPOP3Server

String getPOP3Server()

Returns the POP3 server for this SMTP server, or null if a POP3 connection is not used.

Returns:

the POP3 server for this SMTP server

See Also:

setPOP3Server(java.lang.String)

setPOP3SSL

void setPOP3SSL(boolean enabled)

Enables the SSL protocol for the POP3 server for this EmailService. If enabled, the POP3 connection will use the TLS/SSL protocol when sending email.

Parameters:

enabled - true if the SSL protocol is enabled, false otherwise

isPOP3SSL

boolean isPOP3SSL()

Returns whether or not the POP3 server for this EmailService will use the SSL protocol.

Returns:

true if the POP3 server for this EmailService will use the SSL protocol, false otherwise