1. Project Clover database Sat Feb 2 2019 06:45:20 CET
  2. Package org.xwiki.notifications.notifiers.internal.email

File PeriodicMimeMessageIterator.java

 

Code metrics

0
0
0
1
50
13
0
-
-
0
-

Classes

Class Line # Actions
PeriodicMimeMessageIterator 38 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.notifications.notifiers.internal.email;
21   
22    import java.util.Date;
23    import java.util.Iterator;
24    import java.util.Map;
25   
26    import javax.mail.internet.MimeMessage;
27   
28    import org.xwiki.component.annotation.Role;
29    import org.xwiki.model.reference.DocumentReference;
30   
31    /**
32    * Iterator used to generate emails for notifications. Generate MimeMessages.
33    *
34    * @version $Id: fbe27db3aa67f8379331be921028945b99d037e5 $
35    * @since 9.10RC1
36    */
37    @Role
 
38    public interface PeriodicMimeMessageIterator extends Iterator<MimeMessage>, Iterable<MimeMessage>
39    {
40    /**
41    * Initialize the iterator.
42    *
43    * @param userIterator iterator that returns all users
44    * @param factoryParameters parameters for the email factory
45    * @param lastTrigger time of the last email sent
46    * @param templateReference reference to the mail template
47    */
48    void initialize(NotificationUserIterator userIterator, Map<String, Object> factoryParameters,
49    Date lastTrigger, DocumentReference templateReference);
50    }