Package com.basis.api.admin

Interface BBjAdminEmailService

All Superinterfaces:
BBjAdminCommitPropertyWriter, BBjAdminCommitWriter, BBjAdminPropertyReader, BBjAdminPropertyWriter, Remote
public interface BBjAdminEmailService extends BBjAdminCommitPropertyWriter

Contains all the configuration information for an email service. An email service allows users to send email from a BBj or Java programs using the Admin API, or Event Handler notifications. The service contains all the information necessary to send messages through an outgoing mail server.

BBj Sample Code - Create an Email Service

The following sample code programmatically creates an email service. This can also be done using the Enterprise Manager.

use com.basis.api.admin.BBjAdminEmailService
use com.basis.api.admin.BBjAdminEmailServiceConfig

declare BBjAdminBase api!
declare BBjAdminEmailService emailSvc!

api! = BBjAdminFactory.getBBjAdmin("admin", "admin123")
emailSvc! = api!.newEmailService()
emailSvc!.setString(BBjAdminEmailService.NAME, "MyEmailService")
emailSvc!.setString(BBjAdminEmailService.SERVER, "smtp.gmail.com")
emailSvc!.setInt(BBjAdminEmailService.PORT, 587)
emailSvc!.setString(BBjAdminEmailService.USER, "me@gmail.com")
emailSvc!.setString(BBjAdminEmailService.PASSWORD, "mypassword")
emailSvc!.setString(BBjAdminEmailService.AUTH, BBjAdminEmailService.AUTH_TLS)
emailSvc!.setString(BBjAdminEmailService.DEFAULT_FROM, "me@gmail.com")
emailSvc!.setString(BBjAdminEmailService.DEFAULT_REPLY_TO, "me@gmail.com")

emailSvc!.commit()

BBj Sample Code - Send A Message

The following sample code requests a list of all Email Services configured on the local BBjServices installation. It then displays this list for the user to select a service and then prompts for email message information to send a test sending a simple message.

use com.basis.api.admin.BBjAdminEmailService
use com.basis.api.admin.BBjAdminEmailMessage

declare BBjAdminBase api!
declare BBjAdminList emailServices!
declare BBjAdminEmailService emailSvc!
declare BBjAdminEmailService selectedEmailSvc!
declare BBjAdminEmailMessage msg!

api! = BBjAdminFactory.getBBjAdmin("admin", "admin123")

promptForService:
emailServices! = api!.getEmailServices()
print "Select a service to use to send a message:"
for i = 1 to emailServices!.size()
emailSvc! = cast(BBjAdminEmailService, emailServices!.get(i - 1))
print str(i) + ") " + emailSvc!.getString(BBjAdminEmailService.NAME)
next i
input "Enter Choice #: ", choice
selectedEmailSvc! = cast(BBjAdminEmailService, emailServices!.get(choice - 1))

print print "Enter recipient (comma separate multiple): "
input recipient$

print
print "Enter the subject of the message:"
input subject$

print
print "Enter short message: "
input message$

msg! = selectedEmailSvc!.createMessage()
msg!.setString(BBjAdminEmailMessage.TO, recipient$)
msg!.setString(BBjAdminEmailMessage.SUBJECT, subject$)
msg!.setString(BBjAdminEmailMessage.TEXT, message$)

selectedEmailSvc!.sendMessage(msg!)
print "Your message was successfully sent!"
print "***********************"
print

goto promptForService