com.tsgrp.opencontent.core.email

Interface IEmail

All Known Implementing Classes:

EmailImpl

public interface IEmail

An interface for sending email.

Method Summary

Modifier and Type	Method and Description
AddressBook	addContactsToFolderAddressBook(java.lang.String ticket, java.lang.String folderId, java.util.Set<AddressBookContact> contactsToAdd) Adds contacts to the addressbook in the given folder.
AddressBook	getFolderAddressBook(java.lang.String ticket, java.lang.String folderId) Retrieves address book contacts for the folder specified.
void	sendEmail(java.lang.String ticket, Email emailBean) Uses provided information to send an email.
AddressBook	updateFolderAddressBook(java.lang.String ticket, java.lang.String folderId, AddressBook updatedAddressBook) Overwrites the existing address book in the given folder, or creates the address book if it does not exist.

Method Detail

sendEmail

void sendEmail(java.lang.String ticket,
               Email emailBean)

Uses provided information to send an email.

Parameters:

ticket - the authentication for the current session

emailBean - email object used to populate information for sending

updateFolderAddressBook

AddressBook updateFolderAddressBook(java.lang.String ticket,
                                    java.lang.String folderId,
                                    AddressBook updatedAddressBook)

Overwrites the existing address book in the given folder, or creates the address book if it does not exist. Note that if the address book is locked in the repository, this method will not throw an exception. It will simply log a warning and return the address book from the repository.

Parameters:

ticket - the authentication for the current session

folderId - the ID of the folder that this address book is related to

updatedAddressBook - the updated address book

Returns:

the new address book in the repository

addContactsToFolderAddressBook

AddressBook addContactsToFolderAddressBook(java.lang.String ticket,
                                           java.lang.String folderId,
                                           java.util.Set<AddressBookContact> contactsToAdd)

Adds contacts to the addressbook in the given folder. If the address book does not exist, it will be created. This method does nothing if the contactsToAdd already exist in the folder address book. Note that if the address book is locked in the repository, this method will not throw an exception. It will simply log a warning and return the address book from the repository.

Parameters:

ticket - authentication ticket

folderId - the ID of the folder that this address book is related to

contactsToAdd - the Set of contacts to add to the address book

Returns:

the updated address book in the repository

getFolderAddressBook

AddressBook getFolderAddressBook(java.lang.String ticket,
                                 java.lang.String folderId)

Retrieves address book contacts for the folder specified. If the address book does not exist, implementations should return an empty AddressBook object

Parameters:

ticket - the authentication for the current session

folderId - id of folder who's address book to retrieve

Returns:

the AddressBook