KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > sape > carbon > services > email > MailService


1 /*
2  * The contents of this file are subject to the Sapient Public License
3  * Version 1.0 (the "License"); you may not use this file except in compliance
4  * with the License. You may obtain a copy of the License at
5  * http://carbon.sf.net/License.html.
6  *
7  * Software distributed under the License is distributed on an "AS IS" basis,
8  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for
9  * the specific language governing rights and limitations under the License.
10  *
11  * The Original Code is The Carbon Component Framework.
12  *
13  * The Initial Developer of the Original Code is Sapient Corporation
14  *
15  * Copyright (C) 2003 Sapient Corporation. All Rights Reserved.
16  */
17
18 package org.sape.carbon.services.email;
19
20 import org.sape.carbon.core.component.FunctionalInterface;
21
22 /**
23  * <p>The MailService Interface provides methods for sending text and
24  * html mails with or without attachments.</p>
25  *
26  * <p>Copyright 2002 Sapient</p>
27  * @stereotype interface
28  * @since carbon 1.0
29  * @author $Author: dvoet $ $Date: 2003/05/05 21:21:29 $
30  * @version $Revision: 1.4 $
31  *
32  */
33 public interface MailService extends FunctionalInterface {
34
35      /**
36       * <p>Sends an email with the parameters specified in mail data object.
37       * E.x <code>MailDataObject mailDataObject = new MailDataObject();
38       * mailDataObject.addTo("someone@somewhere.com", "someone");
39       * mailDataObject.setFrom("ejfw4@sapient.com", "ejfw4");
40       * mailDataObject.setSubject("Hello");
41       * mailDataObject.setBody("A simple plain text email",
42       * MailContentTypeEnum.PLAIN_TEXT);
43       *
44       * // Fetch the mail component
45       * MailService mailService = (MailService) Lookup.getInstance().
46       * fetchComponent("/email/test/testEmail");
47       *
48       * mailService.sendMail(mailDataObject); </code></p>
49       *
50       * @param mailDataObject Encapsulates all the parameters required to send
51       * a mail.
52       * @exception MailFailureException Thrown if unable to send the mail.
53       */
54      void sendMail(MailDataObject mailDataObject) throws MailFailureException;
55 }
56
Popular Tags