2000-10-26 22:43:56 +00:00
|
|
|
<html><head>
|
|
|
|
|
<title>GSMimeDocument</title>
|
|
|
|
|
</head>
|
|
|
|
|
<body>
|
2001-04-25 14:19:57 +00:00
|
|
|
<a href ="GSMime.html">[Up] </a>
|
|
|
|
|
<a href ="GSMimeParser.html">[Next] </a>
|
2000-10-26 22:43:56 +00:00
|
|
|
<h1>GSMimeDocument</h1>
|
|
|
|
|
<h3>Authors </h3>
|
|
|
|
|
<dl>
|
|
|
|
|
<dt><a href ="http://www.gnustep.org/developers/whoiswho.html">Richard Frith-Macdonald</a>
|
|
|
|
|
<dd>
|
|
|
|
|
</dl>
|
2001-03-03 10:00:31 +00:00
|
|
|
<p>Version: $Revision$</p>
|
|
|
|
|
<p>Date: $Date$</p>
|
2000-10-26 22:43:56 +00:00
|
|
|
<h2><a name ="cont-0">GSMimeDocument</a></h2>
|
|
|
|
|
<h2><a name ="GSMimeDocument">GSMimeDocument</a></h2>
|
|
|
|
|
<p><b>Declared in: </b> Foundation/GSMime.h</p>
|
|
|
|
|
<p><b>Inherits from: </b> NSObject</p>
|
|
|
|
|
<p><b>Conforms to: </b> NSObject
|
|
|
|
|
</p>
|
|
|
|
|
<hr>
|
|
|
|
|
|
|
|
|
|
<p>
|
|
|
|
|
|
|
|
|
|
This class is intended to provide a wrapper for MIME messages
|
|
|
|
|
permitting easy access to the contents of a message and
|
|
|
|
|
providing a basis for parsing an unparsing messages that
|
|
|
|
|
have arrived via email or as a web document.
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<p>
|
|
|
|
|
|
|
|
|
|
The class keeps track of all the document headers, and provides
|
|
|
|
|
methods for modifying the headers that apply to a document and
|
|
|
|
|
for looking at the header structures, by providing an info
|
|
|
|
|
dictionary containing the various parts of a header.
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<p>
|
|
|
|
|
|
|
|
|
|
The common dictionary keys used for elements provided for
|
|
|
|
|
<em>all</em> headers are -
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<dl>
|
|
|
|
|
<dt>RawHeader
|
|
|
|
|
<dd>This is the unmodified text of the header
|
|
|
|
|
|
|
|
|
|
<dt>BaseName
|
|
|
|
|
<dd>This is the header name.
|
|
|
|
|
|
|
|
|
|
<dt>BaseValue
|
|
|
|
|
<dd>This is the text after the header name and colon.
|
|
|
|
|
|
|
|
|
|
<dt>Name
|
|
|
|
|
<dd>This is a lowercase representation of the header name.
|
|
|
|
|
|
|
|
|
|
<dt>Value
|
|
|
|
|
<dd>This is the value of the header (normally lower case).
|
2000-11-17 06:55:58 +00:00
|
|
|
It may only be a small subset of the information in the header
|
|
|
|
|
with other information being split into separate fields
|
|
|
|
|
depending on the type of header.
|
2000-10-26 22:43:56 +00:00
|
|
|
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
<p>
|
|
|
|
|
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2>Instance Variables </h2>
|
|
|
|
|
<ul>
|
|
|
|
|
</ul>
|
|
|
|
|
<h2>Methods </h2>
|
|
|
|
|
<ul>
|
2001-04-25 14:19:57 +00:00
|
|
|
<li ><a href ="GSMimeDocument.html#method-0">+mimeDocument</a>
|
|
|
|
|
<li ><a href ="GSMimeDocument.html#method-1">-addHeader:</a>
|
|
|
|
|
<li ><a href ="GSMimeDocument.html#method-2">-allHeaders</a>
|
|
|
|
|
<li ><a href ="GSMimeDocument.html#method-3">-content</a>
|
|
|
|
|
<li ><a href ="GSMimeDocument.html#method-4">-deleteHeader:</a>
|
|
|
|
|
<li ><a href ="GSMimeDocument.html#method-5">-deleteHeaderNamed:</a>
|
|
|
|
|
<li ><a href ="GSMimeDocument.html#method-6">-headerNamed:</a>
|
|
|
|
|
<li ><a href ="GSMimeDocument.html#method-7">-headersNamed:</a>
|
|
|
|
|
<li ><a href ="GSMimeDocument.html#method-8">-setContent:</a>
|
|
|
|
|
<li ><a href ="GSMimeDocument.html#method-9">-setHeader:</a>
|
2000-10-26 22:43:56 +00:00
|
|
|
</ul>
|
|
|
|
|
<hr><h2>Class Methods </h2>
|
|
|
|
|
<h3><a name ="method-0">mimeDocument</a></h3>
|
|
|
|
|
+ (GSMimeDocument*) <b>mimeDocument</b>;<br>
|
|
|
|
|
|
|
|
|
|
Create an empty MIME document.
|
|
|
|
|
|
|
|
|
|
<hr>
|
|
|
|
|
<hr><h2>Instances Methods </h2>
|
|
|
|
|
<h3><a name ="method-1">addHeader:</a></h3>
|
2000-11-16 12:10:37 +00:00
|
|
|
- (BOOL) <b>addHeader:</b> (NSDictionary*)headerInfo;<br>
|
|
|
|
|
|
|
|
|
|
<p>
|
|
|
|
|
|
|
|
|
|
This method may be called to add a header to the document.
|
|
|
|
|
The header must be a mutable dictionary object that contains
|
|
|
|
|
at least the fields that are standard for all headers.
|
|
|
|
|
</p>
|
2000-10-26 22:43:56 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
<hr>
|
2000-11-16 12:10:37 +00:00
|
|
|
<h3><a name ="method-2">allHeaders</a></h3>
|
|
|
|
|
- (NSArray) <b>allHeaders</b>;<br>
|
2000-10-26 22:43:56 +00:00
|
|
|
|
2000-11-16 12:10:37 +00:00
|
|
|
<p>
|
|
|
|
|
|
|
|
|
|
This method returns an array containing NSDictionary objects
|
|
|
|
|
representing the headers associated with the document.
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<p>
|
|
|
|
|
|
|
|
|
|
The order of the headers in the array is the order of the
|
|
|
|
|
headers in the document.
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
2000-10-26 22:43:56 +00:00
|
|
|
<hr>
|
|
|
|
|
<h3><a name ="method-3">content</a></h3>
|
|
|
|
|
- (id) <b>content</b>;<br>
|
|
|
|
|
|
|
|
|
|
This returns the content data of the document in the
|
|
|
|
|
appropriate format for the type of data -
|
|
|
|
|
<dl>
|
|
|
|
|
<dt>text
|
|
|
|
|
<dd>an NSString object
|
|
|
|
|
<dt>binary
|
|
|
|
|
<dd>an NSData object
|
|
|
|
|
<dt>multipart
|
|
|
|
|
<dd>an NSArray object containing GSMimeDocument objects
|
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<hr>
|
|
|
|
|
<h3><a name ="method-4">deleteHeader:</a></h3>
|
2000-11-16 12:10:37 +00:00
|
|
|
- (void) <b>deleteHeader:</b> (NSString*)rawHeader;<br>
|
2000-10-26 22:43:56 +00:00
|
|
|
|
|
|
|
|
This method removes all occurrances of headers whose raw data
|
|
|
|
|
exactly matches the supplied string.
|
|
|
|
|
|
|
|
|
|
<hr>
|
|
|
|
|
<h3><a name ="method-5">deleteHeaderNamed:</a></h3>
|
|
|
|
|
- (void) <b>deleteHeaderNamed:</b> (NSString*)aName;<br>
|
|
|
|
|
|
|
|
|
|
This method removes all occurrances of headers whose name
|
|
|
|
|
matches the supplied string.
|
|
|
|
|
|
|
|
|
|
<hr>
|
2000-11-16 12:10:37 +00:00
|
|
|
<h3><a name ="method-6">headerNamed:</a></h3>
|
|
|
|
|
- (NSDictionary*) <b>headerNamed:</b> (NSString*)aName;<br>
|
2000-10-26 22:43:56 +00:00
|
|
|
|
|
|
|
|
This method returns the info dictionary for the first header
|
|
|
|
|
whose name equals the supplied argument.
|
|
|
|
|
|
|
|
|
|
<hr>
|
2000-11-16 12:10:37 +00:00
|
|
|
<h3><a name ="method-7">headersNamed:</a></h3>
|
|
|
|
|
- (NSArray*) <b>headersNamed:</b> (NSString*)aName;<br>
|
2000-10-26 22:43:56 +00:00
|
|
|
|
|
|
|
|
This method returns an array of info dictionaries for all headers
|
|
|
|
|
whose names equal the supplied argument.
|
|
|
|
|
|
|
|
|
|
<hr>
|
2000-11-16 12:10:37 +00:00
|
|
|
<h3><a name ="method-8">setContent:</a></h3>
|
2000-10-26 22:43:56 +00:00
|
|
|
- (BOOL) <b>setContent:</b> (id)newContent;<br>
|
|
|
|
|
|
|
|
|
|
Sets a new value for the content of the document.
|
|
|
|
|
|
|
|
|
|
<hr>
|
2000-11-16 12:10:37 +00:00
|
|
|
<h3><a name ="method-9">setHeader:</a></h3>
|
|
|
|
|
- (BOOL) <b>setHeader:</b> (NSDictionary*)headerInfo;<br>
|
2000-10-26 22:43:56 +00:00
|
|
|
|
|
|
|
|
This method may be called to set a header in the document.
|
|
|
|
|
Any other headers with the same name will be removed from
|
|
|
|
|
the document.
|
|
|
|
|
|
|
|
|
|
<hr>
|
|
|
|
|
</body>
|
|
|
|
|
|
|
|
|
|
</html>
|
