Chilkat.Email PHP Reference
Chilkat.Email
Represents a complete Email object.
Object Creation
$obj = new COM("Chilkat.Email");
Properties
string Body
The body of the email. If the email has both HTML and plain-text bodies, this property returns the HTML body. The GetHtmlBody and GetPlainTextBody methods can be used to access a specific body. The HasHtmlBody and HasPlainTextBody methods can be used to determine the presence of a body.
string BounceAddress
The "return-path" address of the email. Bounces will go to this address.
string Charset
Sets the charset for the entire email. The header fields and plain-text/HTML bodies will be converted and sent in this charset. (This includes parsing and updating the HTML with the appropriate META tag specifying the charset.) All formatting and encoding of the email MIME is handled automatically by the Chilkat Mail component. If your application wants to send a Shift_JIS email, you simply set the Charset property to "Shift_JIS". Note: If a charset property is not explicitly set, the Chilkat component automatically detects the charset and chooses the appropriate charset. If all characters are 7bit (i.e. us-ascii) the charset is left blank. If the email contain a mix of languages such that no one charset can be chosen, or if the language cannot be determined without ambiguity, then the "utf-8" charset will be chosen.
bool Decrypted (read-only)
true if the email arrived encrypted and was successfully decrypted, otherwise false.
Date EmailDate
The date and time in UTC/GMT standard. Use the LocalDate property to get the local date and time.
string EncryptedBy (read-only)
If the email was received encrypted, this contains the details of the certificate used for encryption.
string FileDistList
Set this property to send an email to a list of recipients stored in a plain text file. The file format is simple: one recipient per line, no comments allowed, blank lines are ignored.Setting this property is equivalent to adding a "CKX-FileDistList"header field to the email. Chilkat Mail treats header fields beginning with "CKX-"specially in that these fields are never transmitted with the email when sent. However, CKX fields are saved and restored when saving to XML or loading from XML (or MIME). When sending an email containing a "CKX-FileDistList"header field, Chilkat Mail will read the distribution list file and send the email to each recipient. Emails can be sent individually, or with BCC, 100 recipients at a time. (see the MailMan.SendIndividual property).
string From
The combined name and email address of the sender, such as "John Smith"
string FromAddress
The email address of the sender.
string FromName
The name of the sender.
string Header (read-only)
The complete MIME header of the email.
string Language (read-only)
(PreRelease) A read-only property that identifies the primary language group for the email. Possible values are:
- "latin1" (for English and all Western European languages)
- "central" (for Central European languages such as Polish, Czech, Hungarian, etc.)
- "russian" (for Cyrillic languages)
- "greek"
- "turkish"
- "hebrew"
- "arabic"
- "baltic"
- "thai"
- "vietnamese"
- "chinese"
- "japanese"
- "korean"
- "unknown"
The language group determination is made soley on the subject and plain-text/HTML email bodies. Characters in the FROM, TO, CC, and other header fields are not considered.
The primary determining factor is the characters found in the Subject header field. For example, if an email contains Japanese in the Subject, but the body contains Russian characters, it will be considered "japanese".
string LastErrorHtml (read-only)
Error information in HTML format for the last method called.
string LastErrorText (read-only)
Error information in plain-text format for the last method called.
string LastErrorXml (read-only)
Error information in XML format for the last method called.
Date LocalDate
The local date and time of when the email was sent or created.
string Mailer
Identifies the email software that sent the email.
int NumAlternatives (read-only)
The number of alternative bodies present in the email. An email that is not "multipart/alternative"will return 0 alternatives. An email that is "multipart/alternative" will return a number greater than or equal to 1.
int NumAttachedMessages (read-only)
Returns the number of embedded emails. Some mail clients will embed an email that is to be forwarded into a new email as a "message/rfc822" subpart of the MIME message structure. This property tells how many emails have been embedded. The original email can be retrieved by calling GetAttachedMessage. More about Attached Email Messages
int NumAttachments (read-only)
The number of attachments contained in the email.
int NumBcc (read-only)
The number of blind carbon-copy email recipients.
int NumCC (read-only)
The number of carbon-copy email recipients.
int NumHeaderFields (read-only)
The number of header fields.
int NumRelatedItems (read-only)
The number of related items present in this email. Related items are typically image files (JPEGs or GIFs) or style sheets (CSS files) that are included with HTML formatted messages with internal "CID"hyperlinks.
int NumReplacePatterns (read-only)
Returns the number of replacement patterns previously set by calling the SetReplacePattern method 1 or more times. If replacement patterns are set, the email bodies and header fields are modified by applying the search/replacement strings during the message sending process.
int NumTo (read-only)
The number of direct email recipients.
bool OverwriteExisting
When true (the default) the methods to save email attachments will overwrite files if they already exist. If false, then the methods that save email attachments will append a string of 4 characters to create a unique filename if a file already exists. The filename of the attachment within the email object is updated and can be retrieved by the program to determine the actual file(s) created.
bool ReceivedEncrypted (read-only)
true if this email was originally received with encryption, otherwise false.
bool ReceivedSigned (read-only)
true if this email was originally received with a digital signature, otherwise false.
string ReplyTo
The email address to be used when a recipient replies.
bool ReturnReceipt
Set to true if you want the email to request a return-receipt when received by the recipient. The default value is false.
bool SendEncrypted
Set to true if this email should be sent encrypted.
bool SendSigned
Set to true if this email should be sent with a digital signature.
bool SignaturesValid (read-only)
true if the email was received with one or more digital signatures, and if all the signatures were validated indicating that the email was not altered. Otherwise this property is set to false.
string SignedBy (read-only)
If the email was received digitally signed, this property contains the details of the signer.
int Size (read-only)
The size in bytes of the email, including all parts and attachments.
string Subject
The email subject.
string Uidl (read-only)
This is the unique ID assigned by the POP3 server. Emails can be retrieved or deleted from the POP3 server via the UIDL. The header field for this property is "X-UIDL".
Methods
void AddAttachmentHeader(int idx, string fieldName, string fieldValue)
Adds a MIME header field to one of the attachments.
bool AddBcc(string friendlyName, string emailAddress)
Adds a recipient to the blind carbon-copy list. address is required, but name may be empty. Returns True if successful. Why BCC email addresses do not appear in the email header.
bool AddCC(string friendlyName, string emailAddress)
Adds a recipient to the carbon-copy list. address is required, but name may be empty. Returns True if successful.
string AddDataAttachment(VARIANT data, string filename)
Adds an attachment directly from data in memory to the email. Returns a null on failure
bool AddDataAttachment2(string fileName, VARIANT content, string contentType)
Adds an attachment to an email from in-memory data. Same as AddDataAttachment but allows the content-type to be specified.
string AddFileAttachment(string fileName)
Adds a file as an attachment to the email. Returns the MIME content-type of the attachment, which is inferred based on the filename extension. Returns a null on failure
bool AddFileAttachment2(string fileName, string contentType)
Same as AddFileAttachment, but the content type can be explicitly specified.
void AddHeaderField(string fieldName, string fieldValue)
Any standard or non-standard (custom) header field can be added to the email with this method. One interesting feature is that all header fields whose name begins with "CKX-" will not be included in the header when an email is sent. These fields will be included when saved to or loaded from XML. This makes it easy to include persistent meta-data with an email which your programs can use in any way it chooses.
void AddHtmlAlternativeBody(string body)
Sets the HTML body of the email. Use this method if there will be multiple versions of the body, but in different formats, such as HTML and plain text. Otherwise, set the body by calling the SetHtmlBody method.
bool AddMultipleBcc(string commaSeparatedAddresses)
Adds multiple recipients to the blind carbon-copy list. The parameter is a string containing a comma separated list of full email addresses. Returns True if successful. Why BCC email addresses do not appear in the email header.
bool AddMultipleCC(string commaSeparatedAddresses)
Adds multiple recipients to the carbon-copy list. The parameter is a string containing a comma separated list of full email addresses. Returns True if successful.
bool AddMultipleTo(string commaSeparatedAddresses)
Adds multiple recipients to the "to" list. The parameter is a string containing a comma separated list of full email addresses. Returns True if successful.
void AddPlainTextAlternativeBody(string body)
Sets the plain-text body of the email. Use this method if there will be multiple versions of the body, but in different formats, such as HTML and plain text. Otherwise, simply set the Body property.
string AddRelatedData(VARIANT data, string fileName)
Adds the memory data as a related item to the email and returns the Content-ID. Emails formatted in HTML can include images with this call and internally reference the image through a "cid"hyperlink. (Chilkat Email.NET fully supports the MHTML standard.) Returns a null on failure
void AddRelatedData2(VARIANT data, string fileNameInHtml)
Adds a related item to the email from in-memory byte data. Related items are things such as images and style sheets that are embedded within an HTML email. They are not considered attachments because their sole purpose is to participate in the display of the HTML. This method differs from AddRelatedData in that it does not use or return a Content-ID. The filename argument should be set to the filename used in the HTML img tag's src attribute (if it's an image), or the URL referenced in an HTML link tag for a stylesheet.
string AddRelatedFile(string fileName)
Adds the contents of a file to the email and returns the Content-ID. Emails formatted in HTML can include images with this call and internally reference the image through a "cid" hyperlink. (Chilkat Email.NET fully supports the MHTML standard.) Returns a null on failure
bool AddRelatedFile2(string fileName, string fileNameInHtml)
Adds a related item to the email from a file. Related items are things such as images and style sheets that are embedded within an HTML email. They are not considered attachments because their sole purpose is to participate in the display of the HTML. This method differs from AddRelatedFile in that it does not use or return a Content-ID. The filenameInHtml argument should be set to the filename used in the HTML img tag's src attribute (if it's an image), or the URL referenced in an HTML link tag for a stylesheet.
string AddRelatedString(string nameInHtml, string str, string charset)
Adds a related item to the email. A related item is typically an image or style sheet referenced by an HTML tag within the HTML email body. The contents of the related item are passed str. nameInHtml specifies the filename that should be used within the HTML, and not an actual filename on the local filesystem. charset specifies the charset that should be used for the text content of the related item. Returns the content-ID generated for the added item. Returns a null on failure
void AddRelatedString2(string strData, string charset, string filenameInHtml)
Adds a related item to the email from an in-memory string. Related items are things such as images and style sheets that are embedded within an HTML email. They are not considered attachments because their sole purpose is to participate in the display of the HTML. The filenameInHtml argument should be set to the filename used in the HTML img tag's src attribute (if it's an image), or the URL referenced in an HTML link tag for a stylesheet. The charset argument indicates that the content should first be converted to the specified charset prior to adding to the email. It should hava a value such as "iso-8859-1", "utf-8", "Shift_JIS", etc.
void AddStringAttachment(string filename, string strData)
Adds an attachment directly from a string in memory to the email.
void AddStringAttachment2(string filename, string strData, string charset)
Adds an attachment to an email. The filename argument specifies the filename to be used for the attachment and is not an actual filename existing on the local filesystem. The "str" argument contains the text data for the attachment. The string will be converted to the charset specified in the last argument before being added to the email.
bool AddTo(string friendlyName, string emailAddress)
Adds a recipient to the "to" list. address is required, but name may be empty. Returns True if successful. Emails that have no "To" recipients will be sent to .
void AesDecrypt(string password)
Decrypts and restores an email message that was previously encrypted using AesEncrypt. The password must match the password used for encryption.
void AesEncrypt(string password)
Encrypts the email body, all alternative bodies, all message sub-parts and attachments using 128-bit AES (Rijndael, CBC mode) encryption. To decrypt, you must use the AesDecrypt method with the same password. The AesEncrypt/Decrypt methods use symmetric password-based greatly simplify sending and receiving encrypted emails because certificates and public/private key issues do not have to be dealt with. However, the sending and receiving applications must both be using Chilkat Email .NET or ActiveX components.
void AppendToBody(string str)
Appends a string to the plain-text body.
bool AspUnpack(string prefix, string saveDir, string urlPath, int cleanFiles)
(PreRelease) To be documented soon. Returns 1 for success, 0 for failure.
VARIANT AspUnpack2(string prefix, string saveDir, string urlPath, int cleanFiles)
(PreRelease) To be documented soon. Returns 1 for success, 0 for failure.
string BEncodeBytes(VARIANT mbBytes, string charset)
Takes a byte array of multibyte (non-Unicode) data and returns a Unicode B-Encoded string. Returns a null on failure
string BEncodeString(string str, string charset)
Takes a Unicode string, converts it to the charset specified in the 2nd parameter, B-Encodes the converted multibyte data, and returns the encoded Unicode string. Returns a null on failure
void ClearBcc()
Clears the list of blind carbon-copy recipients.
void ClearCC()
Clears the list of carbon-copy recipients.
void ClearTo()
Clears the list of "to" recipients.
Chilkat.Email Clone()
Creates and returns an identical copy of the Email object. Returns a null reference on failure
Chilkat.Email CreateForward()
Returns a copy of the Email object with the body and header fields changed so that the newly created email can be forwarded. After calling CreateForward, simply add new recipients to the created email, and call MailMan.SendEmail. Returns a null reference on failure
Chilkat.Email CreateReply()
Returns a copy of the Email object with the body and header fields changed so that the newly created email can be sent as a reply. After calling CreateReply, simply prepend additional information to the body, and call MailMan.SendEmail. Returns a null reference on failure
string CreateTempMht(string inFilename)
Saves the email to a temporary MHT file so that a WebBrowser control can navigate to it and display it. If fileName is empty, a temporary filename is generated and returned. If fileName is non-empty, then it will be created or overwritten, and the input filename is simply returned.The MHT file that is created will not contain any of the email's attachments, if any existed. Also, if the email was plain-text, the MHT file will be saved such that the plain-text is converted to HTML using pre-formatted text ("pre" HTML tags) allowing it to be displayed correctly in a WebBrowser. Returns a null on failure
void DropAttachments()
Removes all attachments from the email.
void DropRelatedItem(int idx)
A related item is typically an embedded image referenced from the HTML in the email via a "CID" hyperlink. This method removes the Nth embedded image from the email. Note: If the HTML tries to reference the removed image, it will be displayed as a broken image link.
void DropRelatedItems()
A related item is typically an embedded image referenced from the HTML in the email via a "CID" hyperlink. This method removes all the embedded images from the email.
bool DropSingleAttachment(int index)
Drops a single attachment from the email. Returns True if successful.
string GenerateFilename()
Generates a unique filename for this email. The filename will be different each time the method is called. Returns a null on failure
string GetAltHeaderField(int index, string fieldName)
Returns the value of a header field within the Nth alternative body's MIME sub-part. Returns a null on failure
string GetAlternativeBody(int index)
Returns the Nth alternative body. The NumAlternatives property tells the number of alternative bodies present. Use the GetHtmlBody and GetPlainTextBody methods to easily get the HTML or plain text alternative bodies. Returns a null on failure
string GetAlternativeContentType(int index)
Returns the content type of the Nth alternative body. The NumAlternatives property tells the number of alternative bodies present. Returns a null on failure
Chilkat.Email GetAttachedMessage(int index)
Returns an embedded "message/rfc822" subpart as an email object. (Emails are embedded as "message/rfc822" subparts by some mail clients when forwarding an email.) This method allows the original email to be accessed. Returns a null reference on failure
string GetAttachedMessageFilename(int index)
Returns the filename of the Nth attached (embedded) email. The filename is the "filename" attribute of the content-disposition header field found within the Nth message/rfc822 sub-part of the calling email object. Returns a null on failure
string GetAttachmentContentID(int index)
Returns the ContentID header field for the Nth attachment. The first attachment is at index 0. Returns a null on failure
string GetAttachmentContentType(int index)
Returns the Content-Type header field for the Nth attachment. Indexing of attachments begins at 0. Returns a null on failure
VARIANT GetAttachmentData(int index)
Retrieves an attachment's binary data for in-memory access. Returns 1 for success, 0 for failure.
string GetAttachmentFilename(int index)
Retrieves an attachment's filename. Returns a null on failure
string GetAttachmentHeader(int index, string fieldName)
Returns the value of a header field (by name) of an attachment. Returns a null on failure
int GetAttachmentSize(int index)
Returns the size (in bytes) of the Nth attachment.
string GetAttachmentString(int index, string charset)
Retrieves an attachment's data as a String. All CRLF sequences will be translated to single newline characters. Returns a null on failure
string GetAttachmentStringCrLf(int index, string srcCharset)
Retrieves an attachment's data as a String. All end-of-lines will be translated to CRLF sequences. Returns a null on failure
string GetBcc(int index)
Returns a blind carbon-copy recipient's full email address. Returns a null on failure
string GetBccAddr(int index)
Returns the Nth BCC address (only the address part, not the friendly-name part). Returns a null on failure
string GetBccName(int index)
Returns the Nth BCC name (only the friendly-name part, not the address part). Returns a null on failure
string GetCC(int index)
Returns a carbon-copy recipient's full email address. Returns a null on failure
string GetCcAddr(int index)
Returns the Nth CC address (only the address part, not the friendly-name part). Returns a null on failure
string GetCcName(int index)
Returns the Nth CC name (only the friendly-name part, not the address part). Returns a null on failure
string GetDeliveryStatusInfo(string fieldName)
If the email is a multipart/report, then it is a delivery status notification. This method can be used to get individual pieces of information from the message/delivery-status part of the email. This method should only be called if the IsMultipartReport method returns true.
The fieldName should be set a string such as "Final-Recipient", "Status", "Action", "Reporting-MTA", etc.
Reporting-MTA: dns; XYZ.abc.nl
Final-recipient: RFC822; someEmailAddr@doesnotexist123.nl
Action: failed
Status: 5.4.4
X-Supplementary-Info: < #5.4.4 smtp;554 5.4.4
SMTPSEND.DNS.NonExistentDomain; nonexistent domain>
Returns a null on failure
Chilkat.Cert GetEncryptCert()
Returns the certificate that was previously set by SetEncryptCert.
Chilkat.Cert GetEncryptedByCert()
Returns the certificate associated with a received encrypted email.
VARIANT GetFileContent(string filename)
Reads a file and returns the contents as a String. This is here purely for convenience. Returns 1 for success, 0 for failure.
string GetHeaderField(string fieldName)
Returns the value of a header field. Returns a null on failure
string GetHeaderFieldName(int index)
Return the name of the Nth header field. The NumHeaderFields() method can be used to get the number of header fields. The GetHeaderField() method can be used to get the value of the field given the field name. Returns a null on failure
string GetHeaderFieldValue(int index)
Returns the value of the Nth header field. (Indexing begins at 0) The number of header fields can be obtained from the NumHeaderFields property. Returns a null on failure
string GetHtmlBody()
Returns the body having the "text/html" content type. Returns a null on failure
int GetImapUid()
(Unreleased) When email headers are downloaded from an IMAP server (using Chilkat IMAP), a "ckx-imap-uid" header field is added. The content of this header is the UID of the email on the IMAP server. This method returns the UID if the header field exists, otherwise it returns -1.
An application that wishes to download the full email would use this UID and then call the Chilkat IMAP object's FetchSingle or FetchSingleAsMime methods.
If this method is not yet available in your version of the Chilkat Email object, you may also call GetHeaderField("ckx-imap-uid") to fetch the UID as a string, and then convert it to an integer.
Chilkat.StringArray GetLinkedDomains()
Parses an HTML email and returns the set of domain names that occur in hyperlinks within the HTML body. Returns a null reference on failure
VARIANT GetMbHeaderField(string fieldName, string charset)
Returns a header field's data in a byte array. If the field was Q or B encoded, this is automatically decoded, and the raw bytes of the field are returned. Call GetHeaderField to retrieve the header field as a Unicode string. Returns 1 for success, 0 for failure.
VARIANT GetMbHtmlBody(string convertToCharset)
Returns the HTML body converted to a specified charset. If no HTML body exists, the returned byte array is empty. The returned data will be such that not only is the character data converted (if necessary) to the convertToCharset, but the HTML is edited to add or modify the META tag that specifies the charset within the HTML. Returns 1 for success, 0 for failure.
VARIANT GetMbPlainTextBody(string convertToCharset)
Returns the plain-text body converted to a specified charset. The return value is a byte array containing multibyte character data. Returns 1 for success, 0 for failure.
string GetMime()
Return the email as MIME text containing the email header, body (or bodies), related items (if any), and all attachments Returns a null on failure
Chilkat.Mime GetMimeObject()
Creates and returns a Mime object containing the contents of the email. This method is provided for those users that need full access to every aspect of the MIME message, such as manipulation of the message headers of attachments and related items contained within message subparts.(The returned Mime object returned is locked, and needs to be unlocked with a Chilkat S/MIME .NET unlock code, which can be obtained by purchasing a Chilkat S/MIME .NET license.)
string GetPlainTextBody()
Returns the email body having the "text/plain" content type. Returns a null on failure
string GetRelatedContentID(int index)
Returns the content ID of a related item contained with the email. Related items are typically images and style-sheets embedded within HTML emails. Returns a null on failure
string GetRelatedContentType(int index)
Returns the content-type of the Nth related content item in an email message. Returns a null on failure
VARIANT GetRelatedData(int index)
Returns the content ID of a related item contained with the email. Related items are typically images and style-sheets embedded within HTML emails. Returns 1 for success, 0 for failure.
string GetRelatedFilename(int index)
Returns the filename of a related item contained with the email. Related items are typically images and style-sheets embedded within HTML emails. Returns a null on failure
string GetRelatedString(int index, string srcCharset)
Returns the text with CR line-endings of a related item contained with the email. Related items are typically images and style-sheets embedded within HTML emails. Returns a null on failure
string GetRelatedStringCrLf(int index, string srcCharset)
Returns the text with CRLF line-endings of a related item contained with the email. Related items are typically images and style-sheets embedded within HTML emails. Returns a null on failure
string GetReplacePattern(int index)
Returns a replacement pattern previously defined for mail-merge operations. Returns a null on failure
string GetReplaceString(int index)
Returns a replacement string for a previously defined pattern/replacement string pair. (This is a mail-merge feature.) Returns a null on failure
string GetReplaceString2(string pattern)
Returns a replacement string for a previously defined pattern/replacement string pair. (This is a mail-merge feature.) Returns a null on failure
Chilkat.Cert GetSignedByCert()
Return the certificate used to digitally sign this email.
Chilkat.Cert GetSigningCert()
Return the certificate that will be used to digitally sign this email. This is the cerficate that was previously set by calling the SetSigningCert method.
string GetTo(int index)
Returns a "to" recipient's full email address. Returns a null on failure
string GetToAddr(int index)
Returns the Nth To address (only the address part, not the friendly-name part). Returns a null on failure
string GetToName(int index)
Returns the Nth To name (only the friendly-name part, not the address part). Returns a null on failure
string GetXml()
Convert the email object to an XML document in memory Returns a null on failure
bool HasHeaderMatching(string fieldName, string valuePattern, int caseInsensitive)
To be documented soon...
bool HasHtmlBody()
Returns true if the email has an HTML body.
bool HasPlainTextBody()
Returns true if the email has a plain-text body.
bool IsMultipartReport()
Returns true if the email is a multipart/report email.
bool LoadBodyFromFile(string textFilename, int bIsHtml, string charset)
To be documented soon...
bool LoadEml(string emlFilename)
Loads a complete email from a .EML file. (EML files are simply RFC822 MIME text files.)
string LoadTextFileToUnicode(string filename, string srcCharset)
Loads a text file encoded in any charset and returns a Unicode string (Visual Basic strings are Unicode). The charset argument can be any of the following charsets:
us-ascii
unicode
unicodefffe
iso-8859-1
iso-8859-2
iso-8859-3
iso-8859-4
iso-8859-5
iso-8859-6
iso-8859-7
iso-8859-8
iso-8859-9
iso-8859-13
iso-8859-15
windows-874
windows-1250
windows-1251
windows-1252
windows-1253
windows-1254
windows-1255
windows-1256
windows-1257
windows-1258
utf-7
utf-8
utf-32
utf-32be
shift_jis
gb2312
ks_c_5601-1987
big5
iso-2022-jp
iso-2022-kr
euc-jp
euc-kr
macintosh
x-mac-japanese
x-mac-chinesetrad
x-mac-korean
x-mac-arabic
x-mac-hebrew
x-mac-greek
x-mac-cyrillic
x-mac-chinesesimp
x-mac-romanian
x-mac-ukrainian
x-mac-thai
x-mac-ce
x-mac-icelandic
x-mac-turkish
x-mac-croatian
asmo-708
dos-720
dos-862
ibm037
ibm437
ibm500
ibm737
ibm775
ibm850
ibm852
ibm855
ibm857
ibm00858
ibm860
ibm861
ibm863
ibm864
ibm865
cp866
ibm869
ibm870
cp875
koi8-r
koi8-u
Returns a null on failure
bool LoadXml(string xmlFilename)
Loads an email with the contents of an XML email file.
bool LoadXmlString(string xmlStr)
Loads an email from an XML string (previously obtained by calling the GetXml method). The contents of the calling email object are erased and replaced with the email contained within the XML string. Returns 1 for success, 0 for failure.
string QEncodeBytes(VARIANT mbBytes, string charset)
Takes a byte array of multibyte (non-Unicode) data and returns a Unicode Q-Encoded string. Returns a null on failure
string QEncodeString(string str, string charset)
Takes a Unicode string, converts it to the charset specified in the 2nd parameter, Q-Encodes the converted multibyte data, and returns the encoded Unicode string. Returns a null on failure
void RemoveAttachedMessage(int idx)
Removes the Nth message/rfc822 sub-part of the email. Indexing begins at 0.
void RemoveAttachedMessages()
Removes all message/rfc822 sub-parts of the email object.
void RemoveAttachmentPaths()
Removes path information from all attachment filenames.
void RemoveHeaderField(string fieldName)
Removes by name all occurances of a header field.
bool SaveAllAttachments(string directory)
Save all the attachments of an email to a file
bool SaveAttachedFile(int index, string directory)
Save a specific email attachment to a file
bool SaveEml(string filename)
Convert this email object to EML and save it to a file.
bool SaveLastError(string filename)
Saves the last error information to an XML formatted file.
bool SaveRelatedItem(int index, string directory)
Save a related item to a file. Related content items are typically image or style-sheets embedded within an HTML email.
bool SaveXml(string filename)
Convert this email object to XML and save it to a file.
bool SetAttachmentCharset(int index, string charset)
Sets the charset attribute of the content-type header field for a specified attachment. This can be used if the attachment is a text file that contains text in a non us-ascii charset such as Shift_JIS, iso-8859-2, big5, iso-8859-5, etc.
bool SetAttachmentFilename(int index, string filename)
Renames a email attachment's filename. The 1st attachment is at index 0.
void SetCSP(Chilkat.CSP iCsp)
Set the Cryptographic Service Provider (CSP) to be used for encryption or digital signing this email. You do not usually need to call this because the default is usually appropriate. One example of where this might be used is for applications using Smart Cards that need to use the CSP of a Smart Card vendor.
void SetEncryptCert(Chilkat.Cert iCert)
Set the encryption certificate to be used in encryption. Use the CreateCS, CertStore, and Cert classes to create a Cert object by either locating a certificate in a certificate store or loading one from a file.
void SetFromMimeObject(Chilkat.Mime iMime)
Loads and replaces the contents of this email object with the contents of a Mime object
void SetFromMimeText(string mimeText)
Replace the contents of this email object with that found in the MIME text
bool SetFromXmlText(string xmlText)
Loads an email from an XML string.
void SetHtmlBody(string html)
Sets the HTML body of an email.
void SetMbHtmlBody(string charset, VARIANT body)
Sets the HTML email body from a byte array containing character data in the specified character set. This method also updates the email "content-type"header to properly reflect the content type of the body.
void SetMbPlainTextBody(string charset, VARIANT body)
Sets the plain-text email body from a byte array containing character data in the specified character set. This method also updates the email "content-type"header to properly reflect the content type of the body.
bool SetReplacePattern(string pattern, string replaceString)
Create a pattern/replacement-text pair for mail-merge
void SetSigningCert(Chilkat.Cert iCert)
Set the certificate to be used in creating a digital signature. Use the CreateCS, CertStore, and Cert classes to create a Cert object by either locating a certificate in a certificate store or loading one from a file.
bool SetSigningCert2(Chilkat.Cert iCert, Chilkat.PrivateKey iKey)
To be documented soon...
void SetTextBody(string bodyText, string contentType)
To be documented soon...
void UnSpamify()
Unobfuscates emails by undoing what spammers do to obfuscate email. It removes comments from HTML bodies and unobfuscates hyperlinked URLs.
bool UnpackHtml(string unpackDir, string htmlFilename, string partsSubdir)
Unpacks an HTML email into an HTML file and related files (images and style sheets). The links within the HTML are updated to point to the files unpacked and saved to disk. Returns 1 for success, 0 for failure.
bool UnzipAttachments()
Unzips and replaces any Zip file attachments with the expanded contents. As an example, if an email contained a single Zip file containing 3 GIF image files as an attachment, then after calling this method the email would contain 3 GIF file attachments, and the Zip attachment would be gone.If an email contains multiple Zip file attachments, each Zip is expanded and replaced with the contents.
void ZipAttachments(string zipFilename)
Replaces all the attachments of an email with a single Zip file attachment having the filename specified.
|