Fields and methods of the helma.Mail class.
To use this optional module, its repository needs to be added to the application, for example by calling app.addRepository('modules/helma/Mail.js')
To use this optional module, its repository needs to be added to the application, for example by calling app.addRepository('modules/helma/Mail.js')
Mail client enabling you to send e-mail via SMTP using Packages.javax.mail.
parameters
| String | smtp | as String, the hostname of the mail server |
methods
- setAuthentication(uname, pwd)
- setDebug(debug)
- setFrom(addstr, name)
- setHeader(name, value)
- addHeader(name, value)
- getHeader(name)
- removeHeader(name)
- setReplyTo(addstr)
- setTo(addstr, name)
- addTo(addstr, name)
- addCC(addstr, name)
- addBCC(addstr, name)
- setSubject(subject)
- setText(text)
- addText(text)
- setMultipartType(messageType)
- getMultipartType(messageType)
- addPart(obj, filename, contentType)
- writeToFile(dir)
- send()
properties
The status of this Mail object. This equals
0 unless
an error occurred. See {@link helma.Mail Mail.js} source code for a list of
possible error codes.Methods
Sets username and password to use for SMTP authentication.
parameters
| String | uname | The username to use |
| String | pwd | The password to use |
Switches debug mode on or off.
parameters
| Boolean | debug | If true debug mode is enabled |
Sets the sender of an e-mail message.
The first argument specifies the receipient's e-mail address. The optional second argument specifies the name of the recipient.
The first argument specifies the receipient's e-mail address. The optional second argument specifies the name of the recipient.
parameters
| String | addstr | as String, sender email address |
| String | name | as String, optional sender name |
Set a header in the e-mail message. If the given header is already set the previous
value is replaced with the new one.
parameters
| name | a header name | |
| value | the header value |
Set a header in the e-mail message. If the given header is already set the previous
value is replaced with the new one.
parameters
| name | a header name | |
| value | the header value |
Get all the headers for this header name.
Returns null if no headers for this header name are available.
parameters
| name | a header name |
returns
| String[] | a string array of header values, or null |
Sets the Reply-To address of an e-mail message.
parameters
| String | addstr | as String, the reply-to email address |
Sets the recipient of an e-mail message.
The first argument specifies the receipient's
e-mail address. The optional second argument
specifies the name of the recipient.
parameters
| String | addstr | as String, receipients email address |
| String | name | as String, optional receipients name |
see
Adds a recipient to the address list of an e-mail message.
The first argument specifies the receipient's e-mail address. The optional second argument specifies the name of the recipient.
The first argument specifies the receipient's e-mail address. The optional second argument specifies the name of the recipient.
parameters
| String | addstr | as String, receipients email address |
| String | name | as String, optional receipients name |
see
Adds a recipient to the list of addresses to get a "carbon copy"
of an e-mail message.
The first argument specifies the receipient's e-mail address. The optional second argument specifies the name of the recipient.
The first argument specifies the receipient's e-mail address. The optional second argument specifies the name of the recipient.
parameters
| String | addstr | as String, receipients email address |
| String | name | as String, optional receipients name |
Adds a recipient to the list of addresses to get a "blind carbon copy" of an e-mail message.
The first argument specifies the receipient's e-mail address. The optional second argument specifies the name of the recipient.
The first argument specifies the receipient's e-mail address. The optional second argument specifies the name of the recipient.
parameters
| String | addstr | as String, receipients email address |
| String | name | as String, optional receipients name |
Sets the subject of an e-mail message.
parameters
| String | subject | as String, the email subject |
Sets the body text of an e-mail message.
parameters
| String | text | as String, to be appended to the message body |
see
Appends a string to the body text of an e-mail message.
parameters
| String | text | as String, to be appended to the message body |
see
Sets the MIME multiparte message subtype. The default value is
"mixed" for messages of type multipart/mixed. A common value
is "alternative" for the multipart/alternative MIME type.
parameters
| String | messageType | the MIME subtype such as "mixed" or "alternative". |
see
Returns the MIME multiparte message subtype. The default value is
"mixed" for messages of type multipart/mixed.
parameters
| messageType |
returns
| the MIME subtype |
see
Adds an attachment to an e-mail message.
The attachment needs to be either a helma.util.MimePart Object retrieved through the global getURL function, or a {@link helma.File} object, or a String.
Use the getURL() function to retrieve a MIME object or wrap a helma.File object around a file of the local file system.
The attachment needs to be either a helma.util.MimePart Object retrieved through the global getURL function, or a {@link helma.File} object, or a String.
Use the getURL() function to retrieve a MIME object or wrap a helma.File object around a file of the local file system.
parameters
| fileOrMimeObjectOrString | obj | File, Mime object or String to attach to the email |
| String | filename | optional name of the attachment |
| String | contentType | optional content type (only if first argument is a string) |
see
Saves this mail RFC 822 formatted into a file. The name of the
file is prefixed with "helma.Mail" followed by the current time
in milliseconds and a random number.
parameters
| helma.File | dir | An optional directory where to save this mail to. If omitted the mail will be saved in the system's temp directory. |
Returns the source of this mail as RFC 822 formatted string.
returns
| The source of this mail as RFC 822 formatted string |
Sends an e-mail message.
This function sends the message using the SMTP server as specified when the Mail object was constructed using helma.Mail.
If no smtp hostname was specified when the Mail object was constructed, the smtp property in either the app.properties or server.properties file needs to be set in order for this to work.
As a fallback, the message will then be written to file using the {@link #writeToFile} method. Additionally, the location of the message files can be determined by setting smtp.dir in app.properties to the desired file path.
This function sends the message using the SMTP server as specified when the Mail object was constructed using helma.Mail.
If no smtp hostname was specified when the Mail object was constructed, the smtp property in either the app.properties or server.properties file needs to be set in order for this to work.
As a fallback, the message will then be written to file using the {@link #writeToFile} method. Additionally, the location of the message files can be determined by setting smtp.dir in app.properties to the desired file path.