Returns:

domain address to which bounces are directed to. If empty, uses domain from FixedSenderEmail parameter, otherwise the hostname in config.tcl is used.

Partial Call Graph (max 5 caller/called nodes):

Testcases:

No testcase defined.

Determine, whether the outgoing SMTPHost is configured and reachable.

Partial Call Graph (max 5 caller/called nodes):

Testcases:

No testcase defined.

Parameters:

email (required)

Partial Call Graph (max 5 caller/called nodes):

Testcases:

No testcase defined.

Generate an id suitable as a Message-Id: header for an email.

Returns:

valid message-id for mail header

Partial Call Graph (max 5 caller/called nodes):

Testcases:

No testcase defined.

Checks if passed variable is already an array of emails, user_names and user_ids. If not, get the additional data from the db and return the full array.

Switches:

-addresses (required)

Options:

-addresses

variable to checked for array

Returns:

array of emails, user_names and user_ids to be used for the mail procedures

Partial Call Graph (max 5 caller/called nodes):

Testcases:

No testcase defined.

Get the SMTP Parameters and return these as a dict.

Returns:

dict with keys identical to the package parameters

Partial Call Graph (max 5 caller/called nodes):

Testcases:

No testcase defined.

Returns:

package_id of this package

Partial Call Graph (max 5 caller/called nodes):

Testcases:

No testcase defined.

Returns an apm-parameter value of this package Deprecated: just a wrapper for parameter::get

Switches:

-name (required)

-default (optional)

Options:

-name

parameter name

-default

default parameter value

Returns:

apm-parameter value of this package

See Also:

• parameter::get

Partial Call Graph (max 5 caller/called nodes):

Testcases:

No testcase defined.

Logs mail sending time for user

Switches:

-user_id (required)

Options:

-user_id

user for whom email sending should be logged

Partial Call Graph (max 5 caller/called nodes):

Testcases:

No testcase defined.

Returns:

incoming mail directory to be scanned for bounces

Partial Call Graph (max 5 caller/called nodes):

Testcases:

No testcase defined.

Interpolates a set of values into a string. This is directly copied from the bulk mail package. DEPRECATED: duplicated code from bulk-mail that could be replaced by "string map"

Switches:

-values (required)

a list of key, value pairs, each one consisting of a target string and the value it is to be replaced with.

-text (required)

the string that is to be interpolated

Returns:

the interpolated string

See Also:

• "string map"

Partial Call Graph (max 5 caller/called nodes):

Testcases:

No testcase defined.

Extracts the email address out of a mail address (like Joe User <joe@user.com>)

Switches:

-email (required)

Options:

-email

mail address to be parsed

Returns:

only the email address part of the mail address

Partial Call Graph (max 5 caller/called nodes):

Testcases:

No testcase defined.

Prepare an email to be sent. Various email attributes can be specified, such as subject, body, senders, recipients, attachments and so on. The proc relies on MIME and SMTP.

Switches:

-send_immediately (optional, boolean)

The email is send immediately and not stored in the acs_mail_lite_queue

-valid_email (optional, boolean)

-to_addr (required)

List of e-mail addresses to send this mail to.

-from_addr (required)

E-Mail address of the sender.

-subject (optional)

of the email

-body (required)

Text body of the email

-mime_type (optional, defaults to "text/plain")

MIME Type of the mail to send out. Can be "text/plain", "text/html".

-cc_addr (optional)

List of CC Users e-mail addresses to send this mail to.

-bcc_addr (optional)

List of CC Users e-mail addresses to send this mail to.

-reply_to (optional)

-package_id (optional)

Package ID of the sending package

-no_callback (optional, boolean)

Boolean that indicates if callback should be executed or not. If you don't provide it it will execute callbacks

-file_ids (optional)

List of file ids (items or revisions) to be sent as attachments. This will only work with files stored in the file-storage.

-filesystem_files (optional)

List of regular files on the filesystem to be sent as attachments.

-delete_filesystem_files (optional, boolean)

-extraheaders (optional)

List of keywords and their values passed in for headers. Interesting ones are: "Precedence: list" to disable autoreplies and mark this as a list message. This is as list of lists !!

-use_sender (optional, boolean)

Boolean indicating that from_addr should be used regardless of fixed-sender parameter

-object_id (optional)

Partial Call Graph (max 5 caller/called nodes):

Testcases:

email_send

Prepare an email to be sent immediately. Various email attributes can be specified, such as subject, body, senders, recipients, attachments and so on. The proc relies on MIME and SMTP.

Switches:

-valid_email_p (optional, defaults to "0")

-to_addr (required)

List of e-mail addresses to send this mail to.

-cc_addr (optional)

List of CC Users e-mail addresses to send this mail to.

-bcc_addr (optional)

List of CC Users e-mail addresses to send this mail to.

-from_addr (required)

E-Mail address of the sender.

-reply_to (optional)

E-Mail address to which replies should go. Defaults to from_addr

-subject (optional)

of the email

-body (required)

Text body of the email

-package_id (optional)

Package ID of the sending package

-file_ids (optional)

List of file ids (items or revisions) to be sent as attachments. This will only work with files stored in the file-storage.

-filesystem_files (optional)

List of regular files on the filesystem to be sent as attachments.

-delete_filesystem_files_p (optional, defaults to "0")

Decides if we want files specified by the 'file' parameter to be deleted once sent.

-mime_type (optional, defaults to "text/plain")

MIME Type of the mail to send out. Can be "text/plain", "text/html".

-no_callback_p (optional, defaults to "0")

Indicates if callback should be executed or not. If you don't provide it it will execute callbacks.

-extraheaders (optional)

List of keywords and their values passed in for headers. Interesting ones are: "Precedence: list" to disable autoreplies and mark this as a list message. This is as list of lists !!

-use_sender_p (optional, defaults to "0")

Boolean indicating that from_addr should be used regardless of fixed-sender parameter

-object_id (optional)

Object id that caused this email to be sent

-force_delivery_mode (optional)

Force the specified delivery mode for this single call

Partial Call Graph (max 5 caller/called nodes):

Testcases:

No testcase defined.

Send messages via SMTP

Switches:

-multi_token (required)

Multi Token generated which is passed directly to smtp::sendmessage

-headers (required)

List of list of header key-value pairs like {{from malte@cognovis.de} {to malte@cognovis.de}}

-originator (required)

-delivery_dict (required)

dictionary of delivery parameters including the SMTP* configuration parameters

Partial Call Graph (max 5 caller/called nodes):

Testcases:

No testcase defined.

Send messages in the acs_mail_lite_queue table.

Partial Call Graph (max 5 caller/called nodes):

Testcases:

No testcase defined.

Validates if provided signature syntactically matches message_id as generated by OpenACS and equals to the hash of the provided signature. GN: not sure, why both is checked.

Switches:

-signature (required)

signature to be checked

-message_id (required)

message ID that the signature should be checked against

Returns:

boolean 0 or 1

Partial Call Graph (max 5 caller/called nodes):

Testcases:

No testcase defined.

Replacement for ns_sendmail for backward compatibility.

Parameters:

to (required)

from (required)

subject (required)

body (required)

extraheaders (optional)

bcc (optional)

Partial Call Graph (max 5 caller/called nodes):

Testcases:

No testcase defined.