Class | Line # | Actions | |||||
---|---|---|---|---|---|---|---|
MailSender | 34 | 0 | - | 0 | 0 |
1 | /* | |
2 | * See the NOTICE file distributed with this work for additional | |
3 | * information regarding copyright ownership. | |
4 | * | |
5 | * This is free software; you can redistribute it and/or modify it | |
6 | * under the terms of the GNU Lesser General Public License as | |
7 | * published by the Free Software Foundation; either version 2.1 of | |
8 | * the License, or (at your option) any later version. | |
9 | * | |
10 | * This software is distributed in the hope that it will be useful, | |
11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
13 | * Lesser General Public License for more details. | |
14 | * | |
15 | * You should have received a copy of the GNU Lesser General Public | |
16 | * License along with this software; if not, write to the Free | |
17 | * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA | |
18 | * 02110-1301 USA, or see the FSF site: http://www.fsf.org. | |
19 | */ | |
20 | package org.xwiki.mail; | |
21 | ||
22 | import javax.mail.Session; | |
23 | import javax.mail.internet.MimeMessage; | |
24 | ||
25 | import org.xwiki.component.annotation.Role; | |
26 | ||
27 | /** | |
28 | * Send mails. | |
29 | * | |
30 | * @version $Id: d48f225267edab46ac136ef4e0e043420fa2c816 $ | |
31 | * @since 6.1M2 | |
32 | */ | |
33 | @Role | |
34 | public interface MailSender | |
35 | { | |
36 | /** | |
37 | * Send a list of mails asynchronously (the call returns immediately). | |
38 | * | |
39 | * @param messages the list of messages to sent | |
40 | * @param session the JavaMail session containing all the configuration for the SMTP host, port, etc | |
41 | * @param listener a listener called when the mail is sent successfully or when there is an error | |
42 | * @return the result of the mail sending | |
43 | * @since 6.2M1 | |
44 | */ | |
45 | MailResult sendAsynchronously(Iterable<? extends MimeMessage> messages, Session session, MailListener listener); | |
46 | } |