1. Project Clover database Tue Dec 20 2016 21:24:09 CET
  2. Package org.xwiki.mail

File MimeBodyPartFactory.java

 

Code metrics

0
0
0
1
51
10
0
-
-
0
-

Classes

Class Line # Actions
MimeBodyPartFactory 37 0 - 0 0
-1.0 -
 

Contributing tests

No tests hitting this source file were found.

Source view

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 java.util.Map;
23   
24    import javax.mail.MessagingException;
25    import javax.mail.internet.MimeBodyPart;
26   
27    import org.xwiki.component.annotation.Role;
28   
29    /**
30    * Creates some message body Part to be added to a Multi Part message.
31    *
32    * @param <T> the type of content to be added to a Multi Part message
33    * @version $Id: 47576a76e24db54d5849964b695325bac365fcd4 $
34    * @since 6.1M2
35    */
36    @Role
 
37    public interface MimeBodyPartFactory<T>
38    {
39    /**
40    * Create a {@link javax.mail.BodyPart}.
41    *
42    * @param content the content of the body part (depends on the implementation, can be some String containing plain
43    * text, some String containing HTML, an attachment, etc)
44    * @param parameters the list of extra parameters. This is used for example to pass alternate content for the mail
45    * using the {@code alternate} key in the HTML Mime Body Part Factory. Mail headers can also be passed using
46    * the {@code headers} key with a {@code Map<String, String>} value containing header keys and values
47    * @return the created Body Part
48    * @throws MessagingException when an error occurs
49    */
50    MimeBodyPart create(T content, Map<String, Object> parameters) throws MessagingException;
51    }