Host (Email property) - Revision history

JAL2 at 16:17, 22 June 2012

2012-06-22T16:17:27Z

← Older revision		Revision as of 16:17, 22 June 2012
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>~~A previously declared~~ Email object.		<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}}

JAL2: /* Syntax terms */

2012-03-05T21:47:53Z

Syntax terms

← Older revision		Revision as of 21:47, 5 March 2012
Line 13:		Line 13:
	<td>A previously declared Email object.		<td>A previously declared Email object.
	</td></tr>		</td></tr>
	<tr><th>~~hostname~~</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>

JAL2: /* Syntax terms */

2012-03-05T21:47:20Z

Syntax terms

← Older revision		Revision as of 21:47, 5 March 2012
Line 6:		Line 6:
	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%email</th>		<tr><th>%currentString</th>
			<td>A string or longstring variable to contain the current value of the
			Host property.
			</td></tr>
			<tr><th>email</th>
	<td>A previously declared Email object.		<td>A previously declared Email object.
	</td></tr>		</td></tr>
Line 12:		Line 16:
	<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>
	~~<tr><th>%curr~~</th>		</table>
	~~<td>A string or longstring variable to contain the current value of the~~
	~~Host property.~~

	~~</td></tr></table>~~
	==Usage notes==		==Usage notes==
	<ul>		<ul>

JALWiccan: 1 revision

2011-07-05T21:41:04Z

1 revision

← Older revision	Revision as of 21:41, 5 July 2011
(No difference)

JAL2 at 21:41, 5 July 2011

2011-07-05T21:41:03Z

← Older revision		Revision as of 21:41, 5 July 2011
Line 1:		Line 1:
			{{Template:Email:Host subtitle}}

	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.
	==~~Host syntax~~==		==Syntax==
	~~<p class="pre"> %email~~:~~Host = hostname~~		{{Template:Email:Host syntax}}

	~~%curr = %email~~:Host
	~~</p>~~

	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
Line 19:		Line 17:

	</td></tr></table>		</td></tr></table>
	==Usage ~~Notes~~==		==Usage notes==
	<ul>		<ul>
	<li>The initial value of this property is a null string.		<li>The initial value of this property is a null string.
Line 32:		Line 30:
	match the host value on the client port.		match the host value on the client port.
	</ul>		</ul>
			==See also==
			{{Template:Email:Host footer}}

JAL2 at 21:37, 5 July 2011

2011-07-05T21:37:03Z

@@ Line 31: / Line 31: @@
 you are using has a host value defined, your Host property value must
 match the host value on the client port.
 </ul>

JAL2: Created page with "This method retrieves or sets the host name of the SMTP server host. ==Host syntax==
%email:Host = hostname %curr = %email:Host
===Syntax terms===
2011-07-05T21:35:33Z

Created page with "This method retrieves or sets the host name of the SMTP server host. ==Host syntax== <p class="pre"> %email:Host = hostname %curr = %email:Host </p> ===Syntax terms=== <tabl..."

New page
This method retrieves or sets the host name of the SMTP server host.
==Host syntax==
<p class="pre"> %email:Host = hostname

%curr = %email:Host
</p>

===Syntax terms===
<table class="syntaxTable">
<tr><th>%email</th>
<td>A previously declared Email object.
</td></tr>
<tr><th>hostname</th>
<td>The host name or dotted IP address of the SMTP server host.
</td></tr>
<tr><th>%curr</th>
<td>A string or longstring variable to contain the current value of the
Host property.

</td></tr></table>
==Usage Notes==
<ul>
<li>The initial value of this property is a null string.
This means that <var>[[Mail (Email function)|Mail]]</var> 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.
<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
match the host value on the client port.
</ul>
==Mail (Email function)==
This callable method sends the mail message to an SMTP server.
==Mail syntax==
<p class="pre"> [%rc =] %email:Mail([clientport], [cancel])
</p>

===Syntax terms===
<table class="syntaxTable">
<tr><th>%rc</th>
<td>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|"SMTP server codes"]].
</td></tr>
<tr><th>%email</th>
<td>A previously declared Email object.
</td></tr>
<tr><th>clientport</th>
<td>An optional string expression that identifies a previously
defined Janus CLSOCK port.
The ''clientport'' default is the
[[MASTER]] port, if any is defined.
However, if you omit ''clientport'' and no MASTER port is defined,
the request is cancelled (subject to the ''cancel'' setting).
</td></tr>
<tr><th>cancel</th>
<td>An optional numeric expression that controls whether the request is
cancelled if a communication/socket error occurs:
<ul>
<li>If zero, the request is ''not'' cancelled on these errors.
<li>If non-zero, the request is cancelled (though a message is
still issued).
<li>If not specified, the default is to cancel the request.
</ul>
</td></tr></table>

==Usage Notes==
<ul>
<li>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.
<li>For <var>Mail</var> method examples, see [[SMTP Helper#Basic e-mail|"Basic e-mail"]] and
[[SMTP Helper#E-mail with attachment|"E-mail with attachment"]].
</ul>