1Mail::MIMEDefang::ActMiaoinls:(:3M)IMEDefang::Actions DocumMeanitla:t:iMoInMEDefang::Actions(3)
2
3
4

NAME

6       Mail::MIMEDefang::Actions - actions methods for email filters
7

DESCRIPTION

9       Mail::MIMEDefang::Actions are a set of methods that can be called from
10       mimedefang-filter to accept or reject the email message.
11

METHODS

13       action_rebuild
14           Sets a flag telling MIMEDefang to rebuild message even if it is
15           unchanged.
16
17       action_add_entity
18           Makes a note to add a part to the message.  Parts are *actually*
19           added at the end, which lets us correctly handle non-multipart
20           messages or multipart/foo where "foo" != "mixed".  Sets the rebuild
21           flag.
22
23       action_add_part
24           Makes a note to add a part to the message.  Parts are *actually*
25           added at the end, which lets us correctly handle non-multipart
26           messages or multipart/foo where "foo" != "mixed".  Sets the rebuild
27           flag.
28
29       process_added_parts
30           Actually adds requested parts to entity.  Ensures that entity is of
31           type multipart/mixed.
32
33       action_insert_header
34           Makes a note for milter to insert a header in the message in the
35           specified position.  May not be supported on all versions of
36           Sendmail; on unsupported versions, the C milter falls back to
37           action_add_header.
38
39       action_add_header
40           Makes a note for milter to add a header to the message.
41
42       action_change_header
43           Makes a note for milter to change a header in the message.
44
45       action_delete_header
46           Makes a note for milter to delete a header in the message.
47
48       action_delete_all_headers
49           Makes a note for milter to delete all instances of header.
50
51       action_accept
52           Makes a note for milter to accept the current part.
53
54       action_accept_with_warning
55           Makes a note for milter to accept the current part, but add a
56           warning to the message.
57
58       message_rejected
59           Method that returns True if message has been rejected (with
60           action_bounce or action_tempfail), false otherwise.
61
62       action_drop
63           Makes a note for milter to drop the current part without any
64           warning.
65
66       action_drop_with_warning
67           Makes a note for milter to drop the current part and add a warning
68           to the message.
69
70       action_replace_with_warning
71           Makes a note for milter to drop the current part and replace it
72           with a warning.
73
74       action_defang
75           Makes a note for milter to defang the current part by changing its
76           name, filename and possibly MIME type.
77
78       action_external_filter
79           Pipes the part through the UNIX command $cmd, and replaces the part
80           with the result of running the filter.
81
82       action_quarantine
83           Makes a note for milter to drop the current part, emails the
84           MIMEDefang administrator a notification, and quarantines the part
85           in the quarantine directory.
86
87       action_sm_quarantine
88           Asks Sendmail to quarantine message in mqueue using Sendmail's
89           smfi_quarantine facility.
90
91       get_quarantine_dir
92           Method that returns the configured quarantine directory.
93
94       action_quarantine_entire_message
95           Method that puts a copy of the entire message in the quarantine
96           directory.
97
98       action_bounce
99           Method that Causes the SMTP transaction to fail with an SMTP 554
100           failure code and the specified reply text.  If code or DSN are
101           omitted or invalid, use 554 and 5.7.1.
102
103       action_discard
104           Method that causes the entire message to be silently discarded
105           without without notifying anyone.
106
107       action_notify_sender
108           Method that sends an email to the sender containing the $msg.
109
110       action_notify_administrator
111           Method that sends an email to MIMEDefang administrator containing
112           the $msg.
113
114       action_tempfail
115           Method that sends a temporary failure with a 4.x.x SMTP code.  If
116           code or DSN are omitted or invalid, use 451 and 4.3.0.
117
118       add_recipient
119           Signals to MIMEDefang to add a recipient to the envelope.
120
121       delete_recipient
122           Signals to MIMEDefang to delete a recipient from the envelope.
123
124       change_sender
125           Signals to MIMEDefang to change the envelope sender.
126
127       action_replace_with_url
128           Method that places the part in doc_root/{sha1_of_part}.ext and
129           replaces it with a text/plain part giving the URL for pickup.
130
131
132
1333.3                               2023-01-18      Mail::MIMEDefang::Actions(3)