Top |
Properties
EmailAddress readable s Name readable s ImapSupported readable b ImapAcceptSslErrors readable b ImapHost readable s ImapUseSsl readable b ImapUseTls readable b ImapUserName readable s SmtpSupported readable b SmtpAcceptSslErrors readable b SmtpHost readable s SmtpUseAuth readable b SmtpAuthLogin readable b SmtpAuthPlain readable b SmtpAuthXoauth2 readable b SmtpUseSsl readable b SmtpUseTls readable b SmtpUserName readable s
Description
An account object implements this interface if it provides email-like messaging capabilities.
Property Details
The "EmailAddress" property
EmailAddress readable s
The email address for the account or blank if there is no such address or if it isnt' known or isn't in a standard format.
The "Name" property
Name readable s
The full name of the user associated with "EmailAddress".
Since 3.8.0
The "ImapSupported" property
ImapSupported readable b
Set to TRUE
if the messages for the account can be accessed
and manipulated using the
IMAP
protocol.
The "ImapAcceptSslErrors" property
ImapAcceptSslErrors readable b
Accept SSL/TLS errors caused by invalid certificates.
Since 3.8.0
The "ImapHost" property
ImapHost readable s
The IMAP server to use.
This may be in any of a number of recognized formats; an IPv6
address, an IPv4 address, or a domain name. A port override
may be specified in the usual way with a colon. Ports may be
given as decimal numbers or symbolic names
(cf. the /etc/services
file).
If a port override is not given, then applications should try
to connect to port 993 if
"ImapUseSsl" is TRUE
and port
143 if not.
The "ImapUseSsl" property
ImapUseSsl readable b
Whether SSL should be used.
This indicates that SSL should be used on a dedicated port.
Since 3.8.0
The "ImapUseTls" property
ImapUseTls readable b
Whether TLS should be used.
This indicates that STARTTLS should be used on a standard port after the connection has been established to obtain a secure channel.
The "ImapUserName" property
ImapUserName readable s
The user name to use for logging in.
This may be blank if username/password authentication isn't used or if the user name of the current user should be used.
The "SmtpSupported" property
SmtpSupported readable b
Set to TRUE
if the
SMTP
protocol can be used to send messages for the account.
The "SmtpAcceptSslErrors" property
SmtpAcceptSslErrors readable b
Accept SSL/TLS errors caused by invalid certificates.
Since 3.8.0
The "SmtpHost" property
SmtpHost readable s
The SMTP server to use.
This may be in any of a number of recognized formats; an IPv6
address, an IPv4 address, or a domain name. A port override
may be specified in the usual way with a colon. Ports may be
given as decimal numbers or symbolic names
(cf. the /etc/services
file).
If a port override is not given, then applications should try
to connect to port 465 if
"SmtpUseSsl" is TRUE
and port
587 (or 25) if not.
The "SmtpUseAuth" property
SmtpUseAuth readable b
Whether authentication is needed
This indicates whether the server uses authentication.
Since 3.8.0
The "SmtpAuthLogin" property
SmtpAuthLogin readable b
Whether LOGIN authentication should be used.
This indicates whether the server uses the LOGIN SASL mechanism for SMTP.
Since 3.12.0
The "SmtpAuthPlain" property
SmtpAuthPlain readable b
Whether PLAIN authentication should be used.
This indicates whether the server uses the PLAIN SASL mechanism for SMTP.
Since 3.12.0
The "SmtpAuthXoauth2" property
SmtpAuthXoauth2 readable b
Whether XOAUTH2 authentication should be used.
This indicates whether the server uses the non-standard XOAUTH2 SASL mechanism for SMTP. This is implemented by GMail and Outlook.com.
Since 3.12.0
The "SmtpUseSsl" property
SmtpUseSsl readable b
Whether SSL should be used.
This indicates that SSL should be used on a dedicated port.
Since 3.8.0
The "SmtpUseTls" property
SmtpUseTls readable b
Whether TLS should be used.
This indicates that STARTTLS should be used on a standard port after the connection has been established to obtain a secure channel.