/usr/lib/ruby/1.8/rmail/message.rb is in librmail-ruby1.8 0.17-1.1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 | #--
# Copyright (C) 2001, 2002, 2003 Matt Armstrong. All rights
# reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain the above copyright notice,
# this list of conditions and the following disclaimer.
# 2. Redistributions in binary form must reproduce the above copyright
# notice, this list of conditions and the following disclaimer in the
# documentation and/or other materials provided with the distribution.
# 3. The name of the author may not be used to endorse or promote products
# derived from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
# IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
# OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN
# NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
# TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
# PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
#
#++
# Implements the RMail::Message class.
require 'rmail/header.rb'
module RMail
# The RMail::Message is an object representation of a standard
# Internet email message, including MIME multipart messages.
#
# An RMail::Message object represents a message header (held in the
# contained RMail::Header object) and a message body. The message
# body may either be a single String for single part messages or an
# Array of RMail::Message objects for MIME multipart messages.
class Message
# Create a new, empty, RMail::Message.
def initialize
@header = RMail::Header.new
@body = nil
@epilogue = nil
@preamble = nil
end
# Test if this message is structured exactly the same as the other
# message. This is useful mainly for testing.
def ==(other)
@preamble == other.preamble &&
@epilogue == other.epilogue &&
@header == other.header &&
@body == other.body
end
# Returns the body of the message as a String or Array.
#
# If #multipart? returns true, it will be an array of
# RMail::Message objects. Otherwise it will be a String.
#
# See also #header.
def body
return @body
end
# Sets the body of the message to the given value. It should
# either be a String or an Array of RMail:Message objects.
def body=(s)
@body = s
end
# Returns the RMail::Header object.
#
# See also #body.
def header()
return @header
end
# Return true if the message consists of multiple parts.
def multipart?
@body.is_a?(Array)
end
# Add a part to the message. After this message is called, the
# #multipart? method will return true and the #body method will
# #return an array of parts.
def add_part(part)
if @body.nil?
@body = [part]
elsif @body.is_a?(Array)
@body.push(part)
else
@body = [@body, part]
end
end
# Decode the body of this message.
#
# If the body of this message is encoded with
# <tt>quoted-printable</tt> or <tt>base64</tt>, this function will
# decode the data into its original form and return it as a
# String. If the body is not encoded, it is returned unaltered.
#
# This only works when the message is not a multipart. The
# <tt>Content-Transfer-Encoding:</tt> header field is consulted to
# determine the encoding of the body part.
def decode
raise TypeError, "Can not decode a multipart message." if multipart?
case header.fetch('content-transfer-encoding', '7bit').strip.downcase
when 'quoted-printable'
Utils.quoted_printable_decode(@body)
when 'base64'
Utils.base64_decode(@body)
else
@body
end
end
# Get the indicated part from a multipart message.
def part(i)
raise TypeError,
"Can not get part on a single part message." unless multipart?
@body[i]
end
# Access the epilogue string for this message. The epilogue
# string is relevant only for multipart messages. It is the text
# that occurs after all parts of the message and is generally nil.
attr :epilogue, true
# Access the preamble string for this message. The preamble
# string is relevant only for multipart messages. It is the text
# that occurs just before the first part of the message, and is
# generally nil or simple English text describing the nature of
# the message.
attr :preamble, true
# Returns the entire message in a single string. This uses the
# RMail::Serialize class.
def to_s()
require 'rmail/serialize'
RMail::Serialize.new('').serialize(self)
end
# Return each part of this message
#
# FIXME: not tested
def each_part
raise TypeError, "not a multipart message" unless multipart?
@body.each do |part|
yield part
end
end
# Call the supplied block for each line of the message. Each line
# will contain a trailing newline (<tt>\n</tt>).
def each()
# FIXME: this is incredibly inefficient! The only users of this
# is RMail::Deliver -- get them to use a RMail::Serialize object.
to_s.each("\n") { |line|
yield line
}
end
# This is used by the RMail::Parser to set the MIME multipart
# delimiter strings found in the message. These delimiters are
# then used when serializing the message again.
#
# Normal uses of RMail::Message will never use this method, and so
# it is left undocumented.
def set_delimiters(delimiters, boundary) # :nodoc:
raise TypeError, "not a multipart message" unless multipart?
raise ArgumentError, "delimiter array wrong size" unless
delimiters.length == @body.length + 1
@delimiters = delimiters.to_ary
@delimiters_boundary = boundary.to_str
end
# This is used by the serializing functions to retrieve the MIME
# multipart delimiter strings found while parsing the message.
# These delimiters are then used when serializing the message
# again.
#
# Normal uses of RMail::Message will never use this method, and so
# it is left undocumented.
def get_delimiters # :nodoc:
unless multipart? and @delimiters and @delimiters_boundary and
@delimiters.length == @body.length + 1 and
header.param('content-type', 'boundary') == @delimiters_boundary
@delimiters = nil
@delimiters_boundary = nil
end
[ @delimiters, @delimiters_boundary ]
end
end
end
|