Interface IEmailManager

All Superinterfaces:

IDisposable, IEntity

public interface IEmailManager
extends IEntity

Contains methods to decode the mime of emails.

Method Summary

Modifier and Type	Method	Description
int	createEmailMime(byte[] mime)	Create an email encoded in MIME format and returns the identifier of the email.
int	createEmailText(String sentFrom, String sendTo, String sendCc, String sendBcc, String subject, BodyType bodyType, String body, Attachment[] attachments)	Create an email with attachments.
void	deleteEmail(int emailId)	Deletes an email.
byte[]	generateMimeFromText(String sendFrom, String sendTo, String sendCc, String sendBcc, String subject, BodyType bodyType, String body, Attachment[] attachments)	Generates the mime of an email from text.
AttachmentData	getAttachment(int emailId, int index)	Gets the specified attachment of an email stored in the instance.
AttachmentData	getAttachmentFromMime(byte[] mime, int index)	Gets the specified certain attachment of an email.
AttachmentData[]	getAttachments(int emailId)	Gets the attachments of an email stored in the instance database.
AttachmentData[]	getAttachmentsFromMime(byte[] mime)	Gets the attachments of an email.
ContentData	getContentFile(int emailId, String contentId)	Gets the specified certain content files of an email stored in the instance.
ContentData	getContentFileFromMime(byte[] mime, String contentId)	Gets the specified content file of an email.
ContentData[]	getContentFiles(int emailId)	Gets the content files of an email stored in the instance database.
ContentData[]	getContentFilesFromMime(byte[] mime)	Gets the content files of an email.
EmailMessage	getEmailMessage(int emailId)	Gets information about an email stored in the instance database.
EmailMessage	getEmailMessageFromMime(byte[] mime)	Gets information about an email.
byte[]	getEmailMime(int emailId)	Gets the email MIME.
IInstance	getInstance()	The instance.
boolean	isValidEmailAddress(String emailAddress)	Checks for the email address is valid.

Methods inherited from interface IDisposable

addDisposedListener, removeDisposedListener

Methods inherited from interface IEntity

getUserContext, setUserContext

Method Details

createEmailMime

int createEmailMime(byte[] mime)
             throws Exception,
altitude.integrationServer.exceptions.ISException

Create an email encoded in MIME format and returns the identifier of the email.

Parameters:

mime - MIME message of the email.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

createEmailText

int createEmailText(String sentFrom,
 String sendTo,
 String sendCc,
 String sendBcc,
 String subject,
 BodyType bodyType,
 String body,
 Attachment[] attachments)
             throws Exception,
altitude.integrationServer.exceptions.ISException

Create an email with attachments.

Parameters:

sentFrom - Email senders.

sendTo - Email receivers.

sendCc - Courtesy copy receivers.

sendBcc - Blind courtesy copy receivers.

subject - Subject of the email.

bodyType - Type of the body of the email.

body - Text body of the email.

attachments - Attachments.

Returns:

The identifier of the email.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

deleteEmail

void deleteEmail(int emailId)
          throws Exception,
altitude.integrationServer.exceptions.ISException

Deletes an email.

Parameters:

emailId - Identifier of the email.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

generateMimeFromText

byte[] generateMimeFromText(String sendFrom,
 String sendTo,
 String sendCc,
 String sendBcc,
 String subject,
 BodyType bodyType,
 String body,
 Attachment[] attachments)
                     throws Exception,
altitude.integrationServer.exceptions.ISException

Generates the mime of an email from text.

Parameters:

sendFrom - Email senders.

sendTo - Email receivers.

sendCc - Courtesy copy receivers.

sendBcc - Blind courtesy copy receivers.

subject - Subject of the email.

bodyType - Type of the body of the email.

body - Text body of the email.

attachments - Attachments.

Returns:

The mime of the email.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getAttachment

AttachmentData getAttachment(int emailId,
 int index)
                      throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the specified attachment of an email stored in the instance.

Parameters:

emailId - Identitifer of the email.

index - Zero-based index of the attachment.

Returns:

The attachment data.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getAttachmentFromMime

AttachmentData getAttachmentFromMime(byte[] mime,
 int index)
                              throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the specified certain attachment of an email.

Parameters:

mime - The MIME of the email.

index - Zero-based index of the attachment.

Returns:

The attachment data.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getAttachments

AttachmentData[] getAttachments(int emailId)
                         throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the attachments of an email stored in the instance database.

Parameters:

emailId - The identifier of the email.

Returns:

An array with the attachments data.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getAttachmentsFromMime

AttachmentData[] getAttachmentsFromMime(byte[] mime)
                                 throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the attachments of an email.

Parameters:

mime - MIME of the email.

Returns:

An array with the attachments data.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getContentFile

ContentData getContentFile(int emailId,
 String contentId)
                    throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the specified certain content files of an email stored in the instance.

Parameters:

emailId - Identitifer of the email.

contentId - Identifier of the content.

Returns:

The content file data.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getContentFileFromMime

ContentData getContentFileFromMime(byte[] mime,
 String contentId)
                            throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the specified content file of an email.

Parameters:

mime - The MIME of the email.

contentId - Identifier of the content.

Returns:

The attachment data.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getContentFiles

ContentData[] getContentFiles(int emailId)
                       throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the content files of an email stored in the instance database.

Parameters:

emailId - The identifier of the email.

Returns:

An array with the attachments data.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getContentFilesFromMime

ContentData[] getContentFilesFromMime(byte[] mime)
                               throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the content files of an email.

Parameters:

mime - MIME of the email.

Returns:

An array with the content files data.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getEmailMessage

EmailMessage getEmailMessage(int emailId)
                      throws Exception,
altitude.integrationServer.exceptions.ISException

Gets information about an email stored in the instance database.

Parameters:

emailId - The identifier of the email.

Returns:

The data of the email.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getEmailMessageFromMime

EmailMessage getEmailMessageFromMime(byte[] mime)
                              throws Exception,
altitude.integrationServer.exceptions.ISException

Gets information about an email.

Parameters:

mime - The MIME of the email.

Returns:

The data of the email.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getEmailMime

byte[] getEmailMime(int emailId)
             throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the email MIME.

Parameters:

emailId - The identifier of the email.

Returns:

The email in MIME format.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getInstance

IInstance getInstance()
               throws Exception,
altitude.integrationServer.exceptions.ISException

The instance.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

isValidEmailAddress

boolean isValidEmailAddress(String emailAddress)
                     throws Exception,
altitude.integrationServer.exceptions.ISException

Checks for the email address is valid.

Parameters:

emailAddress - The email address to check.

Returns:

true if the email address is valid.

Throws:

Exception

altitude.integrationServer.exceptions.ISException