Methods and functions¶

new ( $serialized, context => $that, KEY => value, ... )

Constructor. Creates a new Sympa::Message object.

Parameters:

dup ( )

Copy constructor. Gets deep copy of instance.

to_string ( [ original => 0|1 ] )

Serializer. Returns serialized data of Message object.

Parameter:

add_header ( $field, $value, [ $index ] )

Instance method. Adds a header field named $field with body $value. If $index is given, the field will be inserted at the place it indicates: If it is 0, the field will be prepended.

delete_header ( $field, [ $index ] )

Instance method. Deletes all occurrences of the header field named $field.

replace_header ( $field, $value, [ $index ] )

Instance method. Replaces header fields named $field with $value.

head

Instance method. Gets header of the message as MIME::Head instance.

Note that returned value is real reference to internal data structure. Even if it was changed, string representation of message may not be updated. Alternatively, use "add_header"(), "delete_header"() or "replace_header"() to modify header.

check_spam_status ( )

Instance method. Gets spam status according to spam_status scenario and sets it as {spam_status} attribute.

dkim_sign ( dkim_d => $d, [ dkim_i => $i ], dkim_selector => $selector, dkim_privatekey => $privatekey )

Instance method. Adds DKIM signature to the message.

check_dkim_signature ( )

Instance method. Checks DKIM signature of the message and sets or clears {dkim_pass} item of the message object.

remove_invalid_dkim_signature ( )

Instance method. Verifies DKIM signatures included in the message, and if any of them are invalid, removes them.

check_arc_chain ( )

Instance method. Checks ARC chain of the message and sets {shelved}{arc_cv} item of the message object.

arc_seal ( )

Instance method. Adds a new ARC seal if there's an arc_cv from check_arc_chain and the cv is none or valid.

as_entity ( )

Instance method. Gets message content as MIME entity (MIME::Entity instance).

Note that returned value is real reference to internal data structure. Even if it was changed, string representation of message may not be updated. Below is better way to modify message.

    my $entity = $message->as_entity->dup;
    # ... Modify $entity...
    $message->set_entity($entity);
    

set_entity ( $entity )

Instance method. Updates message with MIME entity (MIME::Entity instance). String representation will be automatically updated.

as_string ( )

Instance method. Gets a string representation of message.

Parameter:

body_as_string ( )

Instance method. Gets body of the message as string.

Note that the result won't be decoded.

header_as_string ( )

Instance method. Gets header part of the message as string.

Note that the result won't be decoded nor unfolded.

get_header ( $field, [ $sep ] )

Instance method. Gets value(s) of header field $field, stripping trailing newline.

In scalar context without $sep, returns first occurrence or "undef". If $sep is defined, returns all occurrences joined by it, or "undef". Otherwise in array context, returns an array of all occurrences or "()".

Note: Folding newlines will not be removed.

get_decoded_header ( $tag, [ $sep ] )

Instance method. Returns header value decoded to UTF-8 or undef. Trailing newline will be removed. If $sep is given, returns all occurrences joined by it.

dump ( $output )

Instance method. Dumps a Message object to a stream.

Parameters:

add_topic ( $output )

Note: No longer used.

Instance method. Adds topic and puts header X-Sympa-Topic.

Parameters:

get_topic ( )

Note: No longer used.

Instance method. Gets topic of message.

Parameters:

None.

Returns:

clean_html ( )

Instance method. Encodes HTML parts of the message by UTF-8 and strips scripts included in them.

smime_decrypt ( )

Instance method. Decrypts message using private key of user.

Note that this method modifies Message object.

Parameters:

None.

Returns:

True value if message was decrypted. Otherwise false value.

If decrypting succeeded, {smime_crypted} item is set.

smime_encrypt ( $email )

Instance method. Encrypts message using certificate of user.

Note that this method modifies Message object.

Parameters:

smime_sign ( )

Instance method. Adds S/MIME signature to the message.

Signing key is taken from what stored in list directory.

Parameters:

None.

Returns:

True value if message was successfully signed. Otherwise false value.

check_smime_signature ( )

Instance method. Verifies S/MIME signature of the message, and if verification succeeded, sets {smime_signed} item true.

Parameters:

None

Returns:

1 if signature is successfully verified. 0 otherwise. "undef" if something went wrong.

is_signed ( )

Instance method. Checks if the message is signed.

Note: This checks if the message has appropriate content type and header parameters. Use check_smime_signature() to check if the message has properly signed content.

Currently, S/MIME-signed messages with content type "multipart/signed" or "application/pkcs7-mime" (with smime-type="signed-data" parameter) are recognized. Enveloped-only messages are not supported. The other signature mechanisms such as PGP/MIME have not been supported yet.

Parameters:

None.

Returns:

1 if the message is considered signed. 0 otherwise.

personalize ( $list, [ $rcpt ], [ $data ] )

Instance method. Personalizes a message with custom attributes of a user.

Parameters:

test_personalize ( $list )

DEPRECATED by Sympa 6.2.13. No longer available.

Instance method. Tests if personalization can be performed successfully over all subscribers of list.

Parameters:

Returns:

1 if succeed, or "undef".

personalize_text ( $body, $list, [ $rcpt ], [ $data ] )

Function. Retrieves the customized data of the users then parses the text. It returns the personalized text.

Parameters:

prepare_message_according_to_mode ( $mode, $list )

Instance method. Transforms the message according to reception mode: 'mail', 'notice' or 'txt'. Note: 'html' mode was deprecated as of 6.2.23b.2.

