- Content of this page was obsoleted.
× Internals: Message.pm
This module provides objects to encapsulate file message in order to prevent it from its alteration for using signatures.
new()
Creates an object Message and initialize it:
msg
: ref(MIME::Entity)altered
if the message is alteredfilename
: the file containing the messagesize
: the message sizesender
: the first email address, in the 'From' fielddecoded_subject
: the 'Subject' field decoded by MIME::Words::decode_mimewordssubject_charset
: the charset used to encode the 'Subject' fieldrcpt
: the 'X-Sympa-To' fieldlist
: ref(List) if it is a message no addressed to Sympa or a listmastertopic
: the 'X-Sympa-Topic' field.- in a 'openssl' context - decrypt message:
smime_crypted
: 'smime_crypted' if it is in a 'openssl' contextorig_msg
: ref(MIME::Entity) - crypted messagemsg
: ref(MIME::Entity) - decrypted message (see tools::smime_decrypt())msg_as_string
: string - decrypted message (see tools::smime_decrypt())
- in a 'openssl' context - check signature:
protected
: 1 if the message should not be alteredsmime_signed
: 1 if the message is signedsmime_subject
: ref(HASH)if the message is signed - information on the signer see tools::smime_parse_cert().
IN:
pkg
(+): Messagefile
(+): the message file
OUT: ref(Message) undef
dump()
Dump the message object in the file descriptor $output
IN:
self
(+): ref(Message)output
(+): file descriptor
OUT: '1'
add_topic()
Adds the message topic in the Message object (topic
' and adds the 'X-Sympa-Topic' field in the ref(MIME::Entity) msg
'.
IN:
self
(+): ref(Message)topic
(+): string splitted by ',' - list of topic
OUT: '1'
get_topic()
Returns the topic(s) of the message
IN: self
(+): ref(Message)
OUT: if no message topic | string splitted by ',' if message topic
N.B.:
* (+): required parameter, value must not be empty
*:
or'' for parameters value
- $: reference to code parameters or variables
- condition for parameter