View Javadoc

1   /*****************************************************************
2    * Licensed to the Apache Software Foundation (ASF) under one   *
3    * or more contributor license agreements.  See the NOTICE file *
4    * distributed with this work for additional information        *
5    * regarding copyright ownership.  The ASF licenses this file   *
6    * to you under the Apache License, Version 2.0 (the            *
7    * "License"); you may not use this file except in compliance   *
8    * with the License.  You may obtain a copy of the License at   *
9    *                                                              *
10   *   http://www.apache.org/licenses/LICENSE-2.0                 *
11   *                                                              *
12   * Unless required by applicable law or agreed to in writing,   *
13   * software distributed under the License is distributed on an  *
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY       *
15   * KIND, either express or implied.  See the License for the    *
16   * specific language governing permissions and limitations      *
17   * under the License.                                           *
18   ****************************************************************/
19  
20  package org.apache.mailet;
21  
22  /***
23   * This utility class provides the set of header names explicitly defined in RFC 2822
24   *
25   */
26  public class RFC2822Headers  {
27  
28      // See Section 3.6.1 of RFC 2822
29  
30      /***
31       * The name of the RFC 2822 header that stores the mail date.
32       */
33      public final static String DATE = "Date";
34  
35      // See Section 3.6.2 of RFC 2822
36  
37      /***
38       * The name of the RFC 2822 header that stores the mail author(s).
39       */
40      public final static String FROM = "From";
41  
42      /***
43       * The name of the RFC 2822 header that stores the actual mail transmission agent,
44       * if this differs from the author of the message.
45       */
46      public final static String SENDER = "Sender";
47  
48      /***
49       * The name of the RFC 2822 header that stores the reply-to address.
50       */
51      public final static String REPLY_TO = "Reply-To";
52  
53      // See Section 3.6.3 of RFC 2822
54  
55      /***
56       * The name of the RFC 2822 header that stores the primary mail recipients.
57       */
58      public final static String TO = "To";
59  
60      /***
61       * The name of the RFC 2822 header that stores the carbon copied mail recipients.
62       */
63      public final static String CC = "Cc";
64  
65      /***
66       * The name of the RFC 2822 header that stores the blind carbon copied mail recipients.
67       */
68      public final static String BCC = "Bcc";
69  
70      // See Section 3.6.4 of RFC 2822
71  
72      /***
73       * The name of the RFC 2822 header that stores the message id.
74       */
75      public final static String MESSAGE_ID = "Message-ID";
76  
77      /***
78       * A common variation on the name of the RFC 2822 header that
79       * stores the message id.  This is needed for certain filters and
80       * processing of incoming mail.
81       */
82      public final static String MESSAGE_ID_VARIATION = "Message-Id";
83  
84      /***
85       * The name of the RFC 2822 header that stores the message id of the message
86       * that to which this email is a reply.
87       */
88      public final static String IN_REPLY_TO = "In-Reply-To";
89  
90      /***
91       * The name of the RFC 2822 header that is used to identify the thread to
92       * which this message refers.
93       */
94      public final static String REFERENCES = "References";
95  
96      // See Section 3.6.5 of RFC 2822
97  
98      /***
99       * The name of the RFC 2822 header that stores the subject.
100      */
101     public final static String SUBJECT = "Subject";
102 
103     /***
104      * The name of the RFC 2822 header that stores human-readable comments.
105      */
106     public final static String COMMENTS = "Comments";
107 
108     /***
109      * The name of the RFC 2822 header that stores human-readable keywords.
110      */
111     public final static String KEYWORDS = "Keywords";
112 
113     // See Section 3.6.6 of RFC 2822
114 
115     /***
116      * The name of the RFC 2822 header that stores the date the message was resent.
117      */
118     public final static String RESENT_DATE = "Resent-Date";
119 
120     /***
121      * The name of the RFC 2822 header that stores the originator of the resent message.
122      */
123     public final static String RESENT_FROM = "Resent-From";
124 
125     /***
126      * The name of the RFC 2822 header that stores the transmission agent
127      * of the resent message.
128      */
129     public final static String RESENT_SENDER = "Resent-Sender";
130 
131     /***
132      * The name of the RFC 2822 header that stores the recipients
133      * of the resent message.
134      */
135     public final static String RESENT_TO = "Resent-To";
136 
137     /***
138      * The name of the RFC 2822 header that stores the carbon copied recipients
139      * of the resent message.
140      */
141     public final static String RESENT_CC = "Resent-Cc";
142 
143     /***
144      * The name of the RFC 2822 header that stores the blind carbon copied recipients
145      * of the resent message.
146      */
147     public final static String RESENT_BCC = "Resent-Bcc";
148 
149     /***
150      * The name of the RFC 2822 header that stores the message id
151      * of the resent message.
152      */
153     public final static String RESENT_MESSAGE_ID = "Resent-Message-ID";
154 
155     // See Section 3.6.7 of RFC 2822
156 
157     /***
158      * The name of the RFC 2822 headers that store the tracing data for the return path.
159      */
160     public final static String RETURN_PATH = "Return-Path";
161 
162     /***
163      * The name of the RFC 2822 headers that store additional tracing data.
164      */
165     public final static String RECEIVED = "Received";
166 
167     // MIME headers
168 
169     /***
170      * The name of the MIME header that stores the content type.
171      */
172     public final static String CONTENT_TYPE = "Content-Type";
173 
174     /***
175      * Private constructor to prevent instantiation
176      */
177     private RFC2822Headers() {}
178 
179 }