Java Doc for JavaMailSender.java in  » J2EE » spring-framework-2.5 » org » springframework » mail » javamail » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » J2EE » spring framework 2.5 » org.springframework.mail.javamail 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.springframework.mail.javamail.JavaMailSender

All known Subclasses:   org.springframework.mail.javamail.JavaMailSenderImpl,
JavaMailSender
public interface JavaMailSender extends MailSender(Code)
Extended org.springframework.mail.MailSender interface for JavaMail, supporting MIME messages both as direct arguments and through preparation callbacks. Typically used in conjunction with the MimeMessageHelper class for convenient creation of JavaMail MimeMessage MimeMessages , including attachments etc.

Clients should talk to the mail sender through this interface if they need mail functionality beyond org.springframework.mail.SimpleMailMessage . The production implementation is JavaMailSenderImpl ; for testing, mocks can be created based on this interface. Clients will typically receive the JavaMailSender reference through dependency injection.

The recommended way of using this interface is the MimeMessagePreparator mechanism, possibly using a MimeMessageHelper for populating the message. See MimeMessageHelper MimeMessageHelper's javadoc for an example.

The entire JavaMail javax.mail.Session management is abstracted by the JavaMailSender. Client code should not deal with a Session in any way, rather leave the entire JavaMail configuration and resource handling to the JavaMailSender implementation. This also increases testability.

A JavaMailSender client is not as easy to test as a plain org.springframework.mail.MailSender client, but still straightforward compared to traditional JavaMail code: Just let JavaMailSender.createMimeMessage() return a plain MimeMessage created with a Session.getInstance(new Properties()) call, and check the passed-in messages in your mock implementations of the various send methods.
author:
   Juergen Hoeller
since:
   07.10.2003
See Also:   javax.mail.internet.MimeMessage
See Also:   javax.mail.Session
See Also:   JavaMailSenderImpl
See Also:   MimeMessagePreparator
See Also:   MimeMessageHelper





Method Summary
 MimeMessagecreateMimeMessage()
     Create a new JavaMail MimeMessage for the underlying JavaMail Session of this sender.
 MimeMessagecreateMimeMessage(InputStream contentStream)
     Create a new JavaMail MimeMessage for the underlying JavaMail Session of this sender, using the given input stream as the message source.
 voidsend(MimeMessage mimeMessage)
     Send the given JavaMail MIME message.
 voidsend(MimeMessage[] mimeMessages)
     Send the given array of JavaMail MIME messages in batch.
 voidsend(MimeMessagePreparator mimeMessagePreparator)
     Send the JavaMail MIME message prepared by the given MimeMessagePreparator.
 voidsend(MimeMessagePreparator[] mimeMessagePreparators)
     Send the JavaMail MIME messages prepared by the given MimeMessagePreparators.



Method Detail
createMimeMessage
MimeMessage createMimeMessage()(Code)
Create a new JavaMail MimeMessage for the underlying JavaMail Session of this sender. Needs to be called to create MimeMessage instances that can be prepared by the client and passed to send(MimeMessage). the new MimeMessage instance
See Also:   JavaMailSender.send(MimeMessage)
See Also:   JavaMailSender.send(MimeMessage[])



createMimeMessage
MimeMessage createMimeMessage(InputStream contentStream) throws MailException(Code)
Create a new JavaMail MimeMessage for the underlying JavaMail Session of this sender, using the given input stream as the message source.
Parameters:
  contentStream - the raw MIME input stream for the message the new MimeMessage instance
throws:
  org.springframework.mail.MailParseException - in case of message creation failure



send
void send(MimeMessage mimeMessage) throws MailException(Code)
Send the given JavaMail MIME message. The message needs to have been created with JavaMailSender.createMimeMessage() .
Parameters:
  mimeMessage - message to send
throws:
  org.springframework.mail.MailAuthenticationException - in case of authentication failure
throws:
  org.springframework.mail.MailSendException - in case of failure when sending the message
See Also:   JavaMailSender.createMimeMessage



send
void send(MimeMessage[] mimeMessages) throws MailException(Code)
Send the given array of JavaMail MIME messages in batch. The messages need to have been created with JavaMailSender.createMimeMessage() .
Parameters:
  mimeMessages - messages to send
throws:
  org.springframework.mail.MailAuthenticationException - in case of authentication failure
throws:
  org.springframework.mail.MailSendException - in case of failure when sending a message
See Also:   JavaMailSender.createMimeMessage



send
void send(MimeMessagePreparator mimeMessagePreparator) throws MailException(Code)
Send the JavaMail MIME message prepared by the given MimeMessagePreparator.

Alternative way to prepare MimeMessage instances, instead of JavaMailSender.createMimeMessage() and JavaMailSender.send(MimeMessage) calls. Takes care of proper exception conversion.
Parameters:
  mimeMessagePreparator - the preparator to use
throws:
  org.springframework.mail.MailPreparationException - in case of failure when preparing the message
throws:
  org.springframework.mail.MailParseException - in case of failure when parsing the message
throws:
  org.springframework.mail.MailAuthenticationException - in case of authentication failure
throws:
  org.springframework.mail.MailSendException - in case of failure when sending the message




send
void send(MimeMessagePreparator[] mimeMessagePreparators) throws MailException(Code)
Send the JavaMail MIME messages prepared by the given MimeMessagePreparators.

Alternative way to prepare MimeMessage instances, instead of JavaMailSender.createMimeMessage() and JavaMailSender.send(MimeMessage[]) calls. Takes care of proper exception conversion.
Parameters:
  mimeMessagePreparators - the preparator to use
throws:
  org.springframework.mail.MailPreparationException - in case of failure when preparing a message
throws:
  org.springframework.mail.MailParseException - in case of failure when parsing a message
throws:
  org.springframework.mail.MailAuthenticationException - in case of authentication failure
throws:
  org.springframework.mail.MailSendException - in case of failure when sending a message




www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.