1 package pt.digitalis.dif.utils.mail;
2
3 import java.util.Properties;
4
5 import pt.digitalis.utils.config.IConfigurations;
6 import pt.digitalis.utils.config.annotations.ConfigIgnore;
7
8 /**
9 * @author Galaio da Silva <a href="mailto:jgalaio@digitalis.pt">jgalaio@digitalis.pt</a><br/>
10 * @created May 24, 2012
11 */
12 public interface IMailConfiguration {
13
14 /**
15 * Gets the configurations.
16 *
17 * @return the configurations
18 */
19 public IConfigurations getConfigurations();
20
21 /**
22 * Inspector for the 'debugEnabled' attribute.
23 *
24 * @return the debugEnabled value
25 */
26 public String getDebugEnabled();
27
28 /**
29 * Inspector for the 'defaultFromAddress' attribute.
30 *
31 * @return the defaultFromAddress value
32 */
33 public String getDefaultFromAddress();
34
35 /**
36 * Get the encoding
37 *
38 * @return encoding
39 */
40 public String getEncoding();
41
42 /**
43 * Inspector for the 'GapBetweenMails' attribute.
44 *
45 * @return the gapBetweenMails value
46 */
47 public int getGapBetweenMails();
48
49 /**
50 * Inspector for the 'LimitMaxEmails' attribute.
51 *
52 * @return the limitMaxEmails value
53 */
54 public int getLimitMaxEmails();
55
56 /**
57 * Inspector for the 'LimitTimeInterval' attribute.
58 *
59 * @return the limitTimeInterval value
60 */
61 public int getLimitTimeInterval();
62
63 /**
64 * Inspector for the 'mailServer' attribute.
65 *
66 * @return the mailServer value
67 */
68 public String getMailServer();
69
70 /**
71 * Inspector for the 'mailServerPassword' attribute.
72 *
73 * @return the mailServerPassword value
74 */
75 public String getMailServerPassword();
76
77 /**
78 * Inspector for the 'mailServerPort' attribute.
79 *
80 * @return the mailServerPort value
81 */
82 public int getMailServerPort();
83
84 /**
85 * Inspector for the 'mailServerUsername' attribute.
86 *
87 * @return the mailServerUsername value
88 */
89 public String getMailServerUsername();
90
91 /**
92 * Inspector for the 'originalConfs' attribute.
93 *
94 * @return the originalConfs value
95 */
96 @ConfigIgnore
97 public Properties getOriginalConfs();
98
99 /**
100 * Inspector for the 'useSSL' attribute.
101 *
102 * @return the useSSL value
103 */
104 public Boolean getUseSSL();
105
106 /**
107 * Modifier for the 'configurations' attribute.
108 *
109 * @param configurations
110 * the new configurations value to set
111 */
112 public void setConfigurations(IConfigurations configurations);
113
114 /**
115 * Modifier for the 'debugEnabled' attribute.
116 *
117 * @param debugEnabled
118 * the new debugEnabled value to set
119 */
120 public void setDebugEnabled(String debugEnabled);
121
122 /**
123 * Modifier for the 'defaultFromAddress' attribute.
124 *
125 * @param defaultFromAddress
126 * the new defaultFromAddress value to set
127 */
128 public void setDefaultFromAddress(String defaultFromAddress);
129
130 /**
131 * Set the encoding
132 *
133 * @param encoding
134 * the encoding
135 */
136 public void setEncoding(String encoding);
137
138 /**
139 * Modifier for the 'GapBetweenMails' attribute.
140 *
141 * @param gapBetweenMails
142 * the new gapBetweenMails value to set
143 */
144 public void setGapBetweenMails(int gapBetweenMails);
145
146 /**
147 * Modifier for the 'LimitMaxEmails' attribute.
148 *
149 * @param limitMaxEmails
150 * the new limitMaxEmails value to set
151 */
152 public void setLimitMaxEmails(int limitMaxEmails);
153
154 /**
155 * Modifier for the 'LimitTimeInterval' attribute.
156 *
157 * @param limitTimeInterval
158 * the new limitTimeInterval value to set
159 */
160 public void setLimitTimeInterval(int limitTimeInterval);
161
162 /**
163 * Modifier for the 'mailServer' attribute.
164 *
165 * @param mailServer
166 * the new mailServer value to set
167 */
168 public void setMailServer(String mailServer);
169
170 /**
171 * Modifier for the 'mailServerPassword' attribute.
172 *
173 * @param mailServerPassword
174 * the new mailServerPassword value to set
175 */
176 public void setMailServerPassword(String mailServerPassword);
177
178 /**
179 * Modifier for the 'mailServerPort' attribute.
180 *
181 * @param mailServerPort
182 * the new mailServerPort value to set
183 */
184 public void setMailServerPort(int mailServerPort);
185
186 /**
187 * Modifier for the 'mailServerUsername' attribute.
188 *
189 * @param mailServerUsername
190 * the new mailServerUsername value to set
191 */
192 public void setMailServerUsername(String mailServerUsername);
193
194 /**
195 * Modifier for the 'originalConfs' attribute.
196 *
197 * @param originalConfs
198 * the new originalConfs value to set
199 */
200 public void setOriginalConfs(Properties originalConfs);
201
202 /**
203 * Modifier for the 'useSSL' attribute.
204 *
205 * @param useSSL
206 * the new useSSL value to set
207 */
208 public void setUseSSL(Boolean useSSL);
209
210 /**
211 * Write configuration
212 *
213 * @throws Exception
214 * if an Exception occurrs
215 */
216 public void writeConfiguration() throws Exception;
217
218 }