Host (Email property): Difference between revisions
Jump to navigation
Jump to search
m (→Syntax terms) |
mNo edit summary |
||
| Line 2: | Line 2: | ||
This method retrieves or sets the host name of the SMTP server host. | This method retrieves or sets the host name of the SMTP server host. | ||
==Syntax== | ==Syntax== | ||
{{Template:Email:Host syntax}} | {{Template:Email:Host syntax}} | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>%currentString</th> | <tr><th>%currentString</th> | ||
<td>A string or longstring variable to contain the current value of the | <td>A string or longstring variable to contain the current value of the <var>Host</var> property. </td></tr> | ||
Host property. | |||
</td></tr> | |||
<tr><th>email</th> | <tr><th>email</th> | ||
<td> | <td>An <var>Email</var> object. </td></tr> | ||
</td></tr> | |||
<tr><th>newString</th> | <tr><th>newString</th> | ||
<td>The host name or dotted IP address of the SMTP server host. | <td>The host name or dotted IP address of the SMTP server host. </td></tr> | ||
</td></tr> | |||
</table> | </table> | ||
| Line 23: | Line 21: | ||
This means that <var>[[Mail (Email function)|Mail]]</var> method | This means that <var>[[Mail (Email function)|Mail]]</var> method | ||
invocations will try to use the | invocations will try to use the | ||
REMOTE host name (if present) from the Janus client socket port definition. | <var>[[REMOTE]]</var> host name (if present) from the Janus client socket port definition. | ||
If the Janus client port does not have a REMOTE | If the Janus client port does not have a <var>REMOTE</var> | ||
definition that specifies a TCP host name, you ''must'' | definition that specifies a TCP host name, you ''must'' | ||
set this Host property to the correct value for the target SMTP server host. | set this <var>Host</var> property to the correct value for the target SMTP server host. | ||
<li>If you set the Host property value, and the Janus client socket port | |||
you are using has a host value defined, your Host property value must | <li>If you set the <var>Host</var> property value, and the Janus client socket port | ||
you are using has a <var>REMOTE</var> host value defined, your <var>Host</var> property value must | |||
match the host value on the client port. | match the host value on the client port. | ||
</ul> | </ul> | ||
==See also== | ==See also== | ||
{{Template:Email:Host footer}} | {{Template:Email:Host footer}} | ||
Latest revision as of 16:17, 22 June 2012
The host name of the SMTP server (Email class)
This method retrieves or sets the host name of the SMTP server host.
Syntax
%currentString = email:Host email:Host = newString
Syntax terms
| %currentString | A string or longstring variable to contain the current value of the Host property. |
|---|---|
| An Email object. | |
| newString | The host name or dotted IP address of the SMTP server host. |
Usage notes
- The initial value of this property is a null string. This means that Mail method invocations will try to use the REMOTE host name (if present) from the Janus client socket port definition. If the Janus client port does not have a REMOTE definition that specifies a TCP host name, you must set this Host property to the correct value for the target SMTP server host.
- If you set the Host property value, and the Janus client socket port you are using has a REMOTE host value defined, your Host property value must match the host value on the client port.