By 'nomail', 'digest', 'digestplain' or 'summary' mode, the message is not modified.

Returns modified message object itself, or "undef" if transformation failed.

decorate ( )

OBSOLETED. Use prepare_message_according_to_mode('mail', $list).

Instance method. Adds footer/header to a message.

reformat_utf8_message ( )

Instance method. Reformats bodies of text parts contained in the message using recommended encoding schema and/or charsets defined by MIME::Charset.

MIME-compliant headers are appended / modified. And custom X-Mailer: header is appended :).

Parameters:

get_plain_body ( )

Instance method. Gets decoded content of text/plain part.

The text will be converted to UTF-8. Flowed text (see RFC 3676) will be conjuncted.

check_virus_infection ( [ debug => 1 ] )

Instance method. Checks the message using anti-virus plugin, if configuration requests it.

Parameter:

TBD.

Returns:

The name of malware the message contains, if any; "unknown" for unidentified malware; "undef" if checking failed; otherwise 0.

get_plaindigest_body ( )

Instance method. Returns a plain text version of message, suitable for use in plain text digests.

dmarc_protect ( )

Instance method. Munges the "From:" header field if we are using DMARC Protection mode.

Parameters:

None.

Returns:

None. "From:" field of the message may be modified.

compute_topic ( )

Instance method. Compute the topic of the message. The topic is got from keywords defined in list parameter msg_topic.keywords. The keyword is applied on the subject and/or the body of the message according to list parameter msg_topic_keywords_apply_on

Parameters:

None.

Returns:

String of tag(s), can be separated by ',', can be empty.

get_id ( )

Instance method. Gets unique identifier of instance.

Context and Metadata¶

Context and metadata given to constructor are accessible as hash elements of object. These are typically used.

{context}

Context of the message, Sympa::List object, robot or '*'.

{date}

The UNIX time messages was initially accepted, or the time message should be delivered.

{domainpart}

{listname}

{listtype}

{localpart}

Domain, name, type and local part of context.

{priority}

Priority of the message.

{tag}

Tag of packet used by bulk spool to control logging. '0' is the first message of multiple packet. 'z' is the last. 's' is the single message with single packet.

{time}

The Unix time in floating point number when the message was stored into the spool. This is used by bulk spool.

Attributes¶

These are accessible as hash elements of objects.

{checksum}

No longer used. It is kept for compatibility with Sympa 6.1.x or earlier. See also upgrade_send_spool(1).

{envelope_sender}

Envelope sender, a.k.a. "Unix From". This is not always same as {sender} attribute nor the content of "From:" field.

'<>' will be used for "null envelope sender".

{family}

Name of family (see Sympa::Family) the message corresponds to. This is given by familyqueue(8) program.

{gecos}

Display name of actual sender (see {sender} below), if any.

{md5_check}

True value indicates that the message has been authenticated by "md5" level (password authentication). This is set by web mailer of WWSympa and used by incoming spool.

{message_id}

Original message ID of the message.

{rcpt}

Recipients for delivery. This is kept for compatibility with earlier releases.

{sender}

Actual sender of the message. This is determined according to "sender_headers" configuration parameter. See also {envelope_sender} above.

{shelved}

Shelved processing. Hashref with multiple items. Currently these items are available:

{spam_status}

Result of spam check. This is set by "check_spam_status"() method.

Serialization¶

Sympa::Message object includes number of slots as hash items: metadata, context, attributes and message content. Metadata including context are given by spool: See "Marshaling and unmarshaling metadata" in Sympa::Spool.

Logically, objects are stored into physical spool as serialized form and deserialized when they are fetched from spool. Attributes will be serialized and deserialized along with raw message content. Attributes are encoded in "X-Sympa-*:" pseudo-header fields and "Return-Path:" header field. Below is an example of serialized form.

  X-Sympa-Message-ID: 123456789.12345@domain.name : {message_id} attribute
  X-Sympa-Sender: user01@user.sympa.test          : {sender} attribute
  X-Sympa-Display-Name: Infant                    : {gecos} attribute
  X-Sympa-Shelved: dkim_sign; tracking=mdn        : {shelved} attribute
  X-Sympa-Spam-Status: ham                        : {spam_status} attribute
  Return-Path: sympa-request@domain.name          : {envelope_sender} attribute
  Message-Id: <123456789.12345@domain.name>       :   ---
  From: Infant <user@other.host.dom>              :    |
  To: User <user@some.host.name>                  :    |
  Subject: Howdy world                            :    | Raw message content
  X-Sympa-Topic: sometopic                        :    |
                                                  :    |
  Bonjour, le monde.                              :    |
                                                  :   ---

On msg, automatic and bounce spools, "Return-Path:" header fields are given by MDA and "X-Sympa-*:" header fields are given by queue programs. On other spools, they are given by components of Sympa.

Pseudo-header fields should appear at beginning of serialized content. Fields appear at other places (e.g. "X-Sympa-Topic:" field above) are not attributes but are the part of raw message content.

Pseudo-header fields should not be included in actually sent messages.

Adding "Return-Path:" field¶

We trust in "Return-Path:" header field only at the top of message to prevent forgery. To ensure it will be added to messages by MDA,

Sendmail

Add "P" in the "F=" flags of local mailer line (such as "Mlocal").

Postfix

Exim

Set "return_path_add" to be true with pipe_transport.

qmail

Use preline(1).

sympa-milter

As of version 0.7, prepending "Return-Path:" is available.