/usr/share/ada/adainclude/gnatcoll/gnatcoll-email-utils.ads is in libgnatcoll16.1.0-dev 17.0.2017-3.
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 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 | ------------------------------------------------------------------------------
-- G N A T C O L L --
-- --
-- Copyright (C) 2006-2017, AdaCore --
-- --
-- This library is free software; you can redistribute it and/or modify it --
-- under terms of the GNU General Public License as published by the Free --
-- Software Foundation; either version 3, or (at your option) any later --
-- version. This library is distributed in the hope that it will be useful, --
-- but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHAN- --
-- TABILITY or FITNESS FOR A PARTICULAR PURPOSE. --
-- --
-- --
-- --
-- --
-- --
-- You should have received a copy of the GNU General Public License and --
-- a copy of the GCC Runtime Library Exception along with this program; --
-- see the files COPYING3 and COPYING.RUNTIME respectively. If not, see --
-- <http://www.gnu.org/licenses/>. --
-- --
------------------------------------------------------------------------------
-- This package contains various utility routines related to handling of
-- email messages
with Ada.Calendar;
with Ada.Containers.Hashed_Sets;
package GNATCOLL.Email.Utils is
type Region is (Addr_Header, Other_Header, Text);
subtype Any_Header is Region range Addr_Header .. Other_Header;
-- Used to indicate where a given character occurs:
-- Addr_Header: From/To/Cc header
-- Header: any other header
-- Text: message body
-----------
-- Dates --
-----------
type Time_Format is (Time_RFC2822, Time_Envelope);
-- The time formats supported by this package.
-- Time_RFC2822 is the one used in the Date: header.
-- Time_Enveloppe is the one used in the From_ header
function To_Time
(Date : String;
Format : Time_Format := Time_RFC2822) return Ada.Calendar.Time;
-- Interprets the Date as a date/time, and returns it. The time is UTC.
-- If Date doesn't match Format, No_Time is returned.
function Format_Date
(Date : Ada.Calendar.Time;
Use_GMT : Boolean := False;
From_Line : Boolean := False;
No_TZ : Boolean := False;
Show_Time : Boolean := True;
Show_Seconds : Boolean := True;
Show_Day : Boolean := True) return String;
-- Format the date as a RFC 2822 string, eg:
-- Fri, 09 Nov 2001 01:08:47 -0000
-- If Use_GMT is true, the time stamp is rendered in UTC, and the time zone
-- is shown as "GMT". This is needed for some protocols.
-- If From_Line is True, use the format of standard UNIX mailbox From_
-- lines:
-- Tue Jan 24 14:48:49 2006 +0100
-- If No_TZ is true, then the date is rendered in UTC, and no time zone
-- name is shown.
-- If Show_Seconds is false, then seconds will not be displayed (this can
-- be used to save space, but the output format is not compatible with
-- RFC 2822).
-- If Show_Day is false, the day of week is not displayed. The output is
-- also not compatible with RFC 2822.
function Format_Time (Date : Ada.Calendar.Time) return String;
-- Format the time part of Date, interpreted in UTC, as a RFC2822 string:
-- 01:08:47
---------------
-- Addresses --
---------------
function Hash (Addr : Email_Address) return Ada.Containers.Hash_Type;
package Address_Set is new Ada.Containers.Hashed_Sets
(Email_Address, Hash, "=");
function Quote (Str : String) return String;
-- Return a string which is a quoted version of Str: backslashes have been
-- replaced by \\, and double-quotes by \".
function Unquote (Str : String) return String;
-- Return an unquoted version of Str. Extra Backslashes are removed
function Parse_Address (Email : String) return Email_Address;
-- Split an email address as read from a message header into its
-- constituents
function To_Address
(Address : String;
Real_Name : String := "") return Email_Address;
-- Create an Email_Address from the given parts
function Get_Addresses (Str : String) return Address_Set.Set;
function Get_Addresses
(Str : Charset_String_List.List) return Address_Set.Set;
-- Return the list of addresses in Str.
-- The second version properly preserves real names from extended charsets.
function To_String
(Addresses : Address_Set.Set;
Separator : String := ", ";
Address_Only : Boolean := False) return String;
-- Return the list of addresses as a string compatible with RFC 2822.
-- Parsing this field with Get_Addresses would return the same set of
-- addresses of Separator has its default value.
-- if Address_Only is true, then the real names are never shown in the
-- string.
function Get_Recipients
(Msg : Message'Class; Include_From : Boolean := False)
return Address_Set.Set;
function Get_Recipients (H : Header'Class) return Address_Set.Set;
-- Return the list of all recipients of the message. This takes into
-- account all occurrences of all relevant headers.
-- In the first case, Include_From indicates whether the sender of the
-- message should also be returned.
-- ??? The 2nd function should be renamed to Get_Addresses since it applies
-- to all headers containing addresses, not only those designating
-- message recipients.
function Legacy_Format_Address
(Real : String; Address : String) return String;
-- Format the given email address and real name, using quotes and
-- backslash escaping to protect any special characters occurring in Real.
-- Note: Real should be a US ASCII string.
function Format_Address
(Email : Email_Address;
Charset : String := Charset_US_ASCII) return Charset_String_List.List;
-- Format an email address into a proper format for RFC2822
-- Charset specifies the character set for the real name.
function Format_Address
(Email : Email_Address;
Charset : String := Charset_US_ASCII) return Unbounded_String;
-- Same as above, and return result as an RFC 2047 encoded string
function Domain_From_Address (Email : String) return String;
function Domain_From_Address (Email : Email_Address) return String;
-- Return the domain name for the given Email address. In the first case,
-- Email must only contain the address, not the real name.
-- If no domain is specified, the empty string is returned. Look at
-- GNAT.Socket.Host_Name to fall back on the current host.
function Login_From_Address (Email : String) return String;
function Login_From_Address (Email : Email_Address) return String;
-- Return the login name from the given email address, ie the part before
-- the '@'. In the first case, Email must only contain the address, not the
-- real name.
----------
-- Mime --
----------
function Get_Main_Type (MIME_Type : String) return String;
-- Return the main type component of the MIME_Type, for instance "text"
-- when the type is "text/plain";
function Get_Sub_Type (MIME_Type : String) return String;
-- Return the sub type component of the MIME_Type, for instance "plain"
-- when the type is "text/plain";
---------------
-- Encodings --
---------------
procedure Quoted_Printable_Encode
(Str : String;
Charset : String;
Max_Block_Len : Integer := Integer'Last;
Where : Region := Text;
Result : out Unbounded_String);
-- Encode Str in quoted-printable format, as per RFC 2045/2047.
-- This should be used for ascii-like charsets, like all iso-8859-*
-- charsets, ie when most of the characters are already in the ASCII
-- charset (0 through 127).
procedure Quoted_Printable_Decode
(Str : String;
Result : out Unbounded_String;
Where : Region := Text);
-- Decode Str as a quoted-printable encoded string as per RFC 2045.
-- The returned value may contain non - ASCII characters, their
-- interpretation is left to the called (ie the charset is unknown).
-- If the optional argument header is present and true, underscore will be
-- decoded as space. This is used to decode "Q" encoded headers as
-- described in RFC 2047: "MIME (Multipurpose Internet Mail Extensions)
-- Part Three: Message Header Extensions for Non-ASCII Text".
procedure Base64_Encode
(Str : String;
Charset : String;
Max_Block_Len : Integer := Integer'Last;
Where : Region := Text;
Result : out Unbounded_String);
-- Encode Str in base64 format, as defined by RFC 2045.
-- This should be used for charsets that have little similarity with
-- ASCII, for instance asian charsets.
procedure Base64_Decode
(Str : String;
Result : out Unbounded_String);
-- Decode Str from a base64 encoding, as defined by RFC 2045
procedure Encode
(Str : String;
Charset : String := Charset_US_ASCII;
Where : Region := Text;
Result : out Unbounded_String);
-- Encode Str in the best encoding to use for Charset. The encoding depends
-- on how close charset is to ASCII.
-- If Header is true, then several encoded blocks will be created as
-- required by RFC 2045 (separated by spaces). In addition, the charset is
-- included as part of the encoded field, as suitable for mail headers.
procedure Decode_Header
(Str : String;
Default_Charset : String := Charset_US_ASCII;
Result : out Charset_String_List.List;
Where : Any_Header := Other_Header);
-- Decode Str. It might contain several mime-encoded sections, with
-- different charsets. Each section is returned separately. For each
-- section, Contents must be interpreted in the context of that charset.
-- When several adjacent sections have the same encoding, they are merged
-- for ease of use.
-- When no charset is specified for a section, the default charset is
-- assumed.
-- This function can also be used for headers, when each section starts
-- with =?charset?q?....?=.
--------------
-- Charsets --
--------------
procedure Flatten
(List : Charset_String_List.List;
Result : out Unbounded_String);
-- Return a flatten version of List, where all sections are concatenated.
-- It will not be possible to go back to List afterward, since the sections
-- are not MIME-encoded, only their contents is taken into account.
-- This should never be used for display to the user, only for internal
-- manipulation when the exact charset of each section is irrelevant.
procedure To_String
(List : Charset_String_List.List;
Result : out Unbounded_String;
Where : Any_Header := Other_Header);
-- Return a single string representing list, where all sections is
-- properly encoded and surrounded by =?charset? markers.
end GNATCOLL.Email.Utils;
|