Mail (Email function): Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
|||
| (4 intermediate revisions by 2 users not shown) | |||
| Line 7: | Line 7: | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>%rc</th> | <tr><th>%rc</th> | ||
<td> | <td>A numeric variable to contain the return code. | ||
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. | <var class="term">%rc</var> will contain the return code sent from the SMTP server. | ||
These codes are listed in [[GetReplyCode (Email function)# | These codes are listed in [[GetReplyCode (Email function)#commerr|"SMTP server codes"]]. | ||
</td></tr> | </td></tr> | ||
<tr><th>email</th> | <tr><th>email</th> | ||
<td>An <var>Email</var> object. | <td>An <var>Email</var> object. | ||
</td></tr> | </td></tr> | ||
<tr><th><var>Port</var></th> | <tr><th><var>Port</var></th> | ||
<td>An optional string expression that identifies a previously defined Janus CLSOCK port. | <td>An optional string expression that identifies a previously defined Janus <var>[[JANUS DEFINE#type|CLSOCK]]</var> port. | ||
The default is the | The default is the <var>[[MASTER]]</var> port, if any is defined. | ||
[[MASTER]] port, if any is defined. | However, if you omit this argument and no <var>MASTER</var> port is defined, the request is cancelled (subject to the <var>CancelOnError</var> setting). | ||
However, if you omit this argument and no MASTER port is defined, | |||
the request is cancelled (subject to the <var>CancelOnError</var> setting). | |||
</td></tr> | </td></tr> | ||
<tr><th><var>CancelOnError</var></th> | <tr><th><var>CancelOnError</var></th> | ||
| Line 36: | Line 35: | ||
==Usage notes== | ==Usage notes== | ||
<ul> | <ul> | ||
<li>The | <li>The <var>Email</var> class 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 <var>AddHeader</var>. | ||
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, | ||
it is left intact. | it is left intact. | ||
The Date header generated by the | The Date header generated by the <var>Email</var> class uses the system clock (usually GMT), | ||
adjusted by the GMT offset specified in the OS system parameters. | adjusted by the GMT offset specified in the OS system parameters. | ||
<li>For <var>Mail</var> method examples, see [[Email class#Basic e-mail|"Basic e-mail"]] and | <li>For <var>Mail</var> method examples, see [[Email class#Basic e-mail example|"Basic e-mail example"]] and | ||
[[Email class#E-mail with attachment|"E-mail with attachment"]]. | [[Email class#E-mail with attachment|"E-mail with attachment"]]. | ||
</ul> | </ul> | ||
Latest revision as of 17:08, 29 July 2013
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 | 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 Email class 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 Email class 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 example" and "E-mail with attachment".