|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.avalon.framework.logger.AbstractLogEnabled
org.apache.cocoon.mail.MailMessageSender
A helper class used by the Sendmail
and the sendmail.xsl
logicsheet for sending an email message.
smtp-host | SMTP server to use sending mail. | opt | String | localhost |
---|---|---|---|---|
smtp-user | User name for authentication | opt | String | |
smtp-password | Password for authentication | opt | String |
Field Summary |
Fields inherited from interface org.apache.cocoon.mail.MailSender |
ROLE |
Constructor Summary | |
MailMessageSender()
|
|
MailMessageSender(String smtpHost)
Deprecated. Since 2.1.5. Please use MailSender component instead. |
Method Summary | |
void |
addAttachment(Object attachment)
Add an attachement to the message to be send. |
void |
addAttachment(Object attachment,
String type,
String name)
Add an attachement to the message to be send. |
void |
addAttachmentURL(String url)
Add an attachement to the message to be send. |
void |
addAttachmentURL(String url,
String type,
String name)
Add an attachement to the message to be send. |
void |
configure(Configuration config)
|
Exception |
getException()
Accesses any Exception caught by sendIt(org.apache.cocoon.environment.SourceResolver) . |
void |
initialize()
|
void |
send()
Assemble the message from the defined fields and send it. |
void |
send(SourceResolver resolver)
Deprecated. Since 2.1.5. Use send() which doesn't require passing the source resolver |
boolean |
sendIt()
Invokes the send() method but catches any exception thrown. |
boolean |
sendIt(SourceResolver resolver)
Deprecated. Since 2.1.5. Use sendIt() which doesn't require passing the source resolver |
void |
service(ServiceManager manager)
|
void |
setBcc(String bcc)
Sets the address(es), which should receive a black carbon copy of the message. |
void |
setBody(String body)
Sets the body text of the email message. |
void |
setBodyFromSrc(String src)
Sets the body source URL of the email message. |
void |
setBodyFromSrcMimeType(String srcMimeType)
Sets the optional body source Mime Type of the email message. |
void |
setCc(String cc)
Sets the address(es), which should receive a carbon copy of the message. |
void |
setCharset(String charset)
Sets the character set for encoding the message. |
void |
setFrom(String from)
Set the from address of the message. |
void |
setReplyTo(String replyTo)
Sets the reply-to address(es) for the message. |
void |
setSmtpHost(String hostname)
Set SMTP hostname to use for mail sending. |
void |
setSmtpHost(String hostname,
String username,
String password)
Set SMTP hostname, username, and password to use for mail sending. |
void |
setSubject(String subject)
Sets the subject line of the message. |
void |
setTo(String to)
Sets the destination address(es) for the message. |
Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled |
enableLogging, getLogger, setupLogger, setupLogger, setupLogger |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public MailMessageSender()
public MailMessageSender(String smtpHost)
MailSender
component instead.
smtpHost
- The host name or ip-address of a host to accept
the email for delivery.Method Detail |
public void service(ServiceManager manager)
service
in interface Serviceable
public void configure(Configuration config) throws ConfigurationException
configure
in interface Configurable
ConfigurationException
public void initialize()
initialize
in interface Initializable
public void setSmtpHost(String hostname)
MailSender
setSmtpHost
in interface MailSender
public void setSmtpHost(String hostname, String username, String password)
MailSender
setSmtpHost
in interface MailSender
public void send() throws AddressException, MessagingException
send
in interface MailSender
AddressException
- when problems with email addresses are found
MessagingException
- when message could not be send.public void send(SourceResolver resolver) throws AddressException, MessagingException
send()
which doesn't require passing the source resolver
send
in interface MailSender
AddressException
- when problems with email addresses are found
MessagingException
- when message could not be send.public boolean sendIt()
send()
method but catches any exception thrown. This
method is intended to be used from the sendmail logicsheet.
sendIt
in interface MailSender
public boolean sendIt(SourceResolver resolver)
sendIt()
which doesn't require passing the source resolver
send(org.apache.cocoon.environment.SourceResolver)
method but catches any exception thrown. This
method is intended to be used from the sendmail logicsheet.
sendIt
in interface MailSender
public Exception getException()
sendIt(org.apache.cocoon.environment.SourceResolver)
.
getException
in interface MailSender
public void setFrom(String from)
from
address of the message.
setFrom
in interface MailSender
from
- The address the message appears to be from.public void setTo(String to)
InternetAddress.parse(String)
can handle
(one or more email addresses separated by a commas).
setTo
in interface MailSender
to
- the destination address(es)InternetAddress.parse(String)
public void setReplyTo(String replyTo)
InternetAddress.parse(String)
can handle
(one or more email addresses separated by a commas).
setReplyTo
in interface MailSender
replyTo
- the address(es) that replies should be sent toInternetAddress.parse(String)
public void setCc(String cc)
InternetAddress.parse(String)
can handle
(one or more email addresses separated by a commas).
setCc
in interface MailSender
cc
- the address(es), which should receive a carbon copy.InternetAddress.parse(String)
public void setBcc(String bcc)
InternetAddress.parse(String)
can handle
(one or more email addresses separated by a commas).
setBcc
in interface MailSender
bcc
- the address(es), which should receive a black carbon copy.InternetAddress.parse(String)
public void setCharset(String charset)
setCharset
in interface MailSender
charset
- the character set to be used for enbcoding the messagepublic void setSubject(String subject)
setSubject
in interface MailSender
subject
- the subject line of the messagepublic void setBody(String body)
setBody
in interface MailSender
body
- The body text of the email messagepublic void setBodyFromSrc(String src)
setBodyFromSrc
in interface MailSender
src
- The body source URL of the email messagepublic void setBodyFromSrcMimeType(String srcMimeType)
setBodyFromSrcMimeType
in interface MailSender
srcMimeType
- The optional body source Mime Type of the email messagepublic void addAttachment(Object attachment)
org.apache.excalibur.source.Source
or
Part
or its
subclasses.
addAttachment
in interface MailSender
attachment
- to be send with the messageSource
public void addAttachment(Object attachment, String type, String name)
org.apache.excalibur.source.Source
or
Part
or its
subclasses.
addAttachment
in interface MailSender
attachment
- to be send with the messagetype
- mime type (optional)name
- attachment name (optional)Source
public void addAttachmentURL(String url)
org.apache.excalibur.source.Source
or
Part
or its
subclasses.
addAttachmentURL
in interface MailSender
url
- URL to attach to the messageSource
public void addAttachmentURL(String url, String type, String name)
org.apache.excalibur.source.Source
or
Part
or its
subclasses.
addAttachmentURL
in interface MailSender
url
- URL to attach to the messagetype
- mime type (optional)name
- attachment name (optional)Source
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |