IRISLIB database
MIMEPart Class Reference
Inheritance diagram for MIMEPart:
Collaboration diagram for MIMEPart:

Public Member Functions

_.Library.Status OnClose ()
 Make sure stream is Clear'ed when this part is closed.
 
_.Library.Status BodySet (_.CSP.BinaryStream body)
 Set the body of the attachment to a stream. More...
 
_.Library.Status ClearHeaders ()
 Clear the list of headers.
 
 GetContentTypeAttribute (_.Library.String name)
 Return an attribute of a previously stored Content-Type.
 
_.Library.String GetHeader (_.Library.String name, _.Library.String originalName)
 Lookup a previously set header. More...
 
_.Library.String NextHeader (_.Library.String name)
 Get the next header based on the upper case key used to store the headers.
 
 RemoveHeader (_.Library.String name)
 Remove a header to the MIME part.
 
 SetHeader (_.Library.String name, _.Library.String value)
 Add a header to the MIME part. More...
 
- Public Member Functions inherited from RegisteredObject
_.Library.Status OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
 This callback method is invoked when the current object is added to the SaveSet,. More...
 
_.Library.Status OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
 This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...
 
_.Library.Status OnNew ()
 This callback method is invoked by the <METHOD>New</METHOD> method to. More...
 
_.Library.Status OnValidateObject ()
 This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...
 

Static Public Member Functions

_.Library.String NormalizeContentId (_.Library.String contentId)
 Strip enclosing <> from Content-Id header. More...
 
_.Library.String NormalizeContentLocation (_.Library.String contentLocation)
 Strip whitespace and comments from the Content-Location header. More...
 

Public Attributes

 Body
 The body of the attachment as a stream. More...
 
 Boundary
 Boundary to used to separate parts of the message. More...
 
 ContentCharset
 If the <PROPERTY>ContentType</PROPERTY> starts with 'text/' then this is the. More...
 
 ContentId
 The normalized content-id. More...
 
 ContentLocation
 The normalized content-location. More...
 
 ContentTransferEncoding
 Content-Transfer-Encoding header. More...
 
 ContentType
 Sets/gets the 'Content-Type:' MIME header. More...
 
 PartOwnedStream
 If PartOwnedStream is true, then the part owns the stream and should cleasr it when. More...
 
 Parts
 Parts of a multipart message. More...
 

Private Member Functions

_.Library.Status OnNew (_.CSP.BinaryStream body)
 Optionally initialize the body (and possibly the headers) during construction.
 

Additional Inherited Members

- Static Public Attributes inherited from RegisteredObject
 CAPTION = None
 Optional name used by the Form Wizard for a class when generating forms. More...
 
 JAVATYPE = None
 The Java type to be used when exported.
 
 PROPERTYVALIDATION = None
 This parameter controls the default validation behavior for the object. More...
 

Detailed Description

For information on using this class, see MIME Messages.

Net.MIMEPart holds a MIME message part.

Member Function Documentation

◆ BodySet()

Set the body of the attachment to a stream.

If the stream contains a Headers attribute, this attribute is used to initialize the headers of the MIME part. The CSP.BinaryStream that is returned by the CSP engine is an example of such a stream with Headers attribute.

Reimplemented in MIMESerialPart.

◆ GetHeader()

_.Library.String GetHeader ( _.Library.String  name,
_.Library.String  originalName 
)

Lookup a previously set header.

The lookup is not case sensitive.

However, the original name is returned.

◆ NormalizeContentId()

_.Library.String NormalizeContentId ( _.Library.String  contentId)
static

Strip enclosing <> from Content-Id header.

Input must already be stripped of lleading and trailing whitespace

◆ NormalizeContentLocation()

_.Library.String NormalizeContentLocation ( _.Library.String  contentLocation)
static

Strip whitespace and comments from the Content-Location header.

Input must already be stripped of lleading and trailing whitespace

◆ SetHeader()

SetHeader ( _.Library.String  name,
_.Library.String  value 
)

Add a header to the MIME part.

The basic Content headers that you may want are covered by

properties of this class: Content-Type, Content-Transfer-Encoding, Content-Id and Content-Location.

Member Data Documentation

◆ Body

Body

The body of the attachment as a stream.

Either Parts must contain MIMEParts or Body must be specified, but not both.  

◆ Boundary

Boundary

Boundary to used to separate parts of the message.

If none is specified, a default is created.  

◆ ContentCharset

ContentCharset

If the <PROPERTY>ContentType</PROPERTY> starts with 'text/' then this is the.

charset to encode the contents with. This is actually specified in the MIME Content-Type header with something like:

Content-Type: text/html; charset=UTF-8

You must set this property after you set the <property>ContentType</property> or it will overwrite this value.  

◆ ContentId

ContentId

The normalized content-id.

Any leading or trailing whitespace and enclosing <> are removed.  

◆ ContentLocation

ContentLocation

The normalized content-location.

Any leading or trailing whitespace and comments are removed.  

◆ ContentTransferEncoding

ContentTransferEncoding

Content-Transfer-Encoding header.

Can be one of "base64", "quoted-printable", "7bit", "8bit", "binary".

 

◆ ContentType

ContentType

Sets/gets the 'Content-Type:' MIME header.

A Content-Type specifies the media type

of the <PROPERTY>Body</PROPERTY> data. A Content-Transfer-Encoding header may be used to indicate any additional content coding applied to the type.  

◆ PartOwnedStream

PartOwnedStream

If PartOwnedStream is true, then the part owns the stream and should cleasr it when.

the part is deleted.  

◆ Parts

Parts

Parts of a multipart message.

Either Parts must contain MIMEParts or Body must be specified, but not both.