#include <mw/smtpset.h>
Link against: imcm.lib
class CImSmtpSettings : public CImBaseEmailSettings |
Inherited Attributes | |
---|---|
CImBaseEmailSettings::iFlags | |
CImBaseEmailSettings::iPortNumber |
Inherited Enumerations | |
---|---|
CImBaseEmailSettings:TImBaseEmailSettings |
Run-time configuration settings for an SMTP account.
Messaging clients should use an instance of this class to specify and retrieve configuration settings that are used by the SMTP service when executing email operations.
Service settings such as the email body encoding, reply address, character set, and whether to attach a signature or vCard can be specified using this class. Storing and restoring from the message store is also supported.
To use this class to change a setting:
1) Set the current context to the SMTP service entry using CMsvStore.
2) Create an instance of CImSmtpSettings and put it on the cleanup stack.
3) Retrieve the existing settings by calling CImSmtpSettings::RestoreL().
4) Specify whether to add a vCard to outbound email by calling CImSmtpSettings::SetAddVCardToEmail().
5) Save the new settings by calling CImSmtpSettings::StoreL().
6) Pop and destroy the CImSmtpSettings instance.
See also: CMsvStore
IMPORT_C | CImSmtpSettings | ( | ) |
Allocates and creates a new CImImap4Settings object initialised to default values.
IMPORT_C TBool | AddSignatureToEmail | ( | ) | const |
Retrieves whether email messages will have the user's signature text appended to the text of the messages when they are sent.
The signature is stored in the SMTP service entry as a rich text body stream.
If there is no signature body text stored in the SMTP service entry, then the email is sent with no signature. This method does not check whether the signature body text exists in the SMTP entry or not.
This method is supported as an alternative method for adding contact information into email messages if the user does not wish to send VCards in emails.
IMPORT_C TBool | AddVCardToEmail | ( | ) | const |
Retrieves whether email messages will have a VCard containing the user's details from the Contacts Database when they are sent.
This is supported as an alternative method of adding contact information into email messages if the user does not wish to send signature text in their emails.
IMPORT_C TMsgOutboxBodyEncoding | BodyEncoding | ( | ) | const |
Retrieves the method of encoding email messages if the encoding is not specified when they are sent.
The default value (EMsgOutboxMIME) is set so that text parts of the message are sent as MIME multipart/alternative text/html parts, and are encoded using UTF-8.
See also: TMsgOutboxBodyEncoding
IMPORT_C CImSmtpSettings & | CopyL | ( | const CImSmtpSettings & | aCImSmtpSettings | ) |
Copies the configuration settings from another SMTP settings object into this object.
Parameters | |
---|---|
aCImSmtpSettings | Specifies the object to copy. |
IMPORT_C const TUid | DefaultMsgCharSet | ( | ) | const |
Retrieves which character set is used to send text in MIME email messages.
The default character set is ISO-8859-1 (Latin 1). The UIDs used to identify all character sets are defined in the Character Conversion API.
IMPORT_C const TPtrC | EmailAddress | ( | ) | const |
Retrieves the configured SMTP email address of the user, e.g. "john.smith@work.com".
IMPORT_C const TPtrC | EmailAlias | ( | ) | const |
Retrieves the configured email alias (display name) that will be sent with outbound email.
This is normally set to the real name of the user, e.g. "John Smith". Set this value by calling SetEmailAliasL().
IMPORT_C TBool | InboxLoginDetails | ( | ) | const |
IMPORT_C const TPtrC8 | LoginName | ( | ) | const |
Retrieves the login user name used when SMTP authentication is enabled by calling SetSMTPAuth().
IMPORT_C const TPtrC8 | Password | ( | ) | const |
Retrieves the password used when SMTP authentication is enabled by calling SetSMTPAuth().
IMPORT_C const TPtrC | ReceiptAddress | ( | ) | const |
Gets the internet email address that the user wishes receipts to be returned to.
This would normally be set to be the same as for ReplyToAddress(), e.g. "groupenquiries\@work.com".
IMPORT_C const TPtrC | ReplyToAddress | ( | ) | const |
Gets the internet email address that the user wishes replies to emails to be sent to.
This may be set to be the same as for EmailAddress(), or may be set to be a different email address, e.g. "groupenquiries\@work.com".
IMPORT_C TBool | RequestReceipts | ( | ) | const |
Retrieves whether outbound email messages will contain a header that requests receipts to be returned to the address identified by ReceiptAddress().
If no receipt address has been set,then no receipt is requested. It is entirely up to the receiving mail client whether or not it will comply with this request.
IMPORT_C void | Reset | ( | ) |
Reimplemented from CImBaseEmailSettings::Reset()
Resets the settings to their default values.
IMPORT_C TBool | SMTPAuth | ( | ) | const |
Retrieves whether SMTP authentication will be used when sending emails. Read RFC 2554 "SMTP Service Extension for Authentication" for more details.
IMPORT_C TImSMTPSendCopyToSelf | SendCopyToSelf | ( | ) | const |
Retrieves the setting of the option that allows the user to automatically email themselves a copy of all emails that are sent.
See also: TImSMTPSendCopyToSelf
IMPORT_C TImSMTPSendMessageOption | SendMessageOption | ( | ) | const |
Retrieves the setting of the sending option for new email messages if it is not specified while sending.
This option is intended to be acted on by the message client. The default value is send the message immediately (ESendMessageImmediately).
See also: TImSMTPSendMessageOption
IMPORT_C void | SetAddSignatureToEmail | ( | TBool | aFlag | ) |
Specifies whether email messages will have the user's signature text appended to the text of the messages when they are sent.
The signature is stored in the SMTP service entry as a rich text body stream.
If there is no signature body text stored in the SMTP service entry, then the email is sent with no signature. This method does not check whether the signature body text exists in the SMTP entry or not.
This method is supported as an alternative method for adding contact information into email messages if the user does not wish to send VCards in emails.
Parameters | |
---|---|
aFlag | ETrue if a signature text should be attempted to be appended to outbound email. |
IMPORT_C void | SetAddVCardToEmail | ( | TBool | aFlag | ) |
Specifies whether the email messages will have a VCard containing the user's details from the Contacts Database when they are sent.
Parameters | |
---|---|
aFlag | ETrue if the user's VCards will be added when the email is sent. |
IMPORT_C void | SetBodyEncoding | ( | TMsgOutboxBodyEncoding | aBodyEncoding | ) |
Specifies the default method of encoding email messages if the encoding is not specified when sent.
The default value (EMsgOutboxMIME) is set so that text parts of the message are sent as MIME multipart/alternative text/html parts, and are encoded using UTF-8.
See also: TMsgOutboxBodyEncoding
Parameters | |
---|---|
aBodyEncoding | Default method of encoding |
IMPORT_C void | SetDefaultMsgCharSet | ( | TUid | aDefaultMsgCharSet | ) |
Specifies which character set is used to send text in MIME email messages.
The default character set is ISO-8859-1 (Latin 1). The UIDs used to identify all character sets are defined in the Character Conversion API.
Parameters | |
---|---|
aDefaultMsgCharSet | Character set identifier. |
IMPORT_C void | SetEmailAddressL | ( | const TDesC & | aEmailAddress | ) |
Specifies the SMTP email address of the user.
Parameters | |
---|---|
aEmailAddress | SMTP email address of the user. |
IMPORT_C void | SetEmailAliasL | ( | const TDesC & | aEmailAlias | ) |
Specifies the configured email alias (display name) that will be sent with outbound email.
This is normally set to the real name of the user. For example, "John Smith".
Parameters | |
---|---|
aEmailAlias | The email alias (display name). |
IMPORT_C void | SetInboxLoginDetails | ( | TBool | aFlag | ) |
IMPORT_C void | SetLoginNameL | ( | const TDesC8 & | ) |
Specifies the login user name used when SMTP authentication is enabled by calling SetSMTPAuth().
Parameters | |
---|---|
The login user name. |
IMPORT_C void | SetPasswordL | ( | const TDesC8 & | ) |
Specifies the password used when SMTP authentication is enabled by calling SetSMTPAuth().
Parameters | |
---|---|
The password. |
IMPORT_C void | SetReceiptAddressL | ( | const TDesC & | aReceiptAddress | ) |
Specifies the SMTP email address that the user wishes email receipts to be returned to.
Parameters | |
---|---|
aReceiptAddress | SMTP email address that the user wishes receipts to be returned to. |
IMPORT_C void | SetReplyToAddressL | ( | const TDesC & | aReplyToAddress | ) |
Specifies the email address that the user wishes replies to emails to be sent to. If this is not specified, replies will be sent to the address set by calling SetEmailAddressL().
Parameters | |
---|---|
aReplyToAddress | SMTP email address that the user wishes replies to emails to be sent to. |
IMPORT_C void | SetRequestReceipts | ( | TBool | aFlag | ) |
Specifies whether outbound email messages will have a header added that requests a receipt from the recipient.
If no receipt address has been set,then no receipt is requested. It is entirely up to the receiving mail client whether or not it will comply with this request.
Parameters | |
---|---|
aFlag | ETrue if receipts will be requested. |
IMPORT_C void | SetSMTPAuth | ( | TBool | aFlag | ) |
Enables or disables SMTP authentication when sending emails. Read RFC 2554 "SMTP Service Extension for Authentication" for more details.
Parameters | |
---|---|
aFlag | ETrue to enable SMTP authentication. |
IMPORT_C void | SetSendCopyToSelf | ( | TImSMTPSendCopyToSelf | aSendCopyToSelf | ) |
Specifies the option that allows the user to automatically email themselves a copy of all emails that are sent.
See also: TImSMTPSendCopyToSelf
Parameters | |
---|---|
aSendCopyToSelf | Option setting. |
IMPORT_C void | SetSendMessageOption | ( | TImSMTPSendMessageOption | aSendMessageOption | ) |
Specifies the sending option for outbound email messages if it is not specified while sending.
The default value is to send the message immediately (ESendMessageImmediately).
See also: TImSMTPSendMessageOption
Parameters | |
---|---|
aSendMessageOption | Default sending option. |
IMPORT_C void | SetTlsSslDomainL | ( | const TDesC8 & | aDomainName | ) |
Sets the domain name to use during TLS/SSL certificate validation.
Parameters | |
---|---|
aDomainName | Domain name |
IMPORT_C void | SetToCcIncludeLimitL | ( | TInt | aLimit | ) |
Specifies maximum number of original To and CC addresses to include in the body header when replying-to and forwarding emails. The default (0) indicates that no addresses should be included.
Parameters | |
---|---|
aLimit | The maximum number of addresses to include in each field. |
IMPORT_C TPtrC8 | TlsSslDomain | ( | ) | const |
Gets the domain name used during TLS/SSL certificate validation.
IMPORT_C TInt | ToCcIncludeLimit | ( | ) | const |
Retrieves the setting for inclusion of original To and CC email addresses in the body text of reply and forwarded emails.
IMPORT_C TBool | operator== | ( | const CImSmtpSettings & | aCImSmtpSettings | ) | const |
Equality operator.
Parameters | |
---|---|
aCImSmtpSettings | Specifies the SMTP settings object to compare with. |