.NET Components
Chilkat .NET Components for Email, Zip Compression, Encryption, XML, S/MIME, and Character Encoding Conversion

BACK

Chilkat::MailMan Class

The Chilkat MailMan class is reponsible for sending email though SMTP or Outlook, and receiving/managing email on POP3 servers.

Base Classes: Object
  Properties Description  
    AutoAddContacts If True, the MailMan will automatically add contacts to the OutlookContactsFolder for the sender of all received emails. If a contact with the same email address already exists in the folder, a duplicate is not added. The default value of this property is False.

 
    AutoSaveCerts Controls whether certificates found in incoming signed emails are automatically saved to the "Chilkat" certificate store. The default is False. The Chilkat cert store is located in the registry in HKEY_LOCAL_MACHINE/Software/Chilkat/SystemCertificates.

 
    AutoUnwrapSecurity When an email is downloaded from a POP3 server, or when it is loaded from a file, ChilkatMailMan automatically "unwraps" it if the email is signed and/or encrypted. The results of the digital signature verification and decryption can be accessed with the following ChilkatEmail properties and methods: EncryptedBy, SignedBy, ReceivedEncrypted, ReceivedSigned, GetEncryptedByCert, and GetSignedByCert. The AutoUnwrapSecurity property controls whether the automatic unwrap occurs or not. By default, this property is set to 1, which enables the auto-unwrap. Setting the property to 0 disables it, allowing for the S/MIME message parts or envelopes to be saved or accessed.

 
    Filter An expression that is applied to any of the following method calls when present: LoadXmlFile, LoadXmlString, LoadOutlookFolder, LoadMbx, CopyMail, and TransferMail. For these methods, only the emails that match the filter's expression are returned in the email bundle. In the case of TransferMail, only the matching emails are removed from the mail server. The filter allows any header field, or the body, to be checked.

 
    LastError An XML-formatted string containing error information, if any, of the last method call.

 
    LogMailReceivedFilename A log filename where the MailMan will log each message in the exact form it was received from a POP3 server. This property is provided for help in debugging.

 
    LogMailSentFilename A log filename where the MailMan will log the exact message sent to the SMTP server. This property is helpful in debugging.

 
    MailHost The hostname of the POP3 server.

 
    MailPort The port number of the POP3 server. Only needs to be set if the POP3 server is running on a non-standard port.

 
    MaxCount Limits the number of messages the MailMan will try to retrieve from the POP3 server in a single method call.

 
    OutlookContactsFolder If AutoAddContacts is true, this is the Outlook folder path to automatically add contact records for received emails. The default value of this property is "Personal Folders/Contacts". Forward slashes should be used, and leave off the beginning and trailing slashes.

 
    PopPassword The POP3 password.

 
    PopUsername The POP3 login name.

 
    ReadTimeout The maximum number of seconds to wait for new data to arrive from the POP3 server. A value of 0 (the default) sets the timeout to infinity. Setting a reasonable timeout value will prevent your application from hanging if the POP3 server stops responding.

 
    SendIndividual This property determines how emails are sent to distribution lists. If True, emails are sent to each recipient in the list one at a time, with the "To" header field containing the email address of the recipient. If False, emails will contain in the "To" header field, and are sent to 100 BCC recipients at a time. As an example, if your distribution list contained 350 email addresses, 4 emails would be sent, the first 3 having 100 BCC recipients, and the last email with 50 BCC recipients. The default is value of this property is True.

 
    SizeLimit The MailMan will not try to retrieve mail messages from a POP3 server that are greater than this size limit. The default value is 0 indicating no size limit.

 
    SmtpAuthMethod This property should usually be left empty. The MailMan will by default choose the most secure login method available to prevent unencrypted username and passwords from being transmitted if possible. However, some SMTP servers may not advertise the authorization methods it accepts to some or all clients, and therefore Chilkat Email.NET cannot determine which authorization method to use. To force a particular method to be used, or to prevent any authorization from being used, set this property to one of the following values: "NONE", "LOGIN", "PLAIN", "CRAM-MD5", or "NTLM".

 
    SmtpHost The hostname where the SMTP server is located.

 
    SmtpLoginDomain The Windows domain for logging into the SMTP server. Use this only if your SMTP server requires NTLM authentication, which means your SMTP server uses Integrated Windows Authentication. If there is no domain, this can be left empty.

 
    SmtpPassword The password for logging into the SMTP server. Use this only if your SMTP server requires authentication. Chilkat Email.NET supports the LOGIN, PLAIN, CRAM-MD5, and NTLM login methods, and it will automatically choose the most secure method available. Additional login methods will be available in the future.

 
    SmtpPort The port number of the SMTP server used to send email. Only needs to be set if the SMTP server is running on a non-standard port.

 
    SmtpUsername The login for logging into the SMTP server. Use this only if your SMTP server requires authentication.

 
    Version The version of this component, such as "v1.0.0"

 
  Methods Description  
    CheckMail Returns the number of emails available on the POP3 server

 
    ClearBadEmailAddresses Returns the number of emails available on the POP3 server

 
    CopyMail Copy the email from a POP3 server into a EmailBundle. This does not remove the email from the POP3 server.

 
    DeleteBundle Removes all the emails present in the bundle from the POP3 email server.

 
    DeleteByUidl Removes a single email from the server. Returns the a status code having one of the following values: [-2] Failed to connect to the POP3 server. [-1] Connected to the POP3 server, but failed to login or issue delete command [0] The UIDL was not found on the server. [1] The UIDL existed on the server and was deleted.

 
    DeleteEmail Removes an email from the mail server. The email argument is an email that was previously downloaded from the mail server, either in its entirety, or partially (as with GetAllHeaders or GetHeaders).

 
    DeleteMultiple Removes from the POP3 mail server any email that has a UIDL equal to one of the UIDLs in the StringArray.

 
    FetchEmail Fetches an email from the POP3 mail server given its UIDL. The email will remain on the mail server. A typical program might get the email headers from the POP3 server by calling GetAllHeaders or GetHeaders, and then fetch individual emails via their UIDL properties one at a time.

 
    FetchMultiple Given an array of UIDL strings, fetchs all the emails from the POP3 server whose UIDL is present in the array, and returns the emails in a bundle.

 
    FetchMultipleHeaders Given an array of UIDL strings, fetchs all the email headers from the POP3 server whose UIDL is present in the array.

 
    GetAllHeaders Returns all the emails from the POP3 server, but only the first numBodyLines lines of the body. Attachments are not returned. The emails returned in the EmailBundle are valid ChilkatEmail objects, the only difference is that the body is truncated to include only the top numBodyLines lines.

 
    GetBadEmailAddresses Returns a StringArray object containing the list of failed and invalid email addresses that have accumulated during SMTP sends. The list will not contain duplicates. Also, this only works with some SMTP servers -- not all SMTP servers check the validity of each email address.

 
    GetFullEmail If a partial email was obtained using GetHeaders or GetAllHeaders, this function will take the partial email as an argument, and download the full email from the server. A new Email object (separate from the partial email) is returned.

 
    GetHeaders The same as the GetAllHeaders method, except only the emails from fromIndex to toIndex on the POP3 server are returned. The first email on the server is at index 0.

 
    GetUidls Returns the UIDLs of the emails currently stored on the POP3 server.

 
    IsUnlocked Returns True if the email component is already unlocked, otherwise returns False.

 
    LoadEml Loads an Outlook Express EML (.eml) file and converts it to a Chilkat Email object. Returns NULL if it failed.

 
    LoadMime Creates an Email object from MIME text in memory

 
    LoadMbx Loads a .mbx file containing emails and returns an email bundle. If a Filter is present, only emails matching the filter are returned.

 
    LoadOutlookFolder Loads the emails from an Outlook folder and returns an email bundle. If a Filter is present, only emails matching the filter are returned.

 
    LoadXmlEmail Loads an XML file containing a single email and returns an Email object.

 
    LoadXmlEmailString Loads an XML string containing a single email and returns an Email object.

 
    LoadXmlFile Loads an XML file containing emails and returns an email bundle. If a Filter is present, only emails matching the filter are returned.

 
    LoadXmlString Loads from an XML string containing emails and returns an email bundle. If a Filter is present, only emails matching the filter are returned.

 
    QuickSend A quick way to send an email to a single recipient without having to create an Email object explicitly. Returns 1 on successful delivery, and 0 if failed.

 
    RenderToMime When an email is sent by calling SendEmail, it is first "rendered" according to the values of the email properties and contents. It may be digitally signed, encrypted, values substituted for replacement patterns, and header fields "Q" or "B" encoded as needed based on the email. The RenderToMime method performs the rendering, but without the actual sending. The MIME text produced is exactly what would be sent to the SMTP server had SendEmail been called. (The SendEmail method is effectively the same as calling RenderToMime followed by a call to SendRendered.)

 
    SaveLastError Saves the error log to an XML file

 
    SendBundle Send a bundle of emails. Returns True if every email was successfully sent, otherwise returns false and the XML error log should be consulted for details.

 
    SendEmail Sends an email using the MailMan SMTP property settings. Returns True for success and False for failure.

 
    SendQ Queue an email to be sent using the Chilkat SMTP queue service.

 
    SendRendered Connects to the SMTP server and sends an email by transmitting the MIME text exactly as specified in the parameter. The recipients are determined by the "To" and "CC" header fields in the MIME text. Returns true for success and false for failure.

 
    SendViaOutlook Sends an email using Outlook as the SMTP client. When sending in this way, the ChilkatMailMan SMTP server properties are ignored. The Outlook settings control the SMTP server location and login/password.

 
    TransferMail Transfer the emails from the POP3 server into a EmailBundle. The email is removed from the POP3 server.

 
    UnlockComponent Unlocks the component allowing for the full functionality to be used. Returns true if the unlock code is valid.

 
    VerifyPopConnection Return True if a connection can be established with the POP3 server, otherwise return False.

 
    VerifyPopLogin Return True if a connection and login is successful with the POP3 server. Otherwise return False.

 
    VerifySmtpConnection Return True if a connection can be established with the SMTP server, otherwise return False.

 
    VerifySmtpLogin Return True if a connection and login is successful with the SMTP server. Otherwise return False.

 

Copyright 2002, Chilkat Software, Inc. All Rights Reserved.