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.jsieve.mail;
21  
22  import java.util.ArrayList;
23  import java.util.List;
24  
25  /**
26   * Class MailUtils implements utility methods that are useful when processing
27   * Sieve mail.
28   */
29  public class MailUtils {
30  
31      /**
32       * Constructor for MailUtils.
33       */
34      protected MailUtils() {
35          super();
36      }
37  
38      /**
39       * <p>
40       * Method getMatchingHeader answers a List of all of the headers in the mail
41       * with the passed name. If no headers are found an empty List is returned.
42       * </p>
43       * 
44       * <p>
45       * This method differs from MailAdapter.getHeader(String) in that it ignores
46       * case and whitespace prefixes and suffixes to a header name when
47       * performing the match, as required by RFC 3028. Thus "From", "from ", "
48       * From" and " from " are considered equal.
49       * </p>
50       * 
51       * @param name
52       * @return List
53       * @throws SieveMailException
54       */
55      static public List<String> getMatchingHeader(MailAdapter mail, String name)
56              throws SieveMailException {;
57          final List<String> matchedHeaderValues = new ArrayList<String>(32);
58          for (String headerName: mail.getHeaderNames()) {
59              if (headerName.trim().equalsIgnoreCase(name))
60                  matchedHeaderValues.addAll(mail.getHeader(headerName));
61          }
62          return matchedHeaderValues;
63      }
64  }