Mail (Email function): Difference between revisions
Jump to navigation
Jump to search
m (→Usage notes) |
mNo edit summary |
||
| Line 11: | Line 11: | ||
A value of 0 indicates success; a value of 1 indicates a communication error. | A value of 0 indicates success; a value of 1 indicates a communication error. | ||
If some other unexpected content is present or event occurs, | If some other unexpected content is present or event occurs, | ||
<var class="term">%rc</var> will contain the return code sent from the SMTP server. | |||
These codes are listed in [[GetReplyCode (Email function)#SMTP server codes|"SMTP server codes"]]. | These codes are listed in [[GetReplyCode (Email function)#SMTP server codes|"SMTP server codes"]]. | ||
</td></tr> | </td></tr> | ||
<tr><th> | <tr><th>email</th> | ||
<td> | <td>An <var>Email</var> object. | ||
</td></tr> | </td></tr> | ||
<tr><th> | <tr><th><var>Port</var></th> | ||
<td>An optional string expression that identifies a previously | <td>An optional string expression that identifies a previously defined Janus CLSOCK port. | ||
defined Janus CLSOCK port. | The default is the | ||
The | |||
[[MASTER]] port, if any is defined. | [[MASTER]] port, if any is defined. | ||
However, if you omit | However, if you omit this argument and no MASTER port is defined, | ||
the request is cancelled (subject to the | the request is cancelled (subject to the <var>CancelOnError</var> setting). | ||
</td></tr> | </td></tr> | ||
<tr><th> | <tr><th><var>CancelOnError</var></th> | ||
<td>An optional numeric expression that controls whether the request is | <td>An optional numeric expression that controls whether the request is cancelled if a communication/socket error occurs: | ||
cancelled if a communication/socket error occurs: | |||
<ul> | <ul> | ||
<li>If zero, the request is ''not'' cancelled on these errors. | <li>If zero, the request is ''not'' cancelled on these errors. | ||
| Line 38: | Line 36: | ||
==Usage notes== | ==Usage notes== | ||
<ul> | <ul> | ||
<li>The SMTP Helper adds a | <li>The SMTP Helper adds a "Date:" header to an <var>Email</var> object instance by default | ||
if you do not explicitly add one with AddHeader. | if you do not explicitly add one with AddHeader. | ||
If a Date header is present at the time the mail method is invoked, | If a Date header is present at the time the mail method is invoked, | ||
Revision as of 17:48, 7 February 2012
Send the mail message (Email class)
This callable method sends the mail message to an SMTP server.
Syntax
[%rc =] email:Mail[( [[Port=] string], [[CancelOnError=] number], - [Userid= string], [Password= string])]
Syntax terms
| %rc | If specified, a numeric variable to contain the return code.
A value of 0 indicates success; a value of 1 indicates a communication error. If some other unexpected content is present or event occurs, %rc will contain the return code sent from the SMTP server. These codes are listed in "SMTP server codes". |
|---|---|
| An Email object. | |
| Port | An optional string expression that identifies a previously defined Janus CLSOCK port.
The default is the MASTER port, if any is defined. However, if you omit this argument and no MASTER port is defined, the request is cancelled (subject to the CancelOnError setting). |
| CancelOnError | An optional numeric expression that controls whether the request is cancelled if a communication/socket error occurs:
|
Usage notes
- The SMTP Helper adds a "Date:" header to an Email object instance by default if you do not explicitly add one with AddHeader. If a Date header is present at the time the mail method is invoked, it is left intact. The Date header generated by the SMTP Helper uses the system clock (usually GMT), adjusted by the GMT offset specified in the OS system parameters.
- For Mail method examples, see "Basic e-mail" and "E-mail with attachment".