Camel.MimeFilter¶
- Subclasses:
Camel.MimeFilterBasic
,Camel.MimeFilterBestenc
,Camel.MimeFilterCRLF
,Camel.MimeFilterCanon
,Camel.MimeFilterCharset
,Camel.MimeFilterEnriched
,Camel.MimeFilterFrom
,Camel.MimeFilterGZip
,Camel.MimeFilterHTML
,Camel.MimeFilterIndex
,Camel.MimeFilterLinewrap
,Camel.MimeFilterPgp
,Camel.MimeFilterProgress
,Camel.MimeFilterToHTML
,Camel.MimeFilterWindows
,Camel.MimeFilterYenc
Methods¶
- Inherited:
- Structs:
class |
|
|
|
|
|
|
|
|
|
|
Virtual Methods¶
- Inherited:
|
|
|
|
|
Properties¶
None
Signals¶
- Inherited:
Fields¶
- Inherited:
Name |
Type |
Access |
Description |
---|---|---|---|
backbuf |
r |
||
backlen |
r |
||
backsize |
r |
||
outbuf |
r |
||
outpre |
r |
||
outptr |
r |
||
outreal |
r |
||
outsize |
r |
||
parent |
r |
Class Details¶
- class Camel.MimeFilter(**kwargs)¶
- Bases:
- Abstract:
Yes
- Structure:
- classmethod new()¶
- Returns:
a new
Camel.MimeFilter
- Return type:
Create a new
Camel.MimeFilter
object.
- backup(data)¶
- Parameters:
data (
bytes
) – data buffer to backup
Saves data to be used as prespace input data to the next call to
Camel.MimeFilter.filter
() orCamel.MimeFilter.complete
().Note: New calls replace old data.
- complete(in_, prespace)¶
- Parameters:
- Returns:
- out:
pointer to the output buffer (to be set)
- outprespace:
pointer to the output prespace length (to be set)
- Return type:
Passes the input buffer, in, through self and generates an output buffer, out and makes sure that all data is flushed to the output buffer. This must be the last filtering call made, no further calls to
Camel.MimeFilter.filter
() may be called on self until self has been reset usingCamel.MimeFilter.reset
().
- filter(in_, prespace)¶
- Parameters:
- Returns:
- out:
pointer to the output buffer (to be set)
- outprespace:
pointer to the output prespace length (to be set)
- Return type:
Passes the input buffer, in, through self and generates an output buffer, out.
- reset()¶
Resets the state on self so that it may be used again.
- set_size(size, keep)¶
- Parameters:
Ensure that self has enough storage space to store size bytes for filter output.
- do_complete(in_, prespace) virtual¶
- Parameters:
- Returns:
- out:
pointer to the output buffer (to be set)
- outprespace:
pointer to the output prespace length (to be set)
- Return type:
Passes the input buffer, in, through filter and generates an output buffer, out and makes sure that all data is flushed to the output buffer. This must be the last filtering call made, no further calls to
Camel.MimeFilter.filter
() may be called on filter until filter has been reset usingCamel.MimeFilter.reset
().
- do_filter(in_, prespace) virtual¶
- Parameters:
- Returns:
- out:
pointer to the output buffer (to be set)
- outprespace:
pointer to the output prespace length (to be set)
- Return type:
Passes the input buffer, in, through filter and generates an output buffer, out.
- do_reset() virtual¶
Resets the state on filter so that it may be used again